Setup Application Observability
Complete the following steps to setup Application Observability and onboard services:
- Opt-in for Grafana Cloud metrics generation, if it is not already enabled.
- Instrument your application using OpenTelemetry.
- Use the Grafana Agent with the OpenTelemetry (OTLP) integration to send telemetry to Grafana Cloud.
Opt-in for metrics generation
Application Observability requires Grafana Cloud metrics generation. Opt-in for Grafana Cloud metrics generation if it is not already enabled. Note, there is a cost associated with enabling this feature.
Grafana Cloud generates metrics from your environment spans and service dependencies to create the dashboards and service map. The following metrics are generated:
|traces_service_graph_request_total||Counter||client, server, connection_type||The number of requests between two nodes|
|traces_service_graph_request_failed_total||Counter||client, server, connection_type||The number of failed requests between two nodes|
|traces_service_graph_request_server_seconds||Histogram||client, server, connection_type||The request time from the server|
|traces_service_graph_request_client_seconds||Histogram||client, server, connection_type||The request time from the client|
|traces_service_graph_unpaired_spans_total||Counter||client, server, connection_type||The number of unpaired spans|
|traces_service_graph_dropped_spans_total||Counter||client, server, connection_type||The number of dropped spans|
|traces_spanmetrics_latency||Histogram||Dimensions||The span duration|
|traces_spanmetrics_calls_total||Counter||Dimensions||The count for the span|
|traces_spanmetrics_size_total||Counter||Dimensions||The size of spans ingested|
Instrument your application
Instrument your application with the latest OpenTelemetry SDKs to send traces, metrics, and logs to Grafana Cloud. The plugin uses two sources of metrics data, a metrics generator that extracts useful information from traces, and metrics that have been directly sent to the plugin.
To setup OpenTelemetry for Java, see the OpenTelemetry for Java documentation.
Use either the Grafana Agent with the OpenTelemetry integration, or the OpenTelemetry Collector, to send telemetry to Grafana Cloud.
Grafana Agent is the recommended and supported way to send telemetry data, and allows you to monitor both infrastructure and applications. Follow the Grafana Agent documentation to add OpenTelemetry to your Grafana stack.
The OpenTelemetry (OTLP) integration is the recommended way to configure and manage Grafana Agent for an application instrumented with OpenTelemetry. Follow the Grafana Cloud documentation to install an OpenTelemetry integration for Grafana Cloud.
Use the Add service button from any of the plugin screens to onboard an OpenTelemetry-instrumented service with the Grafana Agent and OpenTelemetry (OTLP) integration.
Alternatively, follow the Grafana OpenTelemetry documentation to connect the OpenTelemetry Collector to Grafana Cloud.
While Application Observability is compatible with the upstream OpenTelemetry Collector distributions, Grafana Labs currently only supports the Grafana Agent, our distribution of the Collector.