• Home
  • API
  • Environment
  • Settings
  • Schemas
  • Span attributes

Settings API - Span attributes schema table

Span attributes (builtin:span-attribute)

While Dynatrace automatically captures all OpenTracing and OpenTelemetry span attributes, it only stores span attribute values when the related keys are specified in the allow-list below. By omitting personal data you can meet your organization's privacy requirements and control the amount of stored monitoring data.

Schema IDSchema groupsScope
builtin:span-attribute
  • group:service-monitoring
  • group:service-monitoring.spans
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-attribute
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-attribute
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-attribute

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

PropertyLabelTypeDescriptionRequired
keyKeytext

Key of the span attribute to store

required
maskingMaskingenum

If this attribute contains confidential data, turn on masking to conceal its value from users

Introduce more granular control over the visibility of attribute values.
Choose Do not mask to allow every user to see the actual value and use it in defining other configurations.
Choose Mask entire value to hide the whole value of this attribute from everyone who does not have 'View sensitive request data' permission. These attributes can't be used to define other configurations. Choose Mask only confidential data to apply automatic masking strategies to your data. These strategies include, for example, credit card numbers, IBAN, IPs, email-addresses, etc. It may not be possible to recognize all sensitive data so please always make sure to verify that sensitive data is actually masked. If sensitive data is not recognized, please use Mask entire value instead. Users with 'View sensitive request data' permission will be able to see the entire value, others only the non-sensitive parts. These attributes can't be used to define other configurations.

required