Skip to main content

APM onboarding

Coralogix Application Performance Monitoring (APM) gives you a live catalog of your services and databases, RED metrics (requests, errors, duration), a service map, and distributed traces - with no separate APM agent to run. This guide takes you from nothing to services reporting in APM - most teams in about 15 minutes - then points you to the optional tuning that makes the data production-ready.

Compact Span Metrics required

APM v2 reads compact Span Metrics for both services and databases - standard Span Metrics aren't enough. The first time you open APM v2, a welcome check lists these requirements with their status (Sending or Missing); when all pass, select Go to new APM to start. If any are missing, the check links to the migration guide and a way back to legacy APM. Enable compact Span Metrics first: Using compact Span Metrics.

Ready to get started?

The fastest path is Kubernetes with the Coralogix Helm chart and eBPF auto-instrumentation. Start with Step 1: Deploy the OpenTelemetry Collector.

How APM works​

APM is built on OpenTelemetry: your instrumented services emit spans, the OpenTelemetry Collector forwards them to Coralogix, and Coralogix derives the Span Metrics that power APM.

Three things produce everything you see:

  • Deploy the OpenTelemetry Collector to receive telemetry from your services and forward it to Coralogix.
  • Instrument your services so they emit spans (traces).
  • Coralogix derives Span Metrics from those spans - the RED metrics that power the catalog, health, and charts.

You set up the first two; Coralogix handles the third. To customize what Span Metrics generates, see Span Metrics.

What you need​

  • A Coralogix account, with your Send-Your-Data API key and your region's OpenTelemetry endpoint.
  • A running service you want to monitor.
  • For Kubernetes: a cluster that meets the Helm chart prerequisites (minimum Kubernetes and Helm versions, secrets).
  • Compact Span Metrics on both services and databases - required for APM v2 (see the note above). Enable it with Using compact Span Metrics.

Step 1: Deploy the OpenTelemetry Collector​

The Collector receives spans from your services and forwards them to Coralogix. Span Metrics is enabled by default in the latest Coralogix distributions, so APM works as soon as spans arrive. Choose your platform:

Recommended. Use the Coralogix Kubernetes Complete Observability integration:

  1. Download the values.yaml.

  2. Meet the prerequisites (minimum Kubernetes and Helm versions, secrets).

  3. Confirm the spanMetrics preset is enabled (it is by default):

    spanMetrics:
    enabled: true
  4. Install with the Helm commands.

Span Metrics is on by default. To customize the metrics, dimensions, and histogram buckets it generates, see Recommended configurations.

Step 2: Instrument your services​

Your services need to emit spans. Choose an approach:

Auto-instrument without code changes using eBPF auto-instrumentation. This is the fastest path on Kubernetes.

Step 3: Verify data is flowing​

Generate some traffic to your service, then, within a few minutes:

  1. In the Coralogix toolbar, select APM.
  2. Confirm your service appears in the catalog, and open it to see its RED metrics.
  3. Open the Traces section to see recent spans.

Your services reporting in the APM v2 catalog, with RED metrics and health.

If a service, database, or metric is missing, see APM v2 isn't showing my data.

Optional: tune and extend​

Once data is flowing, harden and enrich it:

  • Sampling: the Helm chart uses head sampling by default. For error- and latency-aware sampling, move to tail sampling - Kubernetes or Docker Compose.
  • Correlate logs: with OpenTelemetry, Coralogix correlates logs to a service automatically when the logs carry standard trace and span IDs (trace_id / span_id) and service context (such as a subsystem name that matches the service). Correlated logs then appear on the entity's Logs section. If your logs don't carry those fields, set up log correlation.
  • Correlate infrastructure: send infrastructure telemetry so the Infrastructure section links a service to the hosts, pods, and containers it runs on. The Coralogix Helm chart labels spans and metrics consistently, which is what lets Coralogix match them.
  • Serverless (AWS Lambda): auto-instrument AWS Lambda with the OpenTelemetry Lambda auto-instrumentation.
  • Align attribute names: when you upgrade OpenTelemetry versions, use the transform processor to keep attribute names stable - see Aligning Coralogix and OpenTelemetry naming conventions.

Configure Span Metrics​

Coralogix derives Span Metrics from your spans. To customize what it generates and keep cardinality in check, see:

Next steps​

Once your services are sending spans, learn how Coralogix turns them into long-term metrics in the Span Metrics overview.

Additional resources​

Last updated on