Export telemetry to your observability backend
Add an OTLP destination that receives your tenant's own traces and metrics, in Datadog, Dynatrace, Instana or any OTLP-compatible backend.
Who can do it
A tenant administrator, or a platform super administrator working inside your tenant. The console enables Add destination and the row controls only for a person who holds the permission to manage the tenant's observability destinations.
Before you start
- Per-tenant observability export exists on SaaS deployments only. On any other deployment the panel says so and offers nothing to configure.
- Your tenant's edition includes observability export. Until you add a destination, your telemetry keeps reaching the deployment's own backends.
- Have the backend's OTLP endpoint (an
httpsURL on a public address) and its API key ready. - A tenant holds at most five destinations.
Steps
- Open Settings and select the Integrations tab.
- On the Observability export row, select Manage.
- Select Add destination. In the dialog:
- Name: unique among your tenant's destinations.
- Vendor: the backend family. It sets the shape of the endpoint and headers.
- OTLP endpoint: the backend's
httpsURL. - API key: write-only; it is sealed and never shown again.
- Signals to export: traces, metrics, or both. At least one is required.
- Send telemetry to this destination: leave it on to start exporting at once.
- Select Save.
To replace the key later, select Rotate key on the row, enter the new key and select Rotate key in the dialog. Use Edit, Disable or Delete for the other changes.
What you see when it worked
The console confirms that the destination was created and lists it in the panel with its vendor, endpoint and signals. The key is shown only as masked. Your tenant's telemetry, and only your tenant's, is exported to it.
If it fails
| What you see | Cause | What to do |
|---|---|---|
| "Select at least one signal and provide a valid https endpoint." | No signal is selected, or the endpoint is not an https URL | Correct the form |
| The endpoint is refused as not a permitted target | It resolves to a private, loopback or cloud metadata address | Use the backend's public endpoint |
| Add destination is unavailable: "The maximum number of destinations for this tenant has been reached." | The tenant already has five destinations | Delete one you no longer use |
| The name is refused as already in use | Another destination of your tenant has that name | Choose another name |
| The row says observability export is included in a higher edition | Your edition does not include it | Contact your account manager |
| Saving fails because secret custody is unavailable | The platform could not seal the key | Retry later; nothing was saved, and on a rotation the old key is kept |
A person working inside your tenant through support access cannot change your observability destinations.
Without the console
| Surface | How |
|---|---|
| API | POST /api/v3/admin/tenants/{tenantId}/observability-backends (operation createObservabilityBackend) |
| API | PUT /api/v3/admin/tenants/{tenantId}/observability-backends/{name} (operation replaceObservabilityBackend) |
| API | PATCH /api/v3/admin/tenants/{tenantId}/observability-backends/{name}/credential (operation updateObservabilityBackendCredential) |
| API | DELETE /api/v3/admin/tenants/{tenantId}/observability-backends/{name} (operation deleteObservabilityBackend) |
Related
- Tenant Settings: what the screen shows and every decision you make on it.