Edit

Metrics Exporters

Metrics exporters are responsible for passing the recorded metrics to a metric storage. They can implement a push approach where metrics are sent to a collector or a pull approach where metrics are scraped by an external system.

If an exporter supports runtime updates it means that it can be enabled/disabled during the run-time or that any property related to the exporter can be changed. This way you can, for example, change the endpoint where exporter pushes the metrics without a need to restart the application. In order to use run-time updates, you must enable one of the externalized configuration methods that support dynamic updates.

inspectIT Ocelot currently supports the following metrics exporters:

Exporter	Supports run-time updates	Push / Pull	Enabled by default
Logging Exporter (Metrics) [Homepage]	Yes	Push	No
Prometheus Exporter	Yes	Pull	No
OTLP Exporter (Metrics) [Homepage]	Yes	Push	No

Important note: Starting with version 3.0.0 the InfluxDB Exporter is no longer supported. Check out the migration guide in breaking changes.

Logging Exporter (Metrics)

The Logging exporter exports the metrics to the system log. By default, the exporter is disabled. The following properties are nested properties below the inspectit.exporters.metrics.logging:

Property	Default	Description
.enabled	DISABLED	If ENABLED or IF_CONFIGURED, the inspectIT Ocelot agent will try to start the Logging metrics exporter.
.export-interval	refers to inspectit.metrics.frequency	The export interval of the metrics.

Prometheus Exporter

Prometheus exporter exposes the metrics in Prometheus format and is the default metrics exporter set up by inspectIT Ocelot. When enabled, inspectIT starts a Prometheus HTTP server in parallel with your application. The server is by default started on the port 8888 and metrics can then be accessed by visiting http://localhost:8888/metrics.

The following properties are nested properties below the inspectit.exporters.metrics.prometheus property:

Property	Default	Description
.enabled	DISABLED	If ENABLED or IF_CONFIGURED, the inspectIT Ocelot agent will try to start the Prometheus metrics exporter and Prometheus HTTP server.
.host	0.0.0.0	The hostname or network address to which the Prometheus HTTP server should bind.
.port	8888	The port the Prometheus HTTP server should use.

Don't forget to check the official OpenTelemetry Prometheus exporter documentation.

OTLP Exporter (Metrics)

The OpenTelemetry Protocol (OTLP) exporters export the metrics to the desired endpoint at a specified interval. To enable the OTLP exporters, it is only required to specify the endpoint.

The following properties are nested properties below the inspectit.exporters.metrics.otlp-grpc property:

Property	Default	Description
.enabled	IF_CONFIGURED	If ENABLED or IF_CONFIGURED, the inspectIT Ocelot agent will try to start the OTLP gRPC metrics exporter.
.endpoint	null	Target to which the exporter is going to send metrics, e.g. http://localhost:4317
.protocol	null	The transport protocol, see OTel documentation. Supported protocols are grpc and http/protobuf.
.export-interval	refers to inspectit.metrics.frequency	Defines how often metrics are pushed to the endpoint.
.headers	null	Key-value pairs to be used as headers associated with gRPC or HTTP requests, see OTel documentation.
.compression	NONE	The compression method, see OTel documentation. Supported compression methods are gzip and none.
.timeout	10s	Maximum time the OTLP exporter will wait for each batch export, see OTel documentation.

To make inspectIT Ocelot push the metrics via OTLP to, e.g. an OpenTelemetry Collector running on the same machine as the agent, the following JVM property can be used:

-Dinspectit.exporters.metrics.otlp.endpoint=http://127.0.0.1:4317
-Dinspectit.exporters.metrics.otlp.protocol=grpc