Consumers

The Consumers menu provides a view of all consumer groups for all topics in a cluster. From the consumer pages, you can:

Tip

Consumer Lag for an individual topic can be accessed from the Topics menu.

Important

The Consumers feature is enabled by default using an Access Control setting in the Control Center properties files. See Enabling and disabling the Consumers feature. If RBAC is enabled for Control Center, the resources you can access are determined by your assigned role or roles and their corresponding privileges.

All consumer groups page

Use the All consumer groups page to:

  • View all consumer groups for a cluster
  • Search for a consumer group by its ID
  • View the number of consumers and number of source topics for each consumer group
  • View details such as Consumer Lag and Consumption metrics for a consumer group
  • Set up a pre-populated alert for Consumer Lag

To access the All consumer groups page:

  1. Select a cluster from the navigation bar.

  2. Click the Consumers menu. The All consumer groups page appears.

    ../_images/c3-all-consumer-groups.png

View consumer lag details for a consumer group

  1. From the All consumer groups page, click the ellipsis (...) and choose View Details from the context menu.

    ../_images/c3-cg-view-details-menu.png

    The consumer lag details are displayed, including:

    • Total messages behind and the measured interval.

    • All consumers in a consumer group.

    • A visualization of lag.

      ../_images/c3-cg-consumer-lag.png
  2. To view details for a particular point on the graph, click the pin. View the Consumer, Partition, Current offset, and Messages behind for that particular point.

    ../_images/c3-cg-point-details.png

View consumption details for a consumer group

View the percentage (%) of messages consumed and the end-to-end latency key metrics by a selected timeline.

Note

The consumption charts are only populated if there are Confluent Monitoring Interceptors that are set up correctly. For instructions, see Confluent Monitoring Interceptors.

  1. From the All consumer groups page, click the ellipsis (...) and choose View Details from the context menu.

  2. Click the Consumption tab. The streams monitoring metrics are displayed for the default timeframe (Last 4 hours).

    ../_images/c3-consumption-timeframe.png
  3. Select a timeframe from the menu.

    ../_images/c3-timeframe-selector.png

    Time selector

    Use the time range selector to select the time range for data displayed in charts:

    • Static: A specific time range with constant start and end times.
    • Rolling: A time range where the end time is always equal to the current time and the extent of the time range is held constant.
    • Growing: A time range where the end time is always equal to the current time and the start time is held constant.

    The default selection is Last 4 hours.

  4. Select the latency metric you want to view:

    • average (ms)
    • minimum (ms)
    • maximum (ms)
    • total (ms)
    ../_images/c3-cg-latency-temp.png

    Tip

    You can set up alerts for average and maximum latency values.

Set up an alert for a consumer group

You can set up an alert from the menu or button available in the Consumers pages. These options pre-populate most of the consumer group trigger fields for your convenience.

  • On the Consumer lag page, click Set an alert.

    ../_images/c3-cg-setup-alert-menu.png
  • On the Consumer lag page, click Set an alert.

    ../_images/c3-cg-consumer-lag-alert-button.png

For more details, see Consumer lag trigger.

Enabling and disabling the Consumers feature

The Consumers feature for viewing details for consumer lag and consumption in consumer groups is enabled by default. The feature can be disabled by setting the confluent.controlcenter.consumers.view.enable option in the Control Center properties file to false. After disabling the feature, the Consumer submenu in the Cluster navigation is no longer visible in the Control Center UI.

Important

If RBAC is enabled for Control Center, it takes precedence over Access Control settings.

To disable the Consumers feature in Control Center:

  1. Set the confluent.controlcenter.consumers.view.enable option in your control-center.properties file to false.

    ...
    confluent.controlcenter.consumers.view.enable=false
    ...
    

    Note

    Make the change in the appropriate Control Center properties files configured for your environments, including control-center-dev.properties or control-center-production.properties. The properties files are located in /path-to-confluent/etc/confluent-control-center/.

  2. Restart Control Center and pass in the properties file for the configuration to take effect.

    • Local (dev) environment:

      Important

      Do not use confluent local for production use.

      confluent local stop --path <path-to-confluent>
      confluent local start --path <path-to-confluent> ../etc/confluent-control-center/control-center.properties
      
    • Production environment:

      ./bin/control-center-stop
      ./bin/control-center-start ../etc/confluent-control-center/control-center.properties
      

To enable the feature again, set the option back to true and restart Control Center with the updated properties file.