Monitoring the adapter

Prerequisite: See Gateway Application metrics for a generic overview on support of metrics in a Gateway Application

The adapter supports exposing metrics which can be used to monitor the adapter. This is disabled by default and may be enabled in the configuration file under the global section as follows:

"global": {
    "framework": {
        "metrics": {
            "enabled": true
        }
    }
}

The metrics for the adapter are exposed as:

  1. JMX

  2. Prometheus metrics

The adapter exposes the following types of metrics:

  1. JVM and system metrics

  2. Metrics exposed by the Gateway Framework

  3. Remote server specific metrics

Remote server specific metrics

Below is the list of metrics exposed by the application that is related to the remote server.

Meter name Description Type

adapter.remote.diffusion.session.connected

Specifies if the remote Diffusion session is connected. Value is set to 1.0 if connected, and 0.0 if disconnected.

Gauge

adapter.remote.diffusion.session.reconnection.attempts

The number of remote Diffusion session reconnection attempts. Resets to 0.0 once the session is reconnected.

Gauge

adapter.remote.diffusion.recreation.attempts

The number of attempts to recreate a remote Diffusion server session. Resets to 0.0 once the connection is established.

Gauge

adapter.remote.publish.request.total

Total number of requests to publish to a specific topic in the remote server by a STREAM_TO_REMOTE service.

Counter

adapter.remote.publish.request.success.total

Total of successful requests to publish to a specific topic in the remote server by a STREAM_TO_REMOTE service.

Counter

adapter.remote.publish.request.failed.total

Total of failed requests to publish to a specific topic in the remote server by a STREAM_TO_REMOTE service.

Counter

adapter.remote.publish.request.duration

Total time taken to publish to a specific topic in the remote server by a STREAM_TO_REMOTE service.

Timer

adapter.remote.topic.updates.total

Total number of updates from a topic in the remote server sent to STREAM_FROM_REMOTE service.

Counter

adapter.remote.topic.subscription

Specifies if the topic in the remote server is subscribed to.

Gauge