Help Center/ Application Operations Management/ User Guide (2.0)/ Prometheus Monitoring/ Access Guide/ Exporter Access in the VM Scenario/ Kafka Component Access
Updated on 2024-10-30 GMT+08:00
View PDF
Share

Kafka Component Access

Application Scenario

Create collection tasks using the built-in Kafka plug-in. After installing this plug-in, you can monitor Kafka metrics.

Prerequisites

Procedure

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane on the left, choose Access Center. Then click the Kafka card on the Prometheus Middleware panel.
  3. On the displayed page, set parameters by referring to the following table and click Next.

    Figure 1 Configuring a collection task
    Table 1 Parameters for creating a collection task

    Operation

    Parameter

    Description

    Select Instance

    Prometheus Instance

    Select a Prometheus instance for ECS to store collected data.

    A collection task is associated with the Prometheus instance to mark and classify collected data. If no Prometheus instance is available, create one.

    Set Plug-in

    OS

    Operating system of the host. Only Linux is supported.

    Collection Plug-in

    The default value is KAFKA.

    Plug-in Version
    Select a plug-in version.
    NOTE:

    Plug-in versions that have not been released are dimmed and cannot be selected.

    Set Collection Task

    Collection Task Name

    Name of a collection task. Enter 1 to 50 characters and start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

    Host

    Click Add Host and select a running host for configuring the collection task and installing Exporter.

    Specify host: Select a host that has been connected.

    • On the Specify host page, search for and select a host by the host name, IP address, or Agent status.
    • On the Specify host page, click in the upper right corner to deselect the host if needed.
    • Ensure that the UniAgent of the selected host is running. Otherwise, no data can be collected.
      NOTE:

      If you select a middleware plug-in, only one host can be selected.

    Metric Dimension

    When Collection Plug-in is set to a middleware plug-in, the default metrics of the plug-in are displayed.

    Click . In the displayed dialog box, select Built-in or Custom to add a metric dimension.
    • Metric dimension name:
      • Built-in metric dimensions: _app, _comp, and _env are available, which are used to identify applications, components, and environments, respectively.
      • Custom metric dimension: Enter a metric dimension name. Each name can contain 1 to 64 characters. Only letters, digits, and underscores (_) are allowed. Each name must start with a letter or underscore.

      For a host, each metric dimension name must be unique.

    • Metric dimension value: Enter the value of a metric dimension. This value can be duplicate but cannot be empty.

      Each value can contain 1 to 128 characters. The following characters are not allowed: &|><$;'!-()

    Up to 10 dimensions can be added. For example, if the dimension name is label1 and the dimension value is label2, label1:"label2" will be displayed.

    Advanced Settings

    Includes Collection Period (s) and Timeout Period (s).

    • Collection Period (s): O&M data collection period, in seconds. Options: 10s, 30s, and 60s (default).
    • Timeout Period (s): the maximum time allowed for executing a collection task, in seconds. Options: 10s, 30s, and 60s (default).
      NOTE:

      The timeout period cannot exceed the collection period.

    • Executor: user who executes the collection task, that is, the user of the selected host. The default value is root. Currently, only the root user is supported.

  4. Set Exporter installation parameters and click Install. Click View Log to view Exporter installation logs if the installation fails.

    Exporter collects monitoring data and regulates the data provided for external systems through Prometheus monitoring.
    Figure 2 Installing Exporter

    Parameter

    Description

    Kafka address

    IP address and port number of Kafka, for example, 10.0.0.1:3306.

    SASL enabled

    Enter enabled or disabled. By default, SASL is disabled.

    • enabled: Enable SASL.
    • disabled: Disable SASL.

    SASL username

    SASL username.

    SASL password

    SASL password.

    SASL mechanism

    Enter an SASL mechanism. Options: plain, scram-sha512, and scram-sha256. By default, this parameter is left blank.

    TLS enabled

    Enter enabled or disabled. By default, TLS is disabled.

    • enabled: Enable TLS.
    • disabled: Disable TLS.

  5. Click Create to connect the Kafka plug-in. The connected plug-in will be displayed on the collection task page. Click the name of a collection task. On the displayed page, you can check the configuration of the collection task.