Chapter 6. Administer Micrometer in JBoss EAP


6.1. Adding Micrometer subsystem using the Management CLI

The Micrometer subsystem enhances monitoring capabilities in JBoss EAP by facilitating comprehensive metrics gathering and publication. However, the org.jboss.extension.micrometer subsystem is available to all standalone configurations within the JBoss EAP distribution, but it must be added manually.

Prerequisites

  • JBoss EAP 8.0 with JBoss EAP XP 5.0 is installed.
  • You have access to the JBoss EAP management CLI and permissions to make configuration changes.

Procedure

  1. Open your terminal.
  2. Connect to the server by running the following command:

    ./jboss-cli.sh --connect
  3. Check if the Micrometer extension is already added to the configuration by running the following command:

    [standalone@localhost:9990 /] /extension=org.wildfly.extension.micrometer:read-resource
  4. If the Micrometer extension is not available, add it by running the following command:

    [standalone@localhost:9990 /] /extension=org.wildfly.extension.micrometer:add
  5. Add the Micrometer subsystem with the required configuration. For example, specify the endpoint URL of the metrics collector by running the following command:

    [standalone@localhost:9990 /] /subsystem=micrometer:add(endpoint="http://localhost:4318/v1/metrics")
  6. Reload the server to apply the changes:

    [standalone@localhost:9990 /] reload
Note

When the collector is not running or its collector endpoint is unavailable, then a warning message similar to the following is triggered:

11:28:16,581 WARNING [io.micrometer.registry.otlp.OtlpMeterRegistry] (MSC service thread 1-5) Failed to publish metrics to OTLP receiver: java.net.ConnectException: Connection refused

By following these steps, you can add the Micrometer subsystem to your JBoss EAP server using the management CLI, enabling enhanced monitoring capabilities for your applications.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.