Settings API - OpenTelemetry metrics schema table
OpenTelemetry metrics (builtin:opentelemetry-metrics)
Configure how OpenTelemetry metrics are ingested into Dynatrace via the OTLP endpoint.
Notes:
-
Changes made to these settings only apply to newly ingested data points. Data points that are already stored in Dynatrace will not change.
-
For OpenTelemetry trace/span settings, navigate to: Settings > Server-side service monitoring.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:opentelemetry-metrics |
| environment environment-default |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:opentelemetry-metrics |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:opentelemetry-metrics | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:opentelemetry-metrics |
Authentication
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Property | Type | Description | Required |
---|---|---|---|
Add Meter name and version as metric dimensionsmeterNameToDimensionEnabled | boolean | When enabled, the Meter name (also referred to as InstrumentationScope or InstrumentationLibrary in OpenTelemetry SDKs) and version will be added as dimensions ( Note: Modifying this setting will cause the metric to change. This may have an impact on existing dashboards, events and alerts that make use of these dimensions. In this case, they will need to be updated manually. | required |
Add the resource and scope attributes configured below as dimensionsadditionalAttributesToDimensionEnabled | boolean | - | required |
additionalAttributes | Set<AdditionalAttributeItem> | When enabled, the attributes defined in the list below will be added as dimensions to ingested OTLP metrics if they are present in the OpenTelemetry resource or in the instrumentation scope. Notes:
| required |
toDropAttributes | Set<DropAttributeItem> | The attributes defined in the list below will be dropped from all ingested OTLP metrics. Upon ingest, the Allow list: resource and scope attributes above is applied first. Then, the Deny list: all attributes below is applied. The deny list therefore applies to all attributes from all sources (data points, scope and resource). Notes:
| required |
The AdditionalAttributeItem
object
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | When enabled, the attribute will be added as a dimension to ingested metrics if present in the OpenTelemetry resource or in the instrumentation scope. | required |
Attribute keyattributeKey | text | - | required |
The DropAttributeItem
object
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | When enabled, the attribute will be dropped on all ingested metrics. | required |
Attribute keyattributeKey | text | - | required |