Updated on 2025-07-01 GMT+08:00

Ingesting Kafka Metrics to AOM

Install the Kafka Exporter provided by AOM, and then create a collection task by setting a metric ingestion rule to monitor Kafka metrics on a host.

Prerequisites

  • To use the new Kafka Exporter ingestion function, switch to the new access center.

Connecting Kafka Exporter to AOM

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane, choose Access Center > Access Center, filter the Kafka card under Self-built middleware, and click Ingest Metric (AOM).
  3. On the displayed page, set parameters.

    1. Set the Prometheus instance.
      1. Instance Type: Select a Prometheus instance type. Options: Prometheus for ECS and Common Prometheus instance.
      2. Instance Name: Select a Prometheus instance from the drop-down list and click Next.

        You can click View Instance to go to the details page of the selected instance. If no Prometheus instance is available, click Create Instance to create a Prometheus instance for ECS or a common Prometheus instance.

    2. Install the plug-in and test the connectivity.
      1. Set parameters to install the plug-in by referring to the following table.
        Table 1 Parameters

        Operation

        Parameter

        Description

        Basic Settings

        Ingestion Rule Name

        Name of a custom metric ingestion rule. Enter 1 to 50 characters starting with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        Set Collection Plug-in

        OS

        Operating system of the host. Only Linux is supported.

        Collection Plug-in

        The default value is Kafka Exporter. Select a plug-in version.

        Select Server to Install Plug-in

        Select Server

        Click Select Server to select a running server to configure a collection task and install Exporter.

        • On the Select Server page, search for servers by server ID, name, status, or IP address.
        • Ensure that the UniAgent of the selected server is running. Otherwise, no data can be collected.
        • If no server meets your requirements, UniAgent may be not installed. In that case, install UniAgent. In addition, ensure that the UniAgent version is 1.1.3 or later. Upgrade UniAgent when necessary.

        Connect Kafka Instance

        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.
      2. Click Install & Test Collection Plug-in to deliver the Exporter installation task.
        • After the plug-in is installed, click Next.
        • Click View Log to view Exporter installation logs if the installation fails.
    3. Set an ingestion rule.
      Set a metric ingestion rule by referring to the following table.
      Table 2 Parameters

      Operation

      Parameter

      Description

      Metric Collection Rule

      Metric Collection Interval (s)

      Interval for collecting metrics, in seconds. Options: 10, 30, and 60 (default).

      Metric Collection Timeout (s)

      Timeout period for executing a metric collection task, in seconds. Options: 10, 30, and 60 (default).

      The timeout period cannot exceed the collection interval.

      Executor

      User who executes the metric ingestion rule, that is, the user of the selected server. By default, the executor is root.

      Other

      Custom Dimensions

      Dimensions (key-value pairs) added to specify additional metric attributes. You can click Add Dimension to add multiple custom dimensions (key-value pairs).
      • Key: key of the additional attribute of a metric. Only letters, digits, and underscores (_) are allowed. Each name must start with a letter or underscore. Each key must be unique.
      • Value: corresponds to the key of the additional attribute of a metric. The following characters are not allowed: &|><$;'!-()

      Up to 10 dimensions can be added. Example: Set the key to app and value to abc.

      After the metric collection rule parameters are configured, you can click YAML to view the configuration data in YAML format.

  4. Click Next to connect Kafka Exporter.

    After Kafka Exporter is connected, perform the following operations if needed: