Platform Insights Add-On

Ask about this Page

Copy for LLM

View as Markdown

Platform Insights gives you a clear view of how commercetools processes your project's requests. It exposes server-side metrics and per-request logs, and delivers them directly into the Application Performance Monitoring (APM) tool your team already uses. Built on the OpenTelemetry (OTel) standard, it ensures compatibility with industry-standard observability tools.

Without Platform Insights, you can measure round-trip time from your own servers, but that includes network latency and middleware overhead. You cannot isolate internal processing time within commercetools, trace errors back to specific API calls using correlation IDs, or see server-side detail like GraphQL query complexity. Platform Insights addresses this specific blind spot.

What you get

API Performance Metrics

Five OpenTelemetry metrics across all commercetools API activity:

Metric	What it measures
`ct_time_sec`	Internal processing time
`ct_response_count`	Total API responses by status code
`ct_error_count`	4xx and 5xx error tracking
`ct_sent_bytes`	Outbound data volume
`ct_received_bytes`	Inbound data volume

You can filter metrics by HTTP status, endpoint, method, and project key, and add custom tags for environment, team, or deployment version.

API Access Logs

Per-request log records with correlation ID, endpoint, client, status, duration, and bytes plus GraphQL operation type, query complexity, and deprecated field usage. Logs let you trace individual requests through the platform and pinpoint the exact call that caused an issue.

Multi-provider support

Send data to one or more providers simultaneously. This is useful during APM migrations, allowing you to run both providers in parallel and ensure no data loss during the transition.

Supported providers

Platform Insights is vendor-agnostic. Supported provider types:

Provider
New Relic
Datadog
Dynatrace
Any OTel-compatible backend

The OTLP option covers tools like Grafana, Prometheus, Honeycomb, and any other backend that accepts OpenTelemetry data.

When Platform Insights helps

Isolating latency: Determine whether a slowdown is in your middleware and network or within commercetools processing (ct_time_sec).
Root cause analysis: Use correlation IDs to trace errors (4xx/5xx) back to specific API calls and endpoints.
Capacity planning: Track traffic growth trends and per-endpoint performance to prepare for peak events.
GraphQL debugging: Gain visibility into query complexity and deprecated field usage across your GraphQL operations.
Faster support escalations: Open tickets with the exact endpoint, time window, and error pattern, so commercetools support starts investigation with the context they need.

Configuration API

Platform Insights is fully configurable via the Configuration API. You can activate providers, set event types (Metrics, Logs, or both), manage custom attributes, and update configurations without re-sending API keys or full configs. Infrastructure-as-Code teams can automate setup alongside the rest of their commercetools project settings.

Get access to Platform Insights

To get access to Platform Insights, contact your Customer Success Manager. Your CSM will walk you through enablement.

Documentation

Find the technical details, API reference, and integration guides in the Platform Insights documentation.

Defined scope

The following list links to the documentation pages representing the Platform Insights Add-On:

HTTP API
- API fundamentals
  - Performance
    - Platform Insights

Platform Insights Add-On

What you get.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

API Performance Metrics.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

API Access Logs.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Multi-provider support.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Supported providers.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

When Platform Insights helps.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Configuration API.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Get access to Platform Insights.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Documentation.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Defined scope.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}