The following reference contains a list of global fields that have a well defined semantic meaning in Dynatrace and can be used across different monitoring types. The fields are organized in namespaces that are separated with dots.
The top level fields contain generally relevant information for all monitoring data
| Attribute | Type | Description | Examples |
|---|---|---|---|
| timestamp | stableThe time (UNIX Epoch time in nanoseconds) when the event originated, typically when the source created it. If no original timestamp is available, it will be populated at ingest time and required for all events. In the case of a correlated event (for example, ITIL events), this time could be different from the event.start time, as this time represents the actual timestamp when the "update" for the event was created. |
|
| record[] | stableThe timeframe represented by a timeseries record. | |
| timestamp | stableStart time of a data point. Value is a UNIX Epoch time in nanoseconds and less or equal to the |
|
| timestamp | stableEnd time of a data point. Value is a UNIX Epoch time in nanoseconds and greater or equal to the |
|
| duration | stableThe difference of |
|
| string | stableDenotes the timeframe of represented by individual timeseries measurements returned by a timeseries record. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalAdobe Experience Manager (AEM) environment type. |
|
| string | resource experimentalAdobe Experience Manager (AEM) service. Contains the customer defined name of the AEM environment. | |
| string | resource experimentalAdobe Experience Manager (AEM) service. Contains the program and environment IDs the customer is exposed to. | |
| string | resource experimentalAdobe Experience Manager (AEM) tier. |
|
OneAgent might aggregate spans that have the same parent span into a single span. The aggregated span contains attributes to indicate the aggregation and to allow reconstructing details.
For aggregated spans the start_time holds the earliest start_time, end_time holds the latest end_time of all aggregated spans.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | stableThe number of spans aggregated into this span. Because this span represents multiple spans, the value is >1. |
|
| duration | stableThe duration in nanoseconds for the longest aggregated span. |
|
| duration | stableThe duration in nanoseconds for the shortest aggregated span. |
|
| duration[] | stableArray of reservoir sampled span durations of the aggregated spans. The duration samples can be used to estimate a more accurate duration distribution of aggregated spans rather than the average value. |
|
| duration | stableThe duration sum in nanoseconds for all aggregated spans. |
|
| long | stableThe number of aggregated spans that included an exception. |
|
| boolean | stable |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe server's base directory. This is what usually is referred to as CATALINA_BASE. |
|
| string | resource experimentalThe server's home directory. This is what usually is referred to as CATALINA_HOME. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimentalThe name of the Apache HTTP Server module that generated the log entry. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
The app namespace contains information on the application sending the event.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe name of the bundle, for example the bundle identifier on iOS or the |
|
| string | resource stableAn optional unique application identifier. Chosen by the customer |
|
| string | resource stableThe application's publicly visible version number, as for example displayed in App Store or Google Play. Usually this is just the major and minor version with no patch number. |
|
| string | resource stableThe application's internal build number, which may include information such as patch number and build number. |
|
The artifact namespace contains information about software artifacts.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe provenance filename of the built attestation. It directly relates to the |
|
| string | experimentalThe full hash value of the built attestation. |
|
| string | experimentalThe ID of the build software attestation. |
|
| string | experimentalThe filename of the software artifact, typically generated by the build process. This is similar to the |
|
| string | experimentalThe full hash value of the software artifact. This value is used to verify the integrity of the software artifact. |
|
| string | experimentalThe identifier of the software artifact, typically the name of the artifact. |
|
| string | experimentalThe human-readable name of the software artifact. |
|
| string | experimentalThe Package URL of the package artifact. This value is used to identify and locate the artifact. |
|
| string | experimentalThe version of the software artifact, typically in Semantic Versioning format. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
Fields that can come from audit logs.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableAudited action. |
|
| string | stableUser name, service account name, or principal name that executes audited action. |
|
| string | stableResult of the audited action. |
|
| string | stableStatus of the audited action. |
|
| timestamp | experimentalTimestamp of the audited action. |
|
Authentication type and method used to login to a Dynatrace system.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe OAuth2 client id if of type 'CLIENT_CREDENTIALS'. |
|
| string | experimentalThe grant type used during OAuth2 authentication. |
|
| string | experimentalThe public token identifier of authentication.type 'TOKEN'. |
|
| string | experimentalThe method of authentication. |
|
authentication.grant.type MUST be one of the following:
| Value | Description |
|---|---|
| |
|
authentication.type MUST be one of the following:
| Value | Description |
|---|---|
| Authenticated via DevOps token |
| Not authenticated (authentication not necessary) |
| |
| Authenticated via API access token or personal access token |
authentication.client.id and authentication.token MUST follow the Dynatrace token format definition.
Specifically, authentication.client.id MUST be prefixed with dt0s02.
Information about entity availability. Sample usage is reporting hosts and PGI-s availability by OS Agent. Value of availability.state can be used for calculating aggregate availability (dividing count of "successful" requests by count of all requests). With constant frequency of requests it can be treated as a time-base availability, showing percentage of time that the monitored entity was available.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableState of entity (host or PGI) availability. |
|
availability.state has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| [PGI] PGI is available and reported. |
| [HOST] Host is working, agent active but no data are sent. |
| [HOST] Host is working, agent inactive (disabled manually in configuration). No data are sent. |
| [HOST] Host has started after graceful shutdown. |
| [HOST] Host has started after ungraceful shutdown. |
| [HOST] Host has been shut down. |
| [PGI] PGI is unavailable and not reported. |
| [PGI] PGI is available but not reported because it became unimportant. |
| [HOST] Host is unmonitored because agent stopped. |
| [HOST] Host is unmonitored because agent has been uninstalled. |
| [HOST] Host is unmonitored because agent is upgrading. |
| [HOST] Host is working, agent active and sending data. |
Fields that can come from applications running on AWS.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: |
|
| string | resource experimentalName associated with the AWS account. |
|
| string | resource experimentalApplication load balancer name that instance is behind. |
|
| string | resource experimentalAmazon Resource Name (ARN). |
|
| string | resource experimentalA specific availability zone or array of zones in given AWS region. |
|
| string | resource experimentalID for the availability zone. |
|
| string | resource experimentalExtends the aws.cloudfront.result_type with additional states. See full list under x-edge-detailed-result-type. |
|
| string | resource experimentalHow the server classified the response just before returning the response to the viewer. |
|
| string | resource experimentalHow the server classified the response after the last byte left the server. |
|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimentalThe full Amazon Resource Name (ARN) of the container. |
|
| string | resource experimental | |
| string | resource experimentalThe Docker ID for the container. |
|
| string | resource experimentalThe name of the container supplied to Docker. |
|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimentalThe full Amazon Resource Name (ARN) of the task to which the container belongs. |
|
| string | resource experimentalThe runtime identifier, prefixed by AWS_Lambda_. Lambda supports multiple languages through the use of runtimes. A runtime provides a language-specific environment that relays invocation events, context information, and responses between Lambda and the function. |
|
| long | resource experimentalThe number of field-level encryption fields that the server encrypted and forwarded to the origin. |
|
| string | resource experimentalWhen field-level encryption is configured for a distribution, this field contains a code that indicates whether the request body was successfully processed. |
|
| string | resource experimental | |
| string | resource experimentalThe AWS Lambda initialization type. Same string value as available in AWS_LAMBDA_INITIALIZATION_TYPE. |
|
| string | resource experimentalAmazon CloudWatch group of log streams that share the same retention, monitoring, and access control settings. |
|
| string | resource experimentalA sequence of log events that share the same source. |
|
| string | resource stableA specific geographical AWS Cloud location.Tags: |
|
| string | resource experimentalUnique, immutable, identifier assigned to the Azure cloud resource. |
|
| string | resource experimentalName of the resource (value of the "Name" tag in AWS). |
|
| string | resource experimentalThe name of a resource type. |
|
| string | resource experimentalThe service that identifies the AWS product. |
|
| string | resource experimentalContains the value for the tag with the tag key named |
|
aws.fle.status MUST be one of the following:
| Value | Description |
|---|---|
| A field that is configured to be encrypted exceeds the maximum length allowed. |
| A request that the distribution is configured to encrypt contains more than the number of fields allowed. |
| The server forwarded the request to the origin without parsing or encryption because no content type was configured. |
| The server forwarded the request to the origin without parsing or encryption because the request contains a query argument that wasn't in the configuration for field-level encryption. |
| The server forwarded the request to the origin without parsing or encryption because no profile was specified in the configuration for field-level encryption. |
| The server rejected the request and returned an HTTP 400 status code to the viewer because the value of the Content-Type header was in an invalid format. |
| The server rejected the request and returned an HTTP 400 status code to the viewer because the request body was in an invalid format. |
| The server rejected the request and returned an HTTP 400 status code to the viewer because a query argument was empty or in an invalid format. |
| The server successfully processed the request body, encrypted values in the specified fields, and forwarded the request to the origin. |
| The server rejected the request and returned an HTTP 400 status code to the viewer because no content type was specified in the configuration for field-level encryption. |
| The server rejected the request and returned an HTTP 400 status code to the viewer because no query argument was specified in the configuration for field-level encryption. |
| The length of the request body exceeded the maximum length allowed when field-level encryption is configured. |
| The origin server returned an error. |
aws.lambda.initialization_type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| On demand |
| Provisioned concurrency |
| SnapStart |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalAmazon resource name (ARN) of a Kinesis stream or consumer. |
|
| string | experimentalAmazon resource name (ARN) of a Kinesis consumer. |
|
| string | experimentalName of a Kinesis consumer. |
|
| string | experimentalAmazon resource name (ARN) of a Kinesis stream. |
|
| string | experimentalName of a Kinesis stream. |
|
| string | experimentalThe full invoked ARN as provided on the |
|
| string | experimentalThe AWS request ID (e.g., value of |
|
| string | experimentalName of an S3 bucket. |
|
| string | experimentalKey name of the object. |
|
| string | experimentalVersion ID for the specific version of the object. |
|
| long | experimentalPart number in a multi-part upload. |
|
| string | experimentalName of the bucket containing the object to copy. |
|
| string | experimentalKey of the object to copy. |
|
| string | experimentalVersion of the source object to copy. By default, the latest version is copied. |
|
| string | experimentalUpload ID identifying the multipart upload targeted by an operation (abort/complete/upload/…). |
|
| string | experimentalContains the AWS X-Ray trace id (e.g., value of the |
|
Fields that can come from applications running on Azure.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string[] | resource experimentalAvailability zones of Azure Cloud resource. |
|
| string | resource experimentalThe fully qualified name of the class executing an Azure function. |
|
| string | resource experimentalAzure Event Hub Namespace name. |
|
| string | resource stableA specific geographical location of Azure Cloud resource.Tags: |
|
| string | resource experimentalA group of Azure subscriptions used for governance use cases. |
|
| string | resource stableA resource group is a container that holds related resources for an Azure solution.Tags: |
|
| string | resource experimentalA unique, immutable identifier assigned to each Azure cloud resource. |
|
| string | resource experimentalUser-provided name of the Azure cloud resource. |
|
| string | resource experimentalThe name of a resource type in the format: {resource-provider}/{resource-type}. |
|
| string | resource experimentalAzure Service Bus name. |
|
| string | resource experimentalGlobally unique deployment information about an Azure function. |
|
| string | resource experimentalAzure SQL Server Elastic Pool name. |
|
| string | resource experimentalAzure SQL Server name. |
|
| string | resource stableAn Azure subscription is a logical container used to provision resources in Azure.Tags: |
|
| string | resource experimentalContains the value for the tag with the tag key named |
|
| string | resource experimentalUnique, immutable identifier assigned to the Azure tenant. |
|
| string | resource experimentalName assigned to the Azure tenant. |
|
| string | resource experimentalAzure Virtual Machine name. |
|
| string | resource experimentalAzure Virtual Machine Scale Set name. |
|
| string | resource experimentalAzure Virtual Machine unique 128bits identifier |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalInternal ID from the business flow configured in the Business Flow app. | |
| string | experimentalThe priority of a business process. |
|
| string | experimentalURL to explore the business flow in the Business Flow app from a result in a DQL query against Smartscape nodes. |
Fields that are integral to applications managed by BOSH.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalA specific geographical BOSH location. |
|
| string | resource stableBOSH depoloyment ID, retrievied from /var/vcap on monitored host. |
|
| string | resource stableBOSH instance name, retrievied from /var/vcap on monitored host. |
|
| string | resource experimentalA unique identifier assigned to each deployed instance. |
|
| string | resource experimentalA unique identifier to a deployment or instance. |
|
| string | resource stableVersion of BOSH stemcell, retrievied from /var/vcap on monitored host. |
|
The browser namespace contains information on the browser running an application.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalA unique ID generated by RUM JavaScript to identify the browser frame. The |
|
| uid | experimentalA unique ID generated by RUM JavaScript to identify the browser's next-higher frame (if that frame exists and is reachable). The |
|
| uid | experimentalA unique ID generated by RUM JavaScript to identify the browser tab. The |
|
| long | experimentalThe browser window's height, in pixels. |
|
| long | experimentalThe browser window's width, in pixels. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe browser name. |
|
| string | resource stableThe browser type. |
|
| string | resource stableThe full user agent string as provided by the browser in the HTTP |
|
| string | resource stableThe browser version. |
|
Span scoped attributes (e.g. method parameters, return values, class names, …) captured by the OneAgent based on a request attribute rule. The actual name of the attribute is the prefix "captured_attribute" plus the "request attribute name" defined in the request attributes configuration. In contrast to request attributes, captured attributes contain the raw values reported by the OneAgent at the location (i.e. on the active span) where they appeared. No aggregation (first/last value, distinct values, ...), type conversion or normalization is performed on them. They are the basis for request attributes.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| array | stableContains the span scoped raw values that were captured under the name |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
The cicd namespace contains information about Continuous Integration and Continuous Deployment systems.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe CI/CD pipeline's identifier, which is unique within one CI/CD system. |
|
| string | experimentalThe human-readable name of the CI/CD pipeline. |
|
| string | experimentalAn identifier for a pipeline run, which is unique within one CI/CD system. |
|
| string | experimentalThe outcome of one pipeline run. |
|
| string | experimentalThe URL pointing to one specific pipeline run. |
|
| string | experimentalThe CI/CD pipeline's full URL. |
|
| string | experimentalThe identifier of the upstream CI/CD pipeline. If a pipeline run was triggered by another pipeline, this attribute is used to reference the triggering pipeline. |
|
| string | experimentalThe identifier of the upstream CI/CD pipeline run. If a pipeline run was triggered by another pipeline, this attribute is used to reference the triggering pipeline run. |
|
cicd.pipeline.run.outcome has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The pipeline run was canceled and did not complete. |
| The pipeline run failed with an error. |
| The pipeline run failed. |
| The pipeline did not run, but was skipped. |
| The pipeline run completed successfully. |
| The pipeline run timed out, and therefore did not complete. |
| The pipeline run completed with at least one warning. |
The client namespace contains information on the initiator of a network connection.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalClient address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. |
|
| string | experimentalThe name of the client application used to perform the request. |
|
| ipAddress | experimentalThe IP address of the client that makes the request. This may be IPv4 or IPv6.Tags: |
|
| boolean | experimentalIndicates whether IP is a public IP. |
|
| string | experimentalThe name of the Internet Service Provider (ISP) associated with the client's IP address. |
|
| long | stableClient port number. |
|
Fields related to cloud deployments that can be used across different providers.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe cloud account ID to which the resource is assigned. |
|
| string | resource stableIdentifier referring to the availability zone within a cloud vendor's region. |
|
| string | resource stableThe cloud platform in use. 1 |
|
| string | resource experimentalName of the cloud provider. |
|
| string | resource stableIdentifier of the cloud vendor's data center geographic region. |
|
| string | resource stableCloud provider-specific native identifier of the monitored cloud resource (for example, an ARN on AWS, a fully qualified resource ID on Azure, or a complete resource name on GCP). |
|
The prefix of the service matches the one specified in cloud.provider.
cloud.platform MUST be one of the following:
| Value | Description |
|---|---|
| Alibaba Cloud Elastic Compute Service |
| Alibaba Cloud Function Compute |
| Red Hat OpenShift on Alibaba Cloud |
| AWS App Runner |
| AWS Elastic Compute Cloud |
| AWS Elastic Container Service |
| AWS Elastic Kubernetes Service |
| AWS Elastic Beanstalk |
| AWS Lambda |
| Red Hat OpenShift on AWS (ROSA) |
| Azure Kubernetes Service |
| Azure App Service |
| Azure Container Instances |
| Azure Functions |
| Azure Red Hat OpenShift |
| Azure Virtual Machines |
| Google Cloud App Engine (GAE) |
| Google Cloud Functions (GCF) |
| Google Cloud Run |
| Google Cloud Compute Engine (GCE) |
| Google Cloud Kubernetes Engine (GKE) |
| Red Hat OpenShift on Google Cloud |
| Red Hat OpenShift on IBM Cloud |
| Tencent Cloud Cloud Virtual Machine (CVM) |
| Tencent Cloud Elastic Kubernetes Service (EKS) |
| Tencent Cloud Serverless Cloud Function (SCF) |
cloud.provider has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Alibaba Cloud |
| Amazon Web Services |
| Microsoft Azure |
| Google Cloud Platform |
| Heroku Platform as a Service |
| IBM Cloud |
| Tencent Cloud |
Fields related to operations related to a cloud.
The cloud.target namespace provides information on the entity targeted by outgoing requests.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe cloud account ID used to access a cloud resource. |
|
| string | experimentalName of the cloud provider. |
|
| string | experimentalIdentifier of the cloud vendor's data center geographic region. |
|
| string | experimentalCloud provider-specific native identifier of the accessed cloud resource (for example, an ARN on AWS, a fully qualified resource ID on Azure, or a complete resource name on GCP). |
|
cloud.target.provider has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Alibaba Cloud |
| Amazon Web Services |
| Microsoft Azure |
| Google Cloud Platform |
| Heroku Platform as a Service |
| IBM Cloud |
| Tencent Cloud |
The cloud.origin namespace provides information on the entity from which incoming requests originate.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe cloud account ID used to access a cloud resource. |
|
| string | experimentalName of the cloud provider. |
|
| string | experimentalIdentifier of the cloud vendor's data center geographic region. |
|
| string | experimentalCloud provider-specific native identifier of the accessed cloud resource (for example, an ARN on AWS, a fully qualified resource ID on Azure, or a complete resource name on GCP). |
|
cloud.origin.provider has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Alibaba Cloud |
| Amazon Web Services |
| Microsoft Azure |
| Google Cloud Platform |
| Heroku Platform as a Service |
| IBM Cloud |
| Tencent Cloud |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe call stack of the |
|
| string | experimentalThe source code file name that identifies the code unit as uniquely as possible. |
|
| string | experimentalThe method or function name, or equivalent (usually the rightmost part of the code unit's name). Represents the name of the function that is represented by this span. |
|
| string | experimentalLike |
|
| string | experimentalLike |
|
| string | experimentalLike |
|
| long | experimentalThe line number within the source code file. |
|
| string | experimentalThe namespace within which |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental |
For some technologies compilation of code might be a significant contributor to request execution time. Compilation timings provide insight into this, where available.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of compilations contributing to |
|
| duration | experimentalThe total duration in nanoseconds spent compiling. |
|
| record | experimentalThe top N compilations contributing to |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalContainer ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated. |
|
| string | resource experimentalName of the image the container was built on. |
|
| string | resource experimental |
|
| string | resource experimentalContainer name used by container runtime. |
|
CTG (shorthand for "CICS Transaction Gateway") is a connector for enterprise modernization of CICS assets. It empowers various application platforms, such as Java servlets, to incorporate CICS programs.
CICS (shorthand for "Customer Information Control System") is a middleware to support rapid, high-volume online transaction processing on IBM mainframe systems on z/OS. CTG features a client and a server, which communicate via so-called GatewayRequests.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalInteger representing the call type of the CTG GatewayRequest. The set of possible values varies per request type. 1 |
|
| long | experimentalLength of the COMMAREA. Only set when the request type is ECI. |
|
| long | experimentalInteger representing the extended mode of the CTG GatewayRequest. Only set when the request type is ECI. 2 |
|
| long | experimentalInteger representing the flow type of the CTG GatewayRequest. 3 |
|
| string | experimentalURL of the gateway. Only set on client-side spans. |
|
| string | experimentalName of the request object. Only set when the request type is ADMIN. | |
| string | experimentalID of the server. Not set for all request types. |
|
| string | experimentalName of the terminal resource. Only set when the request type is EPI. |
|
| string | experimentalType of the CTG GatewayRequest. |
|
| long | experimentalCTG response code. The set of possible values varies per request type. 4 |
|
The values are defined in the IBM CTG API source code.
ctg.request.type MUST be one of the following:
| Value | Description |
|---|---|
| Admin request. |
| Authentication request. |
| Base. A base GatewayRequest without a further subtype. 1 |
| External Call Interface. Enables a client application to call a CICS program synchronously or asynchronously. 2 |
| External Presentation Interface. Enables a user application to install a virtual IBM 3270 terminal into a CICS server. 3 |
| External Security Interface. Enables user applications to perform security-related tasks. 4 |
| CICS Request Exit. It can be used for request retry, dynamic server selection, and rejecting non-valid requests. 5 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe service method of a custom service. This field only exists if a custom service was created via Dynatrace OneAgent SDK. |
|
| string | experimentalThe name of a custom service. This field only exists if a custom service was created via Dynatrace OneAgent SDK. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of items (rows, documents,…) affected. |
|
| string | stableThe name of a collection (table, container) within the database. |
|
| string | experimentalThe connection string for a database connection.Tags: |
|
| double | experimentalThe cost of the request in Azure Cosmos DB request units (RU). |
|
| string[] | experimentalThe list of tables the request targets. |
|
| string | stableThe name of the database, fully qualified within the server address and port. |
|
| string | stableThe name of the operation or command executed, for example the MongoDB command name, SQL keyword, Redis command name,… 1 |
|
| record[] | experimentalThe query parameters used in db.query.text represented as a key and value map. For database systems without named keys, the map key is the string representation of the index starting with 0. Several database requests may get aggregated into a single span. Each entry in the array holds the bind parameters for one database request.Tags: |
|
| string | stableThe database query being executed. 2 |
|
| duration | experimentalThe maximum duration in nanoseconds used for fetching the result. |
|
| duration | experimentalThe minimum duration in nanoseconds used for fetching the result. |
|
| duration | experimentalThe total duration in nanoseconds used for fetching the result. |
|
| long | experimentalThe number of exceptions encountered while fetching the result. |
|
| long | experimentalThe number of operations executed on the result (for example, fetches from SQL result set, MongoDB cursor operations). |
|
| long | experimentalThe number of round-trips triggered by fetching the result. |
|
| string | experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. |
|
Depending on the data provided on ingest, this attribute may be derived by e.g., parsing db.query.text. Parsing might fail, or the result might be inaccurate.
The value may be sanitized to exclude sensitive information.
db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Adabas (Adaptable Database System) |
| InterSystems Caché |
| Apache Cassandra |
| ClickHouse |
| Cloudscape |
| CockroachDB |
| ColdFusion IMQ |
| Microsoft Azure Cosmos DB |
| Couchbase |
| CouchDB |
| IBM Db2 |
| Apache Derby |
| IBM DL/I |
| Amazon DynamoDB |
| EnterpriseDB |
| Elasticsearch |
| FileMaker |
| Firebird |
| FirstSQL |
| Apache Geode |
| H2 |
| SAP HANA |
| Apache HBase |
| Apache Hive |
| HyperSQL DataBase |
| Informix |
| Ingres |
| InstantDB |
| InterBase |
| MariaDB |
| SAP MaxDB |
| Memcached |
| MongoDB |
| Microsoft SQL Server |
| Microsoft SQL Server Compact |
| MySQL |
| Neo4j |
| Netezza |
| OpenSearch |
| Oracle Database |
| Some other SQL database. Fallback only. See notes. |
| Pervasive PSQL |
| PointBase |
| PostgreSQL |
| Progress Database |
| Redis |
| Amazon Redshift |
| Cloud Spanner |
| SQLite |
| Sybase |
| Teradata |
| Vertica |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe build version of the deployed product. |
|
| string | resource experimentalThe name of the deployed product. |
|
| string | resource experimentalThe stage the product is deployed to. |
|
| string | resource experimentalThe version of the deployed product. |
|
The device namespace contains information on the device running an application. This should only be used for end-user devices or devices outside of a private infrastructure. In line with the naming conventions and guidelines, we are in this case adhering to the emerging Open Telemetry convention around this, with some additions.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe device's battery level in the range 0% (discharged) to 100% (fully charged). |
|
| string | experimentalThe device orientation. |
|
device.orientation MUST be one of the following:
| Value | Description |
|---|---|
| The device was in landscape mode. |
| The device was in portrait mode. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | resource experimentalIf set to |
|
| string | resource experimentalThe device manufacturer. |
|
| string | resource experimentalThe device model identifier. |
|
| long | resource experimentalThe device's screen height in its natural orientation. |
|
| long | resource experimentalThe device's screen width in its natural orientation. |
|
Fields describing a disk.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string[] | resource experimentalList of all mountpoints |
|
| string | resource experimentalDisk device name (Linux, AIX) |
|
| string | resource experimentalPrimary mountpoint |
|
| long | resource stableUnique identifier of remote disk |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe name of the program communication block associated with this DL/I method. |
|
| string | experimentalThe PCB type. |
|
| string | experimentalThe PCB processing options. |
|
| string | experimentalThe hierarchical level of the segment that was matched or returned. |
|
| string | experimentalThe name of the last segment that was matched or returned. |
|
| string | experimentalThe DL/I status code. |
|
| string | experimentalThe DL/I database or logical terminal name associated with this DL/I method. |
|
db.dli.pcb_type MUST be one of the following:
| Value | Description |
|---|---|
| Data communications. |
| DL/I db. |
| Fast Path. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalFilename of main dotnet assembly. | |
| string | resource experimentalFilepath of main dotnet assembly. |
Metadata with ActiveGate realated information.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of a group that the ActiveGate instance belongs to. |
|
| string | resource experimentalHexadecimal identifier of the ActiveGate prefixed with |
|
| string | resource experimentalThe name of ActiveGate module |
|
| string | resource experimentalWorking mode of the ActiveGate |
|
dt.active_gate.working_mode MUST be one of the following:
| Value | Description |
|---|---|
| Cluster ActiveGate |
| Embedded ActiveGate |
| Environment ActiveGate |
| Multitenant ActiveGate |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalConfig long id of the endpoint configuration as a string. |
|
| string | resource experimentalString identifier of an api connector pipeline |
|
| string | resource experimentalStatus of an api connector pipeline run |
|
| string | resource experimentalString identifier of an api connector technology |
|
dt.active_gate.api_connector.pipeline_status MUST be one of the following:
| Value | Description |
|---|---|
| Pipeline execution failed |
| Pipeline execution skipped |
| Pipeline execution succeeded |
Metadata of the OneAgent module that reported a signal. These attributes are what one would also see in OneAgent Health.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | resource stableOneAgent module ID. |
|
| uid | resource stableOneAgent parent module ID, in case this is a so-called sub-agent |
|
| string | resource stableOneAgent module type |
|
| string | resource stableOneAgent full module version |
|
| string | resource experimentalOneAgent short module version, to be expected only on record types where |
|
| string | resource experimentalMonitoring Mode in which given agent operates |
|
dt.agent.module.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| apache |
| dotnet |
| dumpproc |
| extensions |
| go |
| iis |
| java |
| log_analytics |
| net |
| nettracer |
| nginx |
| nodejs |
| opentracingnative |
| os |
| php |
| plugin |
| process |
| python |
| remote_plugin |
| ruby |
| sdk |
| support |
| updater |
| varnish |
| wsmb |
| z_ |
dt.agent.monitoring_mode MUST be one of the following:
| Value | Description |
|---|---|
| Discovery monitoring mode provides basic metrics enabling you to discover your hosts and processes and learn the potential to extend your monitoring. |
| Full stack monitoring mode includes application performance, user experience data, code-level visbility and PurePath insights, as well as everything that is included in Infrastructure monitoring mode. |
| Infrastructure monitoring mode includes topology discovery, detailed health and performance monitoring of your host, and enables Network monitoring, Log monitoring and Extensions. |
Fields defined in this namespace are used by Dynatrace to describe various aspects of events emitted by the AutomationEngine.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe app id of the app containing the executed action. |
|
| string | experimentalName of the function implementing the action. |
|
| string | experimentalThe unique identifier of a action execution as UUID. |
|
| long | experimentalLoop index of the action execution. | |
| long | experimentalRetry count of the action execution. | |
| string | experimentalThe unique identifier of the root workflow. |
|
| string | experimentalThe unique identifier of the execution of the root workflow. |
|
| string | experimentalThe state of an execution. Values depend on type of execution (workflow-, task-, or action execution). |
|
| boolean | experimentalIndicates if |
|
| string | experimentalAdditional info about current state of execution. Typically holds error details. |
|
| string | experimentalThe identifier of a task within a workflow. |
|
| string | experimentalThe unique identifier of a task execution as UUID. |
|
| string | experimentalThe unique identifier of a workflow as UUID. |
|
| string | experimentalThe title of the workflow. |
|
| string | experimentalWorkflow type, either SIMPLE or STANDARD, where SIMPLE comes with restrictions. |
|
| string | experimentalThe unique identifier of a workflow execution as UUID. |
|
| string | experimentalThe identifier that describes the trigger of the workflow. |
|
| string | experimentalThe unique identifier of the user who triggered the workflow execution manually/via API. |
|
| string | experimentalThe unique identifier of the workflow that triggered the workflow execution. |
|
Attributes defined in this namespace are used by Dynatrace to describe different aspects of the ingested data.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalARN of AWS Data Firehose signal is originating from. |
|
| string | experimentalName of the source Amazon CloudWatch Log group |
|
| string | experimentalName of the source Amazon CloudWatch Log stream |
|
| string | experimentalName of S3 bucket name signal is originating from |
|
| string | experimentalName of S3 bucket name signal is originating from |
|
| string | experimentalThe location of the Event Hub that the signal is originating from |
|
| string | experimentalThe name of the Event Hub that the signal is originating from |
|
| string | experimentalDynatrace source of signal ingestion |
|
dt.da.source has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| aws-log-ingest |
| aws-metric-poller |
| aws-metrics-ingest |
Some attributes are used in the context of the Davis engine.
These fields can be set in events to influence the Davis engine behavior.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | stableThe time budget (in seconds) that the Davis® engine is granted before it must raise a problem. The analysis time budget can be set per event and controls the balance of sending out alerts early and granting the AI analysis enough time to finish its analysis. The trade-off of a short analysis budget is that the root cause and event merge analysis is limited or even skipped. For example, the time budget of 0 seconds means that the event raises a problem and sends the alert immediately, without any analysis. | |
| long | stableThe time delay (in seconds) before the trigger of Davis® analysis. For example, the delay of 0 seconds triggers a Davis® problem and the root cause analysis immediately. The trigger delay can be used to hold the analysis until all the relevant root cause data has arrived to Dynatrace. For example, it might be beneficial for cloud integrations or log integrations that report data in different schedules - you can delay the analysis until data from all sources is available. Note that while longer delays means more data is available for root cause analysis, it also delays alerts delivery. | |
| boolean | stableThis flag defines whether the remapping of the target entity is enabled (true) or disabled (false). If the remapping is enabled, Dynatrace can map the event to an entity extracted from the event metadata. If the remapping is disabled or the extraction is not possible, Dynatrace maps the event to the entity specified in the event configuration (for example, a specific host) or to the global environment entity. | |
| boolean | stableThe flag controls whether the Davis® engine should detect frequent issues. If the flag is set to true, events identified as frequent won't be triggered or merged into a problem. If the flag is set to false, frequent issues won't be detected and events will be triggered and merged as normal. | |
| boolean | stableThis flag controls whether the Davis® engine is allowed to merge this event into a larger problem (true) or if a new problem must be created (false). | |
| boolean | stableThis flag controls whether the Davis® engine suppresses the problem from showing up in the UI and sending notifications. | |
| boolean | stableThis flag controls whether the Davis® engine should include this event within the root cause analysis (true) or if it is not (false) relevant. | |
| string | stableThe preferred entity type for remapping. You can find possible values in Dynatrace UI under Settings > Topology model > Generic types. If the remapping (dt.event.allow_entity_remapping) is enabled, this property defines the entity type to which the event should be mapped. If no entity of the preferred type is extracted, no remapping is applied. |
|
| long | stableThe event timeout period (in minutes). Various event sources use this event property to keep an event active by regularly refreshing an initial event. The timeout defines how fast the event source must refresh an event to keep it active. To keep the event active, the event source must send the refresh within the timeout period. If no refresh is sent, the event is automatically closed by Dynatrace after the timeout period. Note that metric sources use their own configurable de-alerting windows to close events. Setting the timeout shorter than the de-alerting window will force events to close and increase the risk of false-positive alerts. |
These fields can be set by Davis routines.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | stableBoolean time series of 0 and 1 showing whether a single timespan was alerted due to continuous violations. | |
| long | stableBoolean timeseries of 0 and 1 showing whether a single timespan is outside the normal value range and therefore considered as abnormal. | |
| long | stableThe lower value range limit where any value below this point is considered abnormal. | |
| long | stableThe upper value range limit where any value above this point is considered abnormal. | |
| long | stableThe lower bound of the prediction interval of a given metric forecast. | |
| long | stableThe point value of a metric forecast. | |
| long | stableThe upper bound of the prediction interval of a given metric forecast. |
Fields that can be expected on a Dynatrace span where endpoint detection was applied.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalThe ID of the endpoint detection rule that was applied to that span. |
|
The Dynatrace OneAgent associates monitoring data with a so called Monitored Entity ID (ME ID). On OneAgent monitored environments, whenever ME IDs are accessible within the monitored system they should be used to enrich monitoring data to facilitate correlations with data primarily addressed through ME IDs coming from other channels.
The structure for keys that signify entity IDs is dt.entity.{type of entity}.
The value associated with such a key must be valid Dynatrace entity identifier
(see Monitored entities API).
To allow linking Entity IDs across various different monitoring artifacts (logs, metrics, etc.), all string representations of Entity IDs are required to follow a canonical form, which for all current entities is defined as PREFIX-0123456789ABCDEF.
Consumers should treat the token as an opaque value and must not infer any semantics on the ID itself. Producers need to match the Entity ID that is being returned by Dynatrace Entity API verbatim.
Producers of string representation must treat the string as if it was parsed case-sensitively, even though some parts of the product may be more lenient.
The structure of the entity ID is currently as follows: <ID-NAMESPACE>-<16-digit-hex-string>. The <ID-NAMESPACE> is type specific but cannot be used to determine the actual entity type reliably, especially in cases of CUSTOM_DEVICE. The <16-digit-hex-string> needs to be zero-padded (prefix) to a length of 16 digits and must use upper case letters A-F.
Current entity IDs in cannonical form can be represented structurally with the following regular expression: [A-Z][A-Z_]*-[0-9A-F]{16}.
Additional characters or changes in the format may happen in the future but will not invalidate existing IDs or ID generation rules.
When adding a name to an entity ID via the Grail function entityName, by default, the name of the respective entity will be represented as dt.entity.{type of entity}.name. Similarly, further entity attributes can be added via the Grail function entityAttr, resulting in additional field(s) following the naming convention dt.entity.{type of entity}.{name of attribute}.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe ME ID of a web application.Tags: |
|
| string | resource stableAn entity ID of an entity of type AWS_AVAILABILITY_ZONETags: |
|
| string | resource stableAn entity ID of an entity of type AZURE_REGIONTags: |
|
| string | resource stableAn entity ID of an entity of type AZURE_VMTags: |
|
| string | resource stableAn entity ID of an entity of type CLOUD_APPLICATION.Tags: |
|
| string | resource stableAn entity ID of an entity of type CLOUD_APPLICATION_INSTANCE.Tags: |
|
| string | resource stableAn entity ID of an entity of type CLOUD_APPLICATION_NAMESPACE. A CLOUD_APPLICATION_NAMESPACE is a Kubernetes namespace.Tags: |
|
| string | resource stableAn entity ID of an entity of type CONTAINER_GROUP.Tags: |
|
| string | resource stableAn entity ID of an entity of type CONTAINER_GROUP_INSTANCE.Tags: |
|
| string | resource stableThe ME ID of a custom application.Tags: |
|
| string | resource stableAn entity ID of an entity of type CUSTOM_DEVICE.Tags: |
|
| string | resource stableAn entity ID of an entity of type DISKTags: |
|
| string | resource stableAn entity ID of an entity of type EC2_INSTANCETags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type EXTERNAL_SYNTHETIC_TEST_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type GCP_ZONETags: |
|
| string | resource stableAn entity ID of an entity of type HOST.Tags: |
|
| string | resource stableAn entity ID of an entity of type HOST_GROUP.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK.Tags: |
|
| string | resource stableAn entity ID of an entity of type HTTP_CHECK_STEP.Tags: |
|
| string | resource stableAn entity ID of an entity of type KUBERNETES_CLUSTER.Tags: |
|
| string | resource stableAn entity ID of an entity of type KUBERNETES_NODE.Tags: |
|
| string | resource stableAn entity ID of an entity of type KUBERNETES_SERVICE.Tags: |
|
| string | resource stableThe ME ID of a mobile application.Tags: |
|
| string | resource stableAn entity ID of an entity of type MULTIPROTOCOL_MONITOR.Tags: |
|
| string | resource stableAn entity ID of an entity of type NETWORK_INTERFACETags: |
|
| string | resource stableAn entity ID of an entity of type PROCESS_GROUP.Tags: |
|
| string | resource stableAn entity ID of an entity of type PROCESS_GROUP_INSTANCE.Tags: |
|
| string | resource stableAn entity ID of an entity of type SERVICE.Tags: |
|
| string | resource stableAn entity ID of an entity of type SERVICE_METHOD.Tags: |
|
| string | resource stableAn entity ID of an entity of type SERVICE_METHOD_GROUP.Tags: |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_LOCATION.Tags: |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST.Tags: |
|
| string | resource stableAn entity ID of an entity of type SYNTHETIC_TEST_STEP.Tags: |
|
Additional extension information sent via self-monitoring.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalExtension's monitoring configuration identifier. |
|
| string | resource experimentalName of the data source. |
|
| string[] | resource experimentalHints to provide for the cluster in order to find proper endpoint in task registry. |
|
| string | resource experimentalName of the extension. |
|
| string | resource experimentalThe status of the component reporting a self-monitoring event. |
|
dt.extension.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Unable to connect to EEC |
| Failed to establish connection with the device |
| Unable to connect to EEC |
| Generic status used to communicate job failed |
| Invalid arguments |
| Config provided by EEC is invalid |
| Extension works fine |
| Uninitialized/unknown error |
Attributes used for Process Group enrichment in extensions.
Attributes defined in this namespace are used by Dynatrace to describe different aspects of the ingested data.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string[] | experimentalAn array of strings that represent debug messages that provide a detailed debugging information. That could include even variable parts, like which attribute was modified, or which processing rules were applied. |
|
| string | experimentalThe format of the data ingested in Dynatrace via the various ingest channels. E.g., Generic log ingest, OTLP logs ingest |
|
| long | stableThe size of the ingested data point in bytes. |
|
| string[] | experimentalAn array of strings representing markers of unexpected situations that might affect the correctness or completeness of incoming data points. It might be, for instance, limits applied or a processing rule failing. It should not be a detailed log of what happened, just the high-level class of the issue that occurred. |
|
dt.ingest.format MUST be one of the following:
| Value | Description |
|---|---|
| JSON data ingested via the Dynatrace APIs or via EEC (Extension Execution Controller) |
| (deprecated: use "plaintext") Plain text data ingested via the Dynatrace API |
| Journald data ingested via OneAgent |
| OpenTelemetry Protocol (OTLP) JSON data ingested via the Dynatrace APIs |
| OpenTelemetry Protocol (OTLP) Protobuf data ingested via the Dynatrace APIs or via EEC (Extension Execution Controller) |
| Plain text data ingested via the Dynatrace APIs, EEC (Extension Execution Controller) or OneAgent |
| Syslog data ingested via OneAgent |
| The data format was not recognized (only for metrics dimension) |
| Windows event log data ingested via OneAgent |
dt.ingest.warnings MUST contain only values from the following list:
| Value | Description |
|---|---|
| The content was trimmed, right after receiving it by Cluster/ActiveGate, because it exceeded the event content max byte size limit. |
| The content was trimmed in post-processing (after applying processing rules) because it exceeded the event content max byte size limit |
| The number of attributes was trimmed, right after receiving it by Cluster/ActiveGate, because it exceeded the max number of attributes limit. |
| The number of attributes was trimmed in post-processing (after applying processing rules) because it exceeded the max number of attributes limit. |
| The attribute key is detected that matches the custom attribute key or the semantic attribute key, but there is the attribute key case mismatch. |
| The attribute key was trimmed, right after receiving it by Cluster/ActiveGate, because it exceeded the max key length limit. |
| At least one multi-value attribute had values number trimmed, right after receiving it by Cluster/ActiveGate, because it exceeded the max number of attributes limit. |
| After applying processing rules, at least one multi-value attribute had its values number trimmed (after using processing rules) because it exceeded the maximum number of attributes limit. |
| At least one attribute had its value size trimmed, right after receiving it by Cluster/ActiveGate, because it exceeded the max value size in bytes limit. |
| At least one attribute had its value size trimmed (after applying processing rules) because it exceeded the max value size in bytes limit. |
| Timestamp was too far in the future and was corrected to current time. |
| STATUS, LOG_LEVEL or EVENT_TYPE attribute was corrected. |
| Batch timeout occurred during processing pipeline. |
| Execution timeout in one of processing transformers occurred during processing pipeline. |
| Execution error in one of processing transformers occurred during processing pipeline. |
| Execution throttled in one of processing transformers during processing pipeline. |
| Output conversion error occurred for some record during processing pipeline. |
| Prepare input error occurred in one of enabled processing pipeline rules. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableCan be used to assign usage to a Cost Center. |
|
| string | resource stableCan be used to assign usage to a Product or Application ID. |
|
| string | resource stablesee Organize your environment using host groups. Note that host groups are identified by their name. This is not the entity ID of Host Group Entity, for which see dt.entity.host_groupTags: |
|
| string | resource experimentalThe source from which metrics are ingested. 1 |
|
| string | resource experimentalThe ID of the network zone. See Dynatrace Documentation |
|
| string | resource experimental | |
| string | resource experimentalalso see Define metadata via environment variables | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource stableThe name of the process group as it was detect by the agent. |
|
| string | resource stableThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission modelTags: | |
| string | resource experimentalThe ID of the entity considered the source of the signal. The string represents an entity ID of an entity that is stored in the Smartscape storage. 2Tags: |
|
| string | resource stableThe entity type of the entity whose identifier is held in dt.smartscape_source.id. |
|
| string | resource stableThe ID of the entity considered the source of the signal. The string represents an entity ID of an entity that is stored in the classic entity storage. 3Tags: |
|
| string | resource stableThe entity type of the entity whose identifier is held in dt.source_entity. The value must be a valid entity type and consistent with |
|
This is the framework used for capturing, processing and forwarding metrics, not the emitting monitored entity. Exemplary custom value: name of an extension sending metrics.
The value of this field will be based on one of dt.smartscape.<type> fields value. That means that both fields dt.smartscape_source.id and dt.smartscape.<type> will be set to the same ID.
The value of this field will be based on one of the dt.entity.<type> fields value. This means that both dt.source_entity and dt.entity.<type> fields will be set to the same ID.
dt.metrics.source has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| dynatrace_codemodule |
| dynatrace_ingest |
| OsAgent |
| Micrometer |
| OneAgentMetricAPI |
| OpenTelemetry |
| StatsD |
| Telegraf |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| array | experimentalUUIDs of maintenance windows. |
|
| string | experimentalA query in the DQL format, see Dynatrace Query Langauge. |
|
| string | experimentalThe complete content of the record as it was originally accepted by Dynatrace, stored as a string in JSON format. This field captures the unaltered data for reference, debugging, or auditing purposes |
|
Fields defined in this namespace are used by Dynatrace to describe various aspects of the data ingested through OpenPipeline, providing detailed insights into the ingestion process.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string[] | resource experimentalCollects the identifiers of all pipelines through which a record has passed during the ingestion process in OpenPipeline, providing a complete trace of its journey. |
|
| string | resource experimentalIdentifies the source (such as API endpoints or OneAgent) used for ingesting the record into OpenPipeline. |
|
| string | resource experimentalIdentifies the source type used to ingest data in Dynatrace, for example, from OTLP and OneAgent. |
|
dt.openpipeline.source_type MUST be one of the following:
| Value | Description |
|---|---|
| Logs ingested via one of the ActiveGate APIs |
| Logs ingested via Amazon Data Firehose |
| Logs ingested via the EEC running on host |
| Logs ingested via OneAgent |
| Logs ingested via the OpenTelemetry Protocol (OTLP) |
| The source type was not recognized (only for metrics dimension) |
The dt.rum namespace contains Dynatrace RUM specific fields.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalAn entity ID of an entity of type APPLICATION or MOBILE_APPLICATION.Tags: |
|
| string | stableThe Dynatrace RUM application ID. For mobile applications, a UUID is used. For web applications, an 8-byte HEX string is used. |
|
| string | experimentalThe browser session ID, taken from the dtCookie value. Not applicable for OneAgent for Mobile. |
|
| string | stableA unique ID that represents the user session. |
|
| string | experimentalThe user tag. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe Dynatrace RUM agent type. |
|
| string | resource experimentalThe version of the Dynatrace RUM agent. It is provided in the format major.minor.patch.build. The build number is optional. |
|
| string | resource experimentalThe Dynatrace RUM source technology that produced this event. Only used by cross-platform implementations, otherwise the field is omitted. |
|
| string | resource stableThe RUM application instance ID. (This was formerly called the "Visitor id", "internal user ID", and "rxVisitor cookie value".) |
|
| string | resource stableThe Dynatrace RUM enrichment version. |
|
| string | resource experimentalThe RUM user type. |
|
dt.rum.agent.type MUST be one of the following:
| Value | Description |
|---|---|
| OneAgent for Android |
| OneAgent for iOS |
| RUM JavaScript |
dt.rum.event.source.type MUST be one of the following:
| Value | Description |
|---|---|
| Flutter |
| React Native auto-instrumentation |
dt.rum.user_type MUST be one of the following:
| Value | Description |
|---|---|
| The user event was produced by a real user. |
| The user event was produced by a bot user. |
| The user event was produced by a synthetic test. |
The dt.rum.invalid namespace is used for fields that are removed because of user event ingest validation.
For example, if the calculated web_vitals.largest_contentful_paint value would be less than 0, the value is copied over to dt.rum.invalid.web_vitals.largest_contentful_paint and web_vitals.largest_contentful_paint is removed.
Fields for referencing Settings 2.0 objects, schemas and scopes.
Although the dt.settings.object_id is enough to identify a specific settings value within a dynatrace environment, adding explicit information about the schema, scope and/or scope type can be useful nonetheless. If your use-case will only ever involve a single schema, scope type and/or scope, documenting this is good enough - if multiple schemas, scope types and/or scopes can be involved, filling the corresponding fields is strongly recommended.
dt.settings.references can be used if multiple settings objects need to be referenced. In that case, each entry in the array can hold a reference to a single settings object.
The top level fields contain generally relevant information for all monitoring data.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe object ID of a settings value. This corresponds to the 'objectId' field/parameter in the Settings API. |
|
| string | experimentalThe human-readable summary or name of a single value of a multi-value settings schema. This corresponds to the 'summary' field in the Settings API. |
|
| record[] | experimentalA collection of references to settings objects. Each entry in the array holds a reference to a single settings object. |
|
| string | experimentalThe type of relationship to the referenced settings object. You can use arbitrary values (in |
|
| string | experimentalThe schema ID of a settings schema, as used in the Settings APIs. |
|
| string | experimentalThe version of the schema referenced by dt.settings.schema_id, as declared by the schema itself. Typically a semantic version number. |
|
| string | experimentalThe ID of the scope that a settings object is persisted on. This corresponds to the 'scope' field/parameter in the Settings API. |
|
| string | experimentalThe human-readable name of the scope that a settings object is persisted on. |
|
| string | experimentalThe type of the scope that a settings object is persisted on. |
|
Entities stored in the Grail based Smartscape storage will coexist with classic entities. To ensure we can distinguish between classic IDs and Smartscape IDs, we use the dt.smartscape.* namespace to enrich entity IDs in signal data.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableA Smartscape ID that can be used to query entities from the Smartscape storage. |
|
The dt.synthetic namespace contains Dynatrace synthetic specific fields.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe identifier of the batch (defined for on-demand executions only). | |
| string | experimentalThe identifier of the monitor. |
|
| array | experimentalIDs of monitored entities. |
|
| array | experimentalRequest target addresses with DNS record type or TCP port number. |
|
| array | experimentalIDs of synthetic monitor or steps. |
|
The namespace dt.system is reserved for Grail. These fields cannot be ingested but instead will be set by Grail directly. Every record that is fetched from Grail provides these fields, but by default they are hidden. You can display them by using the fieldsAdd command.
Example query:
// display the bucket for each log recordfetch logs| fieldsAdd dt.system.bucket
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe Grail bucket that the record is stored in. |
|
| string | resource stableThe Dynatrace environment that the record belongs to. |
|
| string | resource stableIdentifies the license under which the source is running. |
|
| long | resource stableThe selected sampling ratio. |
|
| string | resource stableThe segment that the record belongs to. |
|
| string | resource stableIdentifies the timeframe represented by individual data structures stored under a metric key. |
|
| string | resource stableThe table that the record belongs to. |
|
dt.system.monitoring_source MUST be one of the following:
| Value | Description |
|---|---|
| The source is running under the discovery license. |
| The source is running under the full-stack container license. |
| The source is running under the full-stack host license. |
| The source is running under the infrastructure license. |
| The source is running under the mainframe license. |
dt.system.storage_interval MUST be one of the following:
| Value | Description |
|---|---|
| The timeframe represented by individual measurements of a metrics record in storage. |
Fields defined in this namespace are used by Dynatrace to describe different aspects of the context propagation between spans.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalThe custom link ID to identify spans calling each other. The ID is derived from the custom link bytes. |
|
| binary | experimentalThe original binary data of the custom link. |
|
| binary | experimentalThe transformed binary data of the custom link. Only available if a mapping was applied. |
|
| string | experimentalThe type of the custom link defines if a mapping of the |
|
| binary | experimentalAn incoming foreign link (cross-environment or cross-product). |
|
| string | experimentalAn incoming foreign link (cross-environment or cross-product). |
|
| string | experimentalThe direction of the span link to define the correct order between spans. |
|
| uid | experimentalUnique identifier for a Dynatrace link. | |
| boolean | experimental | |
| record | experimentalA collection of key-value pairs containing received response headers related to tracing from an outgoing call. There may be multiple values for each header. Used for cross-environment linking. |
|
dt.tracing.custom_link.type MUST be one of the following:
| Value | Description |
|---|---|
| The |
| The |
| The |
dt.tracing.link.direction MUST be one of the following:
| Value | Description |
|---|---|
| Indicates that the link represents an incoming call (the child in a parent-child relationship). |
| Indicates that the link represents an outgoing call (the parent in a parent-child relationship). |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental |
Endpoints define the public interface of services.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableThe endpoint name is derived from endpoint detection rules and uniquely identifies one endpoint of a particular service. Endpoint names are usually technology-specific and should be defined by attributes with low cardinality, like |
|
Fields that describe entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe entity name as defined by conditional naming rules. This name will be calculated based on a rules on the cluster side. |
|
| string | resource stableThe entity name as defined in the entity settings screen. This name is statically defined by the user for a particular entity. |
|
| string | resource stableThe entity name as detected by Dynatrace or defined by the data source of the entity. Depending on the entity type this can involve different heuristics. |
|
| string | resource stableAll entities have an entity.name field. The following fields will be considered in order to determine the value: |
|
| string | resource stableThe entity type. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
The error namespace contains general information on errors.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe code of the error. Set for iOS (NSError and Swift Error) and custom errors for C-based languages. |
|
| long | experimentalThe number of CSP rule violations. |
|
| string | experimentalA human-readable version of |
|
| long | experimentalThe number of exceptions that are observed, but which are not captured due to error capture limits. |
|
| long | experimentalThe total number of exceptions that are observed, including exceptions that are not captured. |
|
| long | experimentalThe number of HTTP request errors with a |
|
| long | experimentalThe number of HTTP request errors with a |
|
| long | experimentalThe number of HTTP request errors with a |
|
| uid | experimentalA unique identifier for error grouping. The |
|
| boolean | experimentalIf set to |
|
| string | experimentalThe error reason. |
|
| string | experimentalThe error source. |
|
| string | experimentalThe main error type. This information is determined by Dynatrace RUM error grouping. |
|
error.reason has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The request was aborted by the user. |
| The request failed due to a Content Security Policy (CSP) violation. |
| The request failed because of no connectivity. |
| The request timed out. |
error.source has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| console |
| document_request |
| exception |
| fetch |
| promise_rejection |
| xhr |
error.type MUST be one of the following:
| Value | Description |
|---|---|
| Application Not Responding (ANR) |
| Crash |
| Content Security Policy (CSP) violation |
| Exception |
| Custom reported error |
| Failed request |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the application that holds the workflows of the business logic. |
|
| string | resource experimentalThe name of the library that hosts commonly used workflows to be reused in applications. |
|
| string | resource experimentalThe name of the vendor of the ESB technology of the current workflow. |
|
| string | resource experimentalThe name of the workflow (the message flow for the IBM ESB). |
|
The event namespace contains common identification, categorization and context on events in Dynatrace.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableStandard categorization based on the significance of an event (similar to the severity level in the previous Dynatrace). |
|
| string | stableHuman-readable description of an event. |
|
| string | stableThe event end timestamp in UTC (given in Grail preferred Linux timestamp nano precision format). |
|
| string | experimentalGroup label of an event. |
|
| string | stableUnique identifier string of an event; is stable across multiple refreshes and updates. |
|
| string | stableGives high-level information about what kind of information the event contains without being specific about the contents of the event. It helps to determine the record type of a raw event.Tags: |
|
| string | stableThe human readable display name of an event type. |
|
| string | experimentalThe original raw data of the event as received from the source. |
|
| string | stableDenotes whether the event represents a success or a failure from the perspective of the entity that produced the event (for example an HTTP response code). |
|
| string | experimentalUnique identifier string of a parent event to link parent and child events. |
|
| string | stableSource of the event, for example, the name of the component or system that generated the event.Tags: |
|
| string | stableDescribes why a certain event.outcome was set. Typically, this is some form of error description in the case of a failure. |
|
| string | stableThe event start timestamp in UTC (given in Grail preferred Linux timestamp nano precision format). |
|
| string | stableStatus of an event as being either Active or Closed. |
|
| string | experimentalAn enum that shows the transition of the above event state. |
|
| string | stableThe unique type identifier of a given event.Tags: |
|
| string | stableDescribes the version of the event. |
|
Values are either in title-case or screaming snake case.
event.category SHOULD be one of the following:
| Value | Description |
|---|---|
| availability |
| error |
| slowdown |
| resource_contention |
| warning |
| info |
| vulnerability_management |
event.status SHOULD be one of the following:
| Value | Description |
|---|---|
| active |
| closed |
event.status_transition SHOULD be one of the following:
| Value | Description |
|---|---|
| created |
| updated |
| refreshed |
| resolved |
| recovered |
| closed |
| timed out |
| reopened |
Event properties are custom-defined key-value pairs. Dynatrace RUM captures event properties as part of each of your users' journeys to enrich user events.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| record | experimentalContains the value for the event property named |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | stableThe | |
| long | experimentalThe column number where the exception happened. |
|
| boolean | stable | |
| string | experimentalThe URI domain component. This is extracted from |
|
| string | experimentalThe full file location when the exception happened. This is either an absolute URL or a filename. |
|
| string | experimentalThe URI path component. This is extracted from |
|
| uid | stableThe identifier of an exception. It should be unique within a list of exceptions. The identifier is used to reference the exception. | |
| boolean | stableIs set to | |
| long | experimentalThe line number where the exception happened. |
|
| string | stableA message that describes the exception. |
|
| string | experimentalThe stack trace of the exception. The format depends on the technology and source. While OneAgent formats stack traces to unify them across technologies, stack traces from an OpenTelemetry source are in the format they were sent to Dynatrace. |
|
| string | stableThe type of the exception, for example its fully-qualified class name. |
|
Fields that can be expected from serverless functions or Function as a Service (FaaS) on various cloud platforms.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | resource experimentalThe amount of memory available to the serverless function in Bytes. | |
| string | resource experimentalThe name of the single function that this runtime instance executes. 1 |
|
| string | resource experimentalThe immutable version of the function being executed. 2 |
|
This is the name of the function as configured/deployed on the FaaS platform and is usually different from the name of the callback
function (which may be stored in the code.namespace/code.function span attributes).
Value of the field depends on a cloud provider. This field is not set for Azure.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | experimentalA boolean that is true if the serverless function is executed for the first time (aka cold-start). | |
| string | experimentalThe table/collection name on which the operation above was executed. 1 |
|
| string | experimentalThe identifier for the specific item that changed after executing the operation above. 2 |
|
| string | experimentalRelevant only for "datasource" trigger. The operation type which triggered the function invocation. |
|
| string | experimentalThe UTC ISO-8601 timestamp of the operation above. 3 |
|
| string | stableFaas event attribute, the |
|
| string | experimentalThe API action that triggered the faas event. 4 |
|
| string | experimentalThe cloud service that originated the event. |
|
| string | experimentalThe name of the invoked function. |
|
| string | experimentalThe cloud provider of the invoked function. Will be equal to the invoked function's |
|
| string | experimentalThe cloud region of the invoked function. 5 |
|
| string | experimentalType of the trigger which caused this function invocation. |
|
Relevant only for faas.trigger=datasource trigger
Relevant only for faas.trigger=datasource trigger
Relevant only for faas.trigger=datasource trigger
The value of this attribute is specific to the service that generated the event.
Will be equal to the invoked function's cloud.region resource attribute.
faas.document.operation has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| delete |
| edit |
| insert |
faas.invoked_provider has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Alibaba Cloud |
| Amazon Web Services |
| Microsoft Azure |
| Google Cloud Platform |
| Tencent Cloud |
faas.trigger has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| A response to some data source operation such as a database or filesystem read/write. |
| To provide an answer to an inbound HTTP request |
| If none of the others apply |
| A function is set to be executed when messages are sent to a messaging system. |
| A function is scheduled to be executed regularly. |
Fields that can be expected for a failure detection on a Dynatrace span. For more details and how failure detection is embedded in a span, see Dynatrace Span model.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalThe |
|
| uid | experimentalThe |
|
| uid | experimentalThe |
|
| uid | experimentalThe |
|
| record[] | experimentalA collection of individual failure detection reasons and verdicts for each applied matching rule. If no entries exist, no rules matched, and the attribute does not exist. | |
| uid | experimentalThe |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe unique identifier of the feature flag. |
|
| string | experimentalThe name of the service provider that performs the flag evaluation. |
|
| string | experimentalSHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. 1 |
|
A semantic identifier, commonly referred to as a variant, provides a means
for referring to a value without including the value itself. This can
provide additional context for understanding the meaning behind a value.
For example, the variant red maybe be used for the value #c05543.
A stringified version of the value can be used in situations where a semantic identifier is unavailable. The implementer should determine the string representation of the value.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimentalA permanent identifier that is unique within your Google Cloud project. |
|
| string | resource experimentalThe name to display for the instance in the Cloud Console. |
|
| string | resource stableRegion or zone the instance of the GCP resource is running on.Tags: |
|
| string | resource experimentalUnique, immutable identifier assigned to an organization resource. |
|
| string | resource experimentalName assigned to the GCP organization. |
|
| string | resource stableThe identifier of the GCP project associated with this resource.Tags: |
|
| string | resource experimentalA region is a specific geographical location where you can host your resources. |
|
| string | resource experimentalThe globally unique resource name in Google Cloud Platform convention. |
|
| string | resource experimentalThe name of a resource type. |
|
| string | resource experimentalA zone is a subset of a region. Each region has three or more zones. |
|
The geo namespace contains geo location information. This section only holds all currently agreed upon fields in the Dynatrace Semantic Dictionary. Aligned closely to the ECS, with some adaptions around field groupings
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableEnglish name of the city. |
|
| string | resource stableEnglish name of the continent. |
|
| string | resource experimentalThe two-letter country code. The format complies with ISO 3316-1 alpha-2. |
|
| string | resource stableEnglish name of the country. |
|
| double | resource experimentalThe approximate latitude. The format complies with WGS 84. |
|
| double | resource experimentalThe approximate longitude. The format complies with WGS 84. |
|
| string | resource stableEnglish name of the region. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the domain this instance belongs to. | |
| string | resource experimentalThe instance's name. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
Fields describing a host.
Dynatrace aims to use the best fitting name for the field host.name. See below, how Dynatrace determines the host name in an ordered by precedence fashion:
Dynatrace supports customizing the host.name property. A custom set host name takes precedence over the auto detection mechanisms described further down.
oneagentctl tool can be used to set a custom host name. See Documentation for details.If no customized name is set locally, the OneAgent attempts to determine if we're deployed by Dynatrace Operator in Kubernetes or OpenShift and sets host.name to the name of the Node.
If the Kubernetes isn't present, the OneAgent attempts to determine the host.name value by accessing cloud metadata where applicable.
name (case insensitive) is found, the tag's value is used as the host.name.name (case insensitive) instance metadata property is used. See Microsoft Azure documentationhostname instance metadata property is used. See Google Cloud documentation.gethostname() if it can be interpreted as a fully qualified domain name (FQDN) and doesn't contain "localhost".getaddrinfo() for port 80 is issued, again sanity checking whether the returned name is an FQDN and doesn't contain "localhost".gethostname() was successful, and the returned string is not empty and doesn't contain "localhost", then it's used.EmptyHostName if neither property can be resolved.GetComputerNameExA is used to determine a host's name. In particular, the resulting name is composed of <hostname>.<domainname> with the following details
hostname = ComputerNameDnsHostname retrieved by GetComputerNameExdomainname = ComputerNameDnsDomain retrieved by GetComputerNameExGetComputerNameExA is used when it can be interpreted as a fully qualified domain name (FQDN).GetComputerNameExA is used when it's not empty.EmptyHostName if neither property can be resolved.| Attribute | Type | Description | Examples |
|---|---|---|---|
| string[] | resource experimentalA list of FQDNs of this host. |
|
| ipAddress[] | resource experimentalA list of IP adresses (IPv4 or IPv6) of this host. |
|
| long | resource experimentalLogical CPU cores on the monitored host. |
|
| long | resource experimentalLogical CPUs on the monitored host. Applies to AIX LPARs. |
|
| array | resource experimentalA list of MAC adresses associated with this host. |
|
| string | resource experimentalThe host name as determined on the data source (for instance, OneAgent, extensions or OpenTelemetry).Important: This is not the name of the host entity, which can be modified based on naming rules.Tags: |
|
| long | resource experimentalPhysical memory of the monitored host, expressed in bytes. The value might be different than the total available memory, if features such as Active Memory Expansion are used. |
|
| long | resource experimentalNumber of threads for AIX Simultaneous Multithreading feature. |
|
| long | resource experimentalNumber of virtual CPUs for AIX LPAR. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | stableThe size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. |
|
| string | stableHTTP request headers, |
|
| string | experimentalString that uniquely identifies a request. |
|
| string | stableHTTP request method. |
|
| string | stableHTTP request parameters, |
|
| long | experimentalThe total size of the request in bytes. This value should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any. |
|
| long | stableThe size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. |
|
| string | stableHTTP response headers, |
|
| long | experimentalWhen the response contains the HTTP Content-Range header, this field contains the range end value. |
|
| long | experimentalWhen the response contains the HTTP Content-Range header, this field contains the range start value. |
|
| string | experimentalThe HTTP reason phrase (HTTP1 only). |
|
| long | experimentalThe total size of the response in bytes. This value should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any. |
|
| long | stableHTTP response status code. |
|
| double | experimentalTime between the browser requesting a page and when it receives the first byte of information from the server. |
|
| string | stableThe matched route (path template in the format used by the respective server framework). |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe server name as configured by the webserver if available. If no such name exists, this is the local hostname and bound port. In Kubernetes, the base pod name is used. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental |
|
| string | resource experimental |
|
| string | resource experimental |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the integration node (broker) that manages one or more integration servers. |
|
| string | resource experimentalThe name of the broker-managed or standalone integration server (formerly known as execution group or dataflow engine). |
|
| string | resource experimental | |
| string | resource experimentalThe name of the CICS program. |
|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe instance's home directory. | |
| string | resource experimentalThe instance's operating mode. |
|
| string | resource experimentalThe instance's server name. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableThe name of the JDBC connection pool. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalA unit is a systemd object that performs or controls a particular task or action; concerns unix-based systems |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stable(Optional) The user-defined name of the cluster in Dynatrace. Doesn't need to be unique or immutable.Tags: |
|
| string | resource stableA pseudo-ID for the cluster, by default set to the UID of the kube-system namespace. |
|
| string | resource stableThe name of the container from the pod specification; must be unique within a pod. Container runtime usually uses different globally unique name ( |
|
| string | resource stableThe name of the namespace that the pod is running in.Tags: |
|
| string | resource experimentalThe UID of the namespace. |
|
| string | resource stableName of the node. |
|
| string | resource stableThe name of the pod. |
|
| string | resource stableThe UID of the pod. |
|
| string | resource stableThe name of the Kubernetes service. |
|
| string | resource stableThe type of the workload. |
|
| string | resource stableThe name of the workload. |
|
| string | resource experimentalThe UID of the workload. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalKubernetes namespace annotation that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
| string | resource experimentalKubernetes namespace label that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
| string | resource experimentalKubernetes pod annotation that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
| string | resource experimentalKubernetes pod label that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
| string | resource experimentalKubernetes workload annotation that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
| string | resource experimentalKubernetes workload label that should be enriched on ingest signals and service metrics. The attribute_name is a placeholder that can freely be chosen. |
|
Fields relevant for log events
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe basename of the file. |
|
| string | experimentalThe full path to the file. |
|
| string | stableThe I/O stream to which the log was emitted. |
|
| string | experimentalThe name of the logger inside an application. This name is usually the name of the class that initialized the logger, but it can be a custom name. |
|
| string | experimentalThe original severity level of the log entry as recorded by the source, before standardization into the log.level format. 1 |
|
| string | stableHuman-readable attribute that identifies a log stream. 2Tags: |
|
| string | stableThe log source origin indicates where the log derives from. |
|
| string | stableThe log event severity level. |
|
The log.raw_level can vary in type depending on the log entry. It may be represented as a string in some cases or as an integer (for example, 30, 40, 50) in others.
Can contain, for example, a file path, standard output, or an URI etc., depending on the log stream type. The value should be stable for one logical source (for example, not affected by log file rotation digits).
log.iostream MUST be one of the following:
| Value | Description |
|---|---|
| std_err |
| std_out |
log.source.origin MUST be one of the following:
| Value | Description |
|---|---|
| Container log detector. |
| Custom log source configuration. |
| IIS log detector. |
| Journald log detector. |
| Open log file detector. |
| System log detector. |
loglevel MUST be one of the following:
| Value | Description |
|---|---|
| alert |
| critical |
| debug |
| emergency |
| error |
| fatal |
| info |
| none |
| notice |
| severe |
| trace |
| warn |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of messages sent, received, or processed in the scope of the batching operation. |
|
| string | experimentalA unique identifier for the client that consumes or produces a message. |
|
| string | experimentalThe name of the consumer group with which a consumer is associated. |
|
| string | experimentalThe kind of message destination |
|
| string | experimentalThe destination's manager name 1 |
|
| string | experimentalThe message destination name 2 |
|
| string | experimentalString representation of the partition ID the message is sent to or received from. |
|
| boolean | experimentalA boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | |
| long | experimentalThe (uncompressed) size of the message payload in bytes. |
|
| string | experimentalThe conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". |
|
| record | experimentalThe message headers, |
|
| string | experimentalA value used by the messaging system as an identifier for the message, represented as a string. |
|
| string | experimentalA string identifying the kind of messaging operation. 3 |
|
| string | experimentalThe kind of message source |
|
| string | experimentalThe source's manager name 4 |
|
| string | experimentalThe message source name 5 |
|
| boolean | experimentalA boolean that is true if the message source is temporary and might not exist anymore after messages are processed. | |
| string | experimentalAn identifier for the messaging system. See below for a list of well-known identifiers. |
|
Manager name SHOULD uniquely identify the broker.
Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker.
If a custom value is used for messaging.operation.type, it MUST be of low cardinality.
Manager name SHOULD uniquely identify the broker.
Source name SHOULD uniquely identify a specific queue, topic, or other entity within the broker.
messaging.destination.kind MUST be one of the following:
| Value | Description |
|---|---|
| A message sent to a queue |
| A message sent to a topic |
messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| A message is received from a destination by a message consumer/server but left there. |
| A message previously received from a destination is processed by a message consumer/server. |
| A message is sent to a destination by a message producer/client. |
| A message is received from a destination by a message consumer/server. |
messaging.source.kind MUST be one of the following:
| Value | Description |
|---|---|
| A message received from a queue |
| A message received from a topic |
messaging.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| ActiveMQ |
| ActiveMQ Artemis |
| Amazon EventBridge |
| Amazon Simple Notification Service (SNS) |
| Amazon Simple Queue Service (SQS) |
| Azure Event Grid |
| Azure Event Hubs |
| Azure Service Bus |
| Google Cloud Pub/Sub |
| HornetQ |
| Java Message Service |
| Apache Kafka |
| IBM MQ |
| MSMQ |
| RabbitMQ |
| Apache RocketMQ |
| Software AG, webMethods Integration Server |
| Tibco EMS |
| Oracle WebLogic |
| IBM WebSphere Application Server |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalName of the top-level actor. See The Akka actor hierarchy |
|
| string | experimentalPath to actor inside actor system. |
|
| string | experimentalName of the actor system. |
|
| string | experimentalFully qualified type name of actor. |
|
| string | experimentalFully qualified type name of the message. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe |
|
| boolean | experimentalA boolean that is true if the message is a tombstone. 1 |
|
| long | experimentalThe offset of the message. |
|
If the message is a tombstone, the value is true. When missing, the value is assumed to be false.
In webserver technologies a multitude of modules might be contributing to handling a single web request. Module insights provides timings for these, where available.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| record | experimentalModules executed as part of this web request, represented as map from module name to duration in nanoseconds spent. |
|
These attributes may be used for any network related operation.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe mobile carrier name. |
|
| string | experimentalFurther details that specify |
|
| string | experimentalThe internet connection type. |
|
| string | stableOSI Application Layer or non-OSI equivalent. |
|
| string | experimentalVersion of the application layer protocol used. |
|
| string | stableOSI Transport Layer or Inter-process Communication method |
|
| string | stableOSI Network Layer or non-OSI equivalent. |
|
network.connection.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| cell |
| unavailable |
| unknown |
| wifi |
| wired |
network.transport has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| In-process communication. 1 |
| Something else (non-IP-based). |
| Named or anonymous pipe. |
| TCP |
| UDP |
| Unix domain socket. |
Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would typically be expected. Usually, all other network attributes can be left out.
network.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| IPv4 |
| IPv6 |
Fields that are used in extensions to describe network devices.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource deprecatedUsed in Extension Framework 2.0Address (IP address with port) used by a monitored device to communicate with an extension. |
|
| ipAddress | resource deprecatedUsed in Extension Framework 2.0IP address used by a monitored device to communicate with an extension. |
|
| string | resource deprecatedUsed in Extension Framework 2.0Name of a device monitored by an extension. |
|
| string | resource deprecatedUsed in Extension Framework 2.0Port used by a monitored device to communicate with an extension. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental |
Fields that can come from applications running on OpenStack.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalA specific availability zone in the given OpenStack region. |
|
| string | resource experimentalUUID of specific OpenStack instance. |
|
The origin of a request associated with this event.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalSource IP address of the request associated with this event if not of 'LOCAL' type. |
|
| string | experimentalThe ID of the browser session (if present) associated with the event. |
|
| string | experimentalOrigin type of the request associated with this event. |
|
| string | experimentalThe verbatim value of the X-Forwarded-For HTTP request header (if present) of the request associated with the event. |
|
origin.type MUST be one of the following:
| Value | Description |
|---|---|
| The event provider issued the request locally. |
| The event provider received an external REST API call. |
The os namespace contains information on the operating system running an application.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalArchitecture of the CPU, discovered from the operating system. |
|
| string | resource stableThe OS name in a short, human-readable format. |
|
| string | resource experimentalType of discovered operating system. |
|
| string | resource stableThe complete OS version, including patch, build, and other information. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe name of the instrumentation scope - ( |
|
| string | experimentalThe version of the instrumentation scope - ( |
|
The page namespace contains information on the web page of an event.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| duration | experimentalThe aggregated time that the page was in the background. |
|
| string | experimentalThe name RUM JavaScript detected for the page. The value is based on |
|
| duration | experimentalThe aggregated time that the page was in the foreground. |
|
| uid | experimentalA random ID that is generated every time a user navigates to a new page. The |
|
| string | experimentalAn identifier for grouping pages. The value is automatically calculated by Dynatrace from |
|
| duration | experimentalThe aggregated time that the page was prerendering. |
|
| string | experimentalThe URI host component of the source page URL. This is extracted from |
|
| string | experimentalThe URI fragment component of the source page URL. This is extracted from |
|
| string | experimentalThe page URL of the previous page, provided in the format |
|
| string | experimentalThe URI path component of the source page URL. This is extracted from |
|
| string | experimentalThe URI query component of the source page URL. This is extracted from |
|
| string | experimentalThe URI scheme component of the source page URL. This is extracted from |
|
| string | experimentalThe HTML DOM |
|
| string | experimentalThe URI host component of the page URL. This is extracted from |
|
| string | experimentalThe URI fragment component of the page URL. This is extracted from |
|
| string | experimentalThe page URL, provided in the format |
|
| string | experimentalThe URI path component of the page URL. This is extracted from |
|
| string | experimentalThe URI query component of the page URL. This is extracted from |
|
| string | experimentalThe URI scheme component of the page URL. This is extracted from |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimentalalso see https://developer.wordpress.org/reference/functions/get_bloginfo/ |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalA unique ID to identify a PostgreSQL database session. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe architecture of the monitored entity in terms of how many bits compose a basic value. |
|
| boolean | resource experimentalTrue if given process is running inside container. | |
| string | resource experimentalThe name of the process executable. On Linux based systems, can be set to the |
|
| string | resource experimentalThe full path to the process executable. On Linux-based systems, can be set to the target of |
|
| array | resource experimentalAn array of open listen ports. |
|
| record | resource experimentalIt contains a diagnostic collection of input parameters that were used or could have been used in assigning processes to the process entity. |
|
| long | resource experimentalProcess Identifier (PID) as observed by the monitored process. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of arguments the |
|
| string | experimentalThe name of the RabbitMQ function within the |
|
| string | experimentalThe name of the RabbitMQ module that generated the log entry. |
|
| string | experimentalID of the Erlang process. |
|
The react_native namespace contains information on React Native details of an event.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the React Native bundle. |
|
| string | resource experimentalThe version of the React Native bundle. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe role of the Redis process (for example, 'M' for Master or 'X' for sentinel). |
|
redis.role MUST be one of the following:
| Value | Description |
|---|---|
| Child process for persistence (RDB/AOF). |
| Master Redis process. |
| Replica Redis process. |
| Sentinel monitoring process. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | experimentalIndicates that the request is considered failed according to the failure detection rules. Only present on the request root span. | |
| boolean | experimentalMarks the root of a request. It's the first span and starts the request within a service. |
Request scoped attributes (e.g. method parameters, return values, class names, …) captured by the OneAgent based on a request attribute definition. The actual name of the attribute is the prefix "request_attribute" plus the "request attribute name" defined in the request attributes configuration. Request attributes are built based on captured attributes and other attributes like HTTP header values or "normal" span attributes, on which the aggregations (first/last value, distinct values, ...), type conversion and normalizations defined in the request attribute configuration are performed. They are evaluated for an entire request (possibly consisting of multiple spans) and are stored only on the request root node.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| array | stableContains the request scoped reconciled values of the attribute named |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe name of the (logical) method being called 1 |
|
| string | experimentalThe namespace of the method being called. In SOAP, it would be the XML namespace. |
|
| string | experimentalThe full (logical) name of the service being called, including its package name, if applicable. 2 |
|
| string | experimentalA string identifying the remoting system or framework. See below for a list of well-known identifiers. |
|
This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function attribute may be used to store the latter (e.g., method executing the call on the server side, RPC client stub method on the client side).
This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name, e.g., class with method executing actually executing the call on the server side, RPC client stub class on the client side).
rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Apache Axis |
| Apache CXF |
| Apache Wink |
| AWS API |
| .NET Remoting |
| .NET WCF |
| gRPC |
| Java RMI |
| JAX-WS |
| JBoss |
| Jersey |
| Progress OpenEdge |
| JBoss RESTEasy |
| Restlet |
| Spring Web Services |
| Tibco Web Services |
| WebLogic Web Services |
| Webmethods |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe numeric status code of the gRPC request. |
The server namespace contains information on the responder of a network connection.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableLogical server hostname, matches server FQDN if available, and IP or socket address if FQDN is not known. |
|
| long | stableLogical server port number. |
|
| ipAddress[] | stableA list of IP addresses that are the result of DNS resolution of |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableThe logical name of the service. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalalso see https://docs.oracle.com/javaee/6/api/javax/servlet/ServletContext.html#getServletContextName | |
| string | resource experimentalalso see https://docs.oracle.com/javaee/6/api/javax/servlet/ServletContext.html#getContextPath |
Session properties are custom-defined key-value pairs. Dynatrace RUM captures session properties as part of each of your users' journeys to enrich user sessions.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| record | experimentalContains the value for the session property named |
|
Fields that are used in SNMP extensions.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource deprecatedUsed in Extension Framework 2.0The trap OID of a given event. |
|
| string | resource deprecatedUsed in Extension Framework 2.0The SNMP version. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalThe alternative |
|
| record[] | stableA collection of events. An event is an optional time-stamped annotation of the span and consists of a name and key-value pairs. | |
| uid | stableThe | |
| uid | stableA unique identifier for a span within a trace. The |
|
| boolean | stableSet to | |
| boolean | experimentalIf set to | |
| string | stableDistinguishes between spans generated in a particular context. |
|
| record[] | stableA collection of links. A link is a reference from this span to a whole trace or a span in the same or different trace. | |
| string | stableThe span name identifies the work represented by the span, for example, the route in an HTTP controller, an RPC method name, a function name, or the name of a subtask or stage within a larger computation. |
|
| uid | stableThe |
|
| string | stableDefines the status of a span, predominantly used to indicate a processing error. This field is absent if the reported span status is |
|
| string | experimentalAn optional text that can provide a descriptive error message in case the |
|
| duration | stableThe overall CPU time spent executing the span, including the CPU times of child spans that are running on the same thread on the same call stack. | |
| duration | stableThe CPU time spent exclusively on executing this span, not including the CPU times of any children. |
span.kind MUST be one of the following:
| Value | Description |
|---|---|
| Indicates that the span describes a request to some remote service. |
| Indicates that a span describes a child of an asynchronous |
| Default Value. Indicates that the span represents an internal operation. |
| Indicates that the span describes a Dynatrace link node. |
| Indicates that the span describes the initiator of an asynchronous request. |
| Indicates that the span covers server-side handling of a synchronous RPC or other remote request. |
span.status_code MUST be one of the following:
| Value | Description |
|---|---|
| An error happened while processing the span. |
| The span was explicitly validated as having completed successfully, despite maybe even containing information about an error. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableSome span events have a defined semantics based on the name of the span event. |
|
span_event.name has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| Indicates that the span event represents a business event |
| Indicates that the span event represents an exception |
| Indicates that the span event represents a feature flag |
Language Independent Interface Types For OpenTelemetry
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalAlso see Common Application Properties | |
| string | resource experimentalAlso see Common Application Properties | |
| string | resource experimentalThe active profile (last value of spring.profiles.active) | |
| string | resource experimental |
Disk
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | resource stableIs encrypted disk. | |
| string | resource stableType of file system on the disk. |
|
| string | resource stableKernel name of the disk device. It's also the disk ID in relation to other devices. |
|
| string | resource stableDisk model. |
|
| string | resource stablePrimary mount point. |
|
| string[] | resource stableList of other mount points of the disk |
|
| string | resource stablePath to the disk. |
|
| boolean | resource stableIs read-only disk. | |
| boolean | resource stableIs removable disk. | |
| string | resource stableDisk serial number. |
|
| string | resource stableDisk device type. |
|
| string | resource stableVendor of the disk. |
|
Partition
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | resource stableIs encrypted partition. | |
| string | resource stableType of file system on the partition. |
|
| string | resource stableKernel name of the partition device. It's also the partition ID in relation to other devices. |
|
| string | resource stablePrimary mount point. |
|
| string[] | resource stableList of other mount points of the partition. |
|
| string | resource stablePath to the partition. |
|
| boolean | resource stableIs read-only partition. | |
| boolean | resource stableIs removable partition (true when disk is removable). | |
| string | resource stablePartition device type. |
|
Volume
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource stableName of the volume device. |
|
| string | resource stableType of file system on the volume. |
|
| string | resource stableKernel name of the volume device. It's also the volume ID in relation to other devices. |
|
| string | resource stablePrimary mount point. |
|
| string[] | resource stableList of other mount points of the software RAID. |
|
| string | resource stablePath to the volume device. |
|
| boolean | resource stableIs read-only volume. | |
| boolean | resource stableIs removable volume. | |
| string | resource stableVolume device type. |
|
Software RAID
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | resource stableIs encrypted software RAID. | |
| string | resource stableType of file system on the software RAID, |
|
| string | resource stableKernel name of the software RAID device. It's also the software RAID ID in relation to other devices. |
|
| string | resource stablePrimary mount point. |
|
| string[] | resource stableList of other mount points of the software RAID. |
|
| string | resource stableID of parent software RAID in which this software RAID is nested. |
|
| string | resource stablePath to the software RAID device. |
|
| boolean | resource stableIs read-only software RAID. | |
| boolean | resource stableIs removable software RAID. | |
| string | resource stableSoftware RAID device type. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalPresent on every span of a subtrace. All spans within one subtrace share the same identifier. The ID is a hex-encoded numerical value and not globally unique, but guaranteed to be unique within one particular trace. |
|
| boolean | experimentalMarks the root of a subtrace. This is typically the first span of a request within a service. Endpoints detection rules are evaluated on subtrace root spans. |
Additional information about the attributes of a data point.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe denominator of the sampling ratio of the Dynatrace cluster, the attribute is only set if Adaptive Load Redution (ALR) is active on the Dynatrace cluster. A numerator is not specified, as it's always 1. If, for example, the Dynatrace cluster samples with a probability of 1/8 (12,5%), the value of |
|
| long | experimentalThe denominator of the sampling ratio of an Adaptive Traffic Management (ATM) aware sampler. The attribute is always present if an ATM-aware sampler is active (this applies, for example, to Dynatrace OneAgent). A numerator is not specified, as it is always 1. If, for example, Dynatrace OneAgent samples with a probability of 1/16 (6,25%), the value of |
|
| uid | experimentalThe ID of a custom service configuration rule. This field is only present if a custom service was configured as an automatic instrumentation rule in Dynatrace. |
|
| long | experimentalThe number of attributes that were discarded on the source. Attributes can be discarded because their keys are too long or because there are too many attributes. |
|
| long | experimentalThe number of span events that were discarded on the source. |
|
| long | experimentalThe number of |
|
| long | experimentalThe number of |
|
| long | experimentalThe number of span links that were discarded on the source. |
|
| string[] | experimentalA string array of one or multiple error codes indicating issues in the assembly of a trace in Dynatrace. Typically, issues come from erroneous (3rd party) instrumentations (e.g. not sending a required field), data loss due to network connectivity (e.g. missing parent span) or conditions implied by the nature of the trace (e.g. trace exceeding the depth limit). The attribute is only present in case an assembly issue was detected (the list will not be empty). For more information and details about specific error codes, please reach out to Dynatrace support. |
|
| string[] | experimentalA string array of attribute keys that were not stored as they were not allow-listed or were removed during the pipeline steps. |
|
| timestamp | experimentalThe original start time of the span. Only available if the value of the |
|
| long | experimentalThe id of the Dynatrace cluster node this span was addressed to. This is only available if it differs from the value of |
|
| long | experimentalThe id of the Dynatrace cluster node that received and processed this span. |
|
Span sensor rules used during ingestion of OpenTelemetry/OpenTracing spans by instrumentation of the OpenTelemetry/OpenTracing Apis are applied at span start time. Therefore these rules can only operate on span attributes given at span start time.
The value at span start time of attributes captured by this instrumentation is preserved to allow proper rule configuration.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| record | experimentalSpan attributes set at span start time in case it changed later. The value at span start is relevant for span rule evaluation done by OpenTelemetry/OpenTracing instrumentation. |
|
| array | experimentalList of attribute names set at span start invocation time. | |
| string | experimentalThe span name at span start time in case it changed later. The value at span start is relevant for span rule evaluation done by OpenTelemetry/OpenTracing instrumentation. |
|
The telemetry.sdk.* fields are used to describe the telemetry SDK in OpenTelemetry or ODIN ingest. It can be considered the closest equivalent of ODIN/OTel data to dt.agent.module.*.
The telemetry.exporter.* fields are used to define the exporter that exports telemetry data and is expected to be different for each exporter in case when multiple exporters co-exist.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe exporter name. |
|
| string | resource experimentalThe version as exposed to the package manager (for example, npm). |
|
| string | resource experimentalThe full agent/exporter version. |
|
| string | resource stableThe programming language/tech of the telemetry SDK. |
|
| string | resource stableThe name of the telemetry SDK. |
|
| string | resource stableThe version string of the telemetry SDK. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | stableCurrent "managed" thread id (as opposed to OS thread id). |
|
| string | stableCurrent thread name. |
|
| string | stableThe name of the thread pool. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental | |
| string | resource experimental |
The time_correction namespace contains information on time corrections applied to the timestamps of an event, for example, start_time, timestamp or event.end.
Time corrections may be necessary if events are reported with timestamps that are completely off compared to cluster time. For example, Dynatrace RUM reported data can be off depending on client time.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| boolean | experimentalIf set to |
|
| long | experimentalThe offset (in nanoseconds) that is applied to all timestamp fields. The value may be negative. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalString indicating the cipher used during the current connection. |
|
| string | experimentalNormalized lowercase protocol name parsed from the original string of the negotiated SSL/TLS protocol version. |
|
| string | experimentalThe numeric part of the version parsed from the original string of the negotiated SSL/TLS protocol version. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| uid | experimentalThe preserved trace ID when OneAgent and other tracing systems monitor the same process and the trace ID from the other tracing system was replaced by the OneAgent trace ID. The |
|
| uid | stableA unique identifier for a trace. The |
|
| boolean | experimentalFlag indicating whether the trace was sampled out. | |
| string | experimentalThe trace state in the w3c-trace-context format. |
|
The url namespace contains semantic conventions for URL and its components.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe URI domain component. |
|
| string | stableThe URI fragment component. |
|
| string | stableAbsolute URL describing a network resource according to RFC3986.Tags: |
|
| string | stableThe URI path component. |
|
| long | experimentalThe URI port component. |
|
| string | experimentalThe provider type for the host name of |
|
| string | stableThe URI query component.Tags: |
|
| string | stableThe URI scheme component identifying the used protocol. |
|
| string | experimentalTruncated URI path component for endpoint detection of certain technologies that do not provide a |
|
url.provider MUST be one of the following:
| Value | Description |
|---|---|
| CDN (content delivery network). |
| First-party provider. |
| Third-party provider. |
Representation of a physical or logical user.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableEmail of the user. |
|
| string | stableUnique UUID of a human user. If the system itself has to be represented, the constant 'system' is used. |
|
| string | experimentalFull name of the user. If the system itself has to be represented, the constant 'System' is used. |
|
| string | experimentalOrganization the user belongs to. |
|
user.organization MUST be one of the following:
| Value | Description |
|---|---|
| Customer organization |
| Dynatrace organization |
| Dynatrace partner organization |
user.organization MUST be one of the following:
| Value | Description |
|---|---|
| Dynatrace organization |
| Customer organization |
| Dynatrace partner organization |
The vcs namespace contains information about Version Control Systems.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe identifier of the change, for example, pull request ID or merge request ID. It is typically unique per repository and generated by the version control system itself. |
|
| string | experimentalThe state of the change, for example, the state of a pull request or merge request. |
|
| string | experimentalThe human-readable title of the change, for example, pull request title or merge request title. |
|
| string | experimentalThe full URL to the change, for example, the full URL to the pull request or merge request. |
|
| string | experimentalThe type of line change being measured on a branch or change. |
|
| string | experimentalThe name of the reference in the repository. This can be a branch name or a tag name. 1 |
|
| string | experimentalThe revision in the repository. For Git this is a synonym for a commit hash, whereas in SVN it is a revision number. 2 |
|
| string | experimentalThe reference type in the repository. 3 |
|
| string | experimentalThe name of the reference in the repository. This can be a branch name or a tag name. 4 |
|
| string | experimentalThe revision in the repository. For Git, this is a synonym for a commit hash, whereas in SVN, it is a revision number. 5 |
|
| string | experimentalThe reference type in the repository. 6 |
|
| string | experimentalThe reference type in the repository. |
|
| string | experimentalThe human-readable name of the repository. It should not include any additional identifiers like GitLab group or GitHub organization. 7 |
|
| string | experimentalThe repository's full URL. 8 |
|
| string | experimentalThe type of revision comparison. |
|
The base name refers to the starting point of a change. For example, if a feature branch was created from main,
main is the base reference of type branch.
The base revision refers to the starting revision of a change. For example, if a branch was created from a certain commit, this commit is the base revision.
The base type refers to the reference type of the starting point of a change. For example,
if a feature branch was created from the main branch, branch is the base reference's type.
The head name refers to the current reference's name. For example,
if main is currently checked out, the head name is main.
The head revision refers to the currently referenced revision.
The head type refers to the currently referenced type in the repository. For example,
if the main branch is currently checked out, the head reference is of type branch.
Be aware that the repository name might clash with forked repositories.
For Git VCS, this should not include the .git URL suffix.
vcs.change.state has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The change was closed without being merged into the target code base. |
| The change has successfully been merged into the target code base. |
| The change is open and ready for review or currently under review. It has not been merged yet, and changes are still possible. |
| The change was re-opened after being |
| The change is still a work in progress and not yet ready for review. |
vcs.line_change.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| How many lines were added. |
| How many lines were removed. |
vcs.ref.base.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The base reference type is a branch. |
| The base reference type is a tag. |
vcs.ref.head.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The head reference type is a branch. |
| The head reference type is a tag. |
vcs.ref.type has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| The reference type is a branch. |
| The reference type is a tag. |
vcs.revision_delta.direction has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| How many revisions the change is ahead of the target ref. |
| How many revisions the change is behind of the target ref. |
The view namespace contains information on the view of a user event.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| duration | experimentalAggregated time that the view was in the background. |
|
| string | experimentalThe name RUM JavaScript detected for the view. The value is based on |
|
| duration | experimentalAggregated time that the view was in the foreground. |
|
| uid | experimentalA random ID that is generated every time a user navigates to a new view. The |
|
| string | experimentalAn identifier for grouping views. The value can be reported via Dynatrace API. If not reported via Dynatrace API, the value is automatically calculated from |
|
| duration | experimentalAggregated time that the view was prerendering. |
|
| long | experimentalThe number of views throughout the page's entire lifespan. |
|
| string | experimentalThe |
|
| uid | experimentalThe ID of the previous view. Not supported by OneAgent for Mobile. |
|
| string | experimentalThe |
|
| string | experimentalThe URI host component of the source view URL. This is extracted from |
|
| string | experimentalThe URI fragment component of the source view URL. This is extracted from |
|
| string | experimentalThe |
|
| string | experimentalThe URI path component of the source view URL. This is extracted from |
|
| string | experimentalThe URI query component of the source view URL. This is extracted from |
|
| string | experimentalThe URI scheme component of the source view URL. This is extracted from |
|
| string | experimentalThe URI host component of the view URL. This is extracted from |
|
| string | experimentalThe URI fragment component of the view URL. This is extracted from |
|
| string | experimentalThe |
|
| string | experimentalThe URI path component of the view URL. This is extracted from |
|
| string | experimentalThe URI query component of the view URL. This is extracted from |
|
| string | experimentalThe URI scheme component of the view URL. This is extracted from |
|
Fields that can come from applications running on VMware.
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the data center in which the hypervisor is running. |
|
| string | resource experimentalESXi host disk. |
|
| string | resource experimentalESXi host. |
|
| string | resource experimentalESXi host network interface. |
|
| string | resource experimentalName of the VMware vCenter server managing the multi-hypervisor environment. |
|
| string | resource experimentalThe name of the virtual machine. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | stableName of the code location where the code-level vulnerability was detected. |
|
| double | stableVulnerability's CVSS base score provided by NVD. |
|
| string | stableVulnerability's CVSS score version. |
|
| string | stableAvailability of the information based on which the vulnerability assessment has been done. |
|
| string[] | experimentalReasons for the assessment mode. |
|
| string | stableVulnerability's reachability of related data assets by affected entities. |
|
| string | stableVulnerability's public exploits status. |
|
| string | stableVulnerability's internet exposure status. |
|
| string | stableVulnerability's risk level based on Davis Security Score. |
|
| double | stableVulnerability's Davis Security Score (1-10) calculated by Dynatrace. |
|
| string | stableUsage status of the vulnerable functions causing the vulnerability. |
|
| string | stableDescription of the vulnerability. |
|
| string | stableDynatrace user-readable identifier for the vulnerability. |
|
| string | experimentalWhether there is a known exploit for the vulnerability. |
|
| string | stableExternal provider's unique identifier for the vulnerability. |
|
| string | stableExternal provider's URL to the details page of the vulnerability. |
|
| timestamp | stableTimestamp of when the vulnerability was first detected. |
|
| string | stableDynatrace unique identifier for the vulnerability. |
|
| boolean | experimentalIndicates if a vulnerability fix is available. | |
| timestamp | stableTimestamp of the vulnerability's last muted or unmuted action. |
|
| string | experimentalComment when muting or unmuting the vulnerability. |
|
| string | stableReason for muting or unmuting the vulnerability. |
|
| string | stableVulnerability's mute status. |
|
| string | stableUser who last changed the vulnerability's mute status. |
|
| string | stableAvailability of the information based on which the vulnerability assessment has been done. |
|
| string | stableVulnerability's reachability of related data assets by affected entities. |
|
| string | stableVulnerability's internet exposure status. |
|
| string | stableVulnerability's Davis Security Score level. |
|
| double | stableVulnerability's Davis Security Score (1-10) calculated by Dynatrace. |
|
| string | stableUsage status of vulnerable functions causing the vulnerability. Status is |
|
| string | stableTimestamp of when the vulnerability was first detected. |
|
| timestamp | stableTimestamp of the last mute or unmute action of the vulnerability. |
|
| string | stableReason for muting or unmuting the vulnerability. |
|
| string | stableVulnerability's mute status. |
|
| string | stableUser who last changed the vulnerability's mute status. |
|
| string | stableTimestamp of the vulnerability's last resolution status change. |
|
| string | stableCurrent status of the vulnerability. |
|
| string | stableVulnerability's risk score level defined by the provider. For Dynatrace, the Davis Security Score level. |
|
| double | stableVulnerability's risk score defined by the provider. For Dynatrace, Davis Security Score. |
|
| double | stableVulnerability's previous CVSS base score (in case the CVSS base score has changed). |
|
| string | stableVulnerability's previous reachability of related data assets by affected entities (in case the reachability has changed). |
|
| string | stableVulnerability's previous public exploit status (in case the public exploit status has changed). |
|
| string | stableVulnerability's previous internet exposure status (in case the internet exposure status has changed). |
|
| string | stableVulnerability's previous risk level (in case the risk level has changed). |
|
| double | stableVulnerability's previous Davis Security Score (in case Davis Security Score has changed). |
|
| string | stableVulnerability's previous vulnerable function status (in case the vulnerable function status has changed). |
|
| string | stableTimestamp of the vulnerability's previous mute status (in case the mute status has changed). |
|
| string | experimentalComment of the vulnerability's previous mute status. |
|
| string | stableReason for last muting or unmuting the vulnerability (in case the reason for muting or unmuting the vulnerability has changed). |
|
| string | stableVulnerability's previous mute status (in case the mute status has changed). |
|
| string | stableUser who last changed the vulnerability's mute status (in case the mute status was last changed by a different user). |
|
| string | stableVulnerability's previous resolution status (in case the resolution status has changed). |
|
| string | stableVulnerability's previous risk score level (in case the risk score level has changed). |
|
| double | stableVulnerability's previous risk score (in case the risk score has changed). |
|
| string[] | stableList of the vulnerability's CVE IDs. |
|
| string[] | stableList of the vulnerability's CWE IDs. |
|
| string[] | stableList of vulnerability's OWASP IDs. |
|
| string | experimentalDescription of the vulnerability's remediation advice. |
|
| string | experimentalIndicates whether a fix for the vulnerability is available. |
|
| timestamp | stableTimestamp of the vulnerability's last resolution status change. |
|
| string | stableVulnerability's resolution status. |
|
| string | stableVulnerability's risk score level defined by the provider. For Dynatrace, the Davis Security Score level. |
|
| string | stableScale by which the vulnerability's risk score and risk score level defined by the provider are measured. |
|
| double | stableVulnerability's risk score defined by the provider. For Dynatrace, Davis Security Score. |
|
| string | experimentalLevel of the vulnerable component in the technological stack. |
|
| string | stableTechnology of the vulnerable component. |
|
| string | stableTitle of the vulnerability. |
|
| string | stableClassification of the vulnerability based on commonly accepted enums, such as CWE. |
|
| string | stableDynatrace URL to the details page of the vulnerability. | |
|
vulnerability.davis_assessment.assessment_mode has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| full |
| not_available |
| reduced |
vulnerability.davis_assessment.data_assets_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| not_available |
| not_detected |
| reachable |
vulnerability.davis_assessment.exploit_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| available |
| not_available |
vulnerability.davis_assessment.exposure_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| adjacent_network |
| not_available |
| not_detected |
| public_network |
vulnerability.davis_assessment.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.davis_assessment.vulnerable_function_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| in_use |
| not_available |
| not_in_use |
vulnerability.mute.reason has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| affected |
| configuration_not_affected |
| false_positive |
| ignore |
| other |
vulnerability.mute.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| muted |
| not_muted |
vulnerability.parent.davis_assessment.assessment_mode has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| full |
| not_available |
| reduced |
vulnerability.parent.davis_assessment.data_assets_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| not_available |
| not_detected |
| reachable |
vulnerability.parent.davis_assessment.exposure_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| adjacent_network |
| not_available |
| not_detected |
| public_network |
vulnerability.parent.davis_assessment.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.parent.davis_assessment.vulnerable_function_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| in_use |
| not_available |
| not_in_use |
vulnerability.parent.mute.reason has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| affected |
| configuration_not_affected |
| false_positive |
| ignore |
| other |
vulnerability.parent.mute.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| muted |
| not_muted |
vulnerability.parent.resolution.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| open |
| resolved |
vulnerability.parent.risk.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.previous.davis_assessment.data_assets_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| not_available |
| not_detected |
| reachable |
vulnerability.previous.davis_assessment.exploit_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| available |
| not_available |
vulnerability.previous.davis_assessment.exposure_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| adjacent_network |
| not_available |
| not_detected |
| public_network |
vulnerability.previous.davis_assessment.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.previous.davis_assessment.vulnerable_function_status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| in_use |
| not_available |
| not_in_use |
vulnerability.previous.mute.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| muted |
| not_muted |
vulnerability.previous.resolution.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| open |
| resolved |
vulnerability.previous.risk.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.resolution.status has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| open |
| resolved |
vulnerability.risk.level has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| critical |
| high |
| low |
| medium |
| none |
vulnerability.stack has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| code |
| code_library |
| container_orchestration |
| software |
vulnerability.technology has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description |
|---|---|
| dotnet |
| go |
| java |
| node_js |
| php |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the cluster this instance belongs to. |
|
| string | resource experimentalThe name of the domain this instance belongs to. |
|
| string | resource experimentalThe instance's home directory. |
|
| string | resource experimentalThe instance's server name. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe name of the cell this instance belongs to. |
|
| string | resource experimentalThe name of the cluster this instance belongs to. |
|
| string | resource experimentalName of the node to which this instance belongs. |
|
| string | resource experimentalThe instance's server name. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | resource experimentalThe instance's server name. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalEvent ID is a unique identifier assigned to each event logged by the system. Each event ID corresponds to a specific type of event, such as an error, warning, or informational message. (4624 -> successful logon, 1000 -> application error) |
|
| string | experimentalKeywords are used to categorize and group events. This categorization allows to quickly identify and focus on specific types of events that are relevant to your troubleshooting or monitoring needs. |
|
| string | experimentalLevel of an event indicates its severity or importance |
|
| string | experimentalOpcode is a value that identifies a specific activity or a point within an activity that the application was performing when it raised the event. This helps in understanding the context of the event more precisely. |
|
| string | experimentalProvider is a component or service that generates events. Providers are responsible for writing specific types of events to the event logs, such as application errors, security events, or system warnings. |
|
| long | experimentalTask refers to the specific operation or activity that an event is associated with. Each event is categorized under a task, which helps in identifying what the system or application was doing when the event was logged. This can be particularly useful for troubleshooting and understanding the context of the event. (5 -> HTTP Configuration Property Trace Task, 12804 -> Other Object Access Events) |
|
| string | experimentalUsername refers to the account name associated with specific events, such as logon or logoff activities. This is particularly useful for tracking user activity and identifying who was logged into the system at a given time. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | resource experimentalThe address space identifier (ASID) of the z/OS address space. |
|
| string | resource experimentalThe job id of the z/OS address space. |
|
| string | resource experimentalThe jobname of the z/OS address space. |
|
| string | resource experimentalThe step id within the job within the z/OS address space. |
|
| string | resource experimentalThe name of the LPAR that the z/OS address space executes within. |
|
| string | resource experimentalThe system ID of the CICS/IMS address space. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe type of transaction call that was invoked. |
|
| string | experimentalThe ID of this transaction. |
|
| string | experimentalThe jobname of the z/OS address space that the transaction executed in. |
|
| string | experimentalThe name of the LPAR that the transaction executed on. |
|
| string | experimentalThe type of transaction that was executed. |
|
zos.transaction.call_type MUST be one of the following:
| Value | Description |
|---|---|
| A CTG request triggered this transaction. |
| A CICS DPL request triggered this transaction. |
| An HTTP or HTTPS request triggered this transaction. |
| An IMS Connect request triggered this transaction. |
| An IMS Connect API request triggered this transaction. |
| An IMS TM Resource Adapter request triggered this transaction. |
| An MQ operation triggered this transaction. |
| An IMS MSC request triggered this transaction. |
| An IMS Program Switch request triggered this transaction. |
| An SDK call triggered this transaction. |
| An IMS Shared Queue request triggered this transaction. |
| A SOAP request triggered this transaction. |
| An EXEC CICS START triggered this transaction. |
| A green screen terminal transaction code triggered this transaction. |
| A CICS or IMS transaction code triggered this transaction. |
| A z/OS Connect request triggered this transaction. |
zos.transaction.program_type MUST be one of the following:
| Value | Description |
|---|---|
| The transaction performs DB2 database actions. |
| The transaction performs DLI database actions. |
| The transaction performs DLI data communications actions. |
| The transaction performs MQ Queue actions. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe name of the transaction class of this transaction. |
|
| ipAddress | experimentalIP address of the client (IPv4 or IPv6) that made the request that triggered the transaction. |
|
| long | experimentalPort number of the client that made the request that triggered the transaction. |
|
| string | experimentalThe path name, only applicable for web requests. |
|
| string | experimentalThe system ID of the CICS region that this transaction executed on. |
|
| long | experimentalThe CICS task ID of this transaction. |
|
| string | experimentalThe transaction group ID assigned at transaction attach time. |
|
| long | experimentalThe unit of work ID for this transaction, which is normally represented as a hex value. |
|
| string | experimentalThe user ID of the user who triggered this transaction. |
|
| string | experimentalThe name of the z/OS Workload Manager (WLM) reporting service class of this transaction. |
|
| string | experimentalThe name of the z/OS Workload Manager (WLM) service class of this transaction. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe system ID of the CICS region that is defined on the request. |
|
| boolean | experimentalA boolean that is true if the file is defined within the CICS region that it executed in. |
|
| string | experimentalThe logical name of the file, as defined in CEDA. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe number of segments in the message. |
|
| long | experimentalThe size of the message. |
|
| string | experimentalThe terminal name that this IMS transaction executed on. |
|
| long | experimentalThe unit of work ID for this transaction, which is normally represented as a hex value. |
|
| string | experimentalThe user ID of the user who triggered this transaction. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| long | experimentalThe commit count for this transaction. |
|
| long | experimentalThe current priority of this transaction. |
|
| long | experimentalThe execution class of this transaction. |
|
| string | experimentalThe PSB name that this IMS transaction executed on. |
|
| long | experimentalThe schedule count for this transaction. |
|
| long | experimentalThe unit of work ID for this transaction, which is normally represented as a hex value. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| ipAddress | experimentalIP address of the client (IPv4 or IPv6) that made the request that triggered the transaction. |
|
| long | experimentalPort number on the IMS Connect server that received the request for this transaction |
|
| string | experimentalThe user ID of the user who triggered this transaction. |
|
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe detection version for this transaction. |
|
| ipAddress | experimentalIP address of the client (IPv4 or IPv6) that made the request that triggered the transaction. |
|
| long | experimentalPort number of the client that made the request that triggered the transaction. |
|
| long | experimentalThe commit mode of the transaction. |
|
| string | experimentalThe datastore name used by this transaction. |
|
| long | experimentalThe interaction verb that triggered the transaction. |
|
| string | experimentalThe name of the LPAR that the transaction executed on. |
|
| long | experimentalIndicates the synchronization level of the transaction. This only applies when the interaction verb is set to "SYNC_SEND_RECEIVE", "SYNC_SEND", or "SYNC_RECEIVE_CALLOUT". This attribute applies to both conversational and non-conversational applications. It is used in conjuction with the ims.transaction.request.transaction.commit_mode attribute. |
|
ims.tm.resource.adapter.transaction.commit_mode MUST be one of the following:
| Value | Description |
|---|---|
| The commit happens before sending the response. |
| The commit is deferred until the response has been sent and acknowledged. |
ims.tm.resource.adapter.transaction.interaction_verb MUST be one of the following:
| Value | Description |
|---|---|
| SYNC_SEND |
| SYNC_SEND_RECEIVE |
| SYNC_END_CONVERSATION |
| SYNC_RECEIVE_ASYNCOUTPUT |
| SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT |
| SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT |
| SYNC_RECEIVE_CALLOUT |
ims.tm.resource.adapter.transaction.sync_level MUST be one of the following:
| Value | Description |
|---|---|
| There will be no synchronization. |
| Synchronization will be confirmed. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
| string | experimentalThe z/OS Connect API description. |
|
| string | experimentalThe z/OS Connect API name. |
|
| string | experimentalThe z/OS Connect API version. |
|
| long | experimentalThe size of the request payload in bytes. |
|
| long | experimentalThe z/OS Connect request ID. |
|
| string | experimentalThe type of the REST request. 1 |
|
| long | experimentalThe size of the response payload in bytes. |
|
| string | experimentalThe z/OS Connect service description. |
|
| string | experimentalThe z/OS Connect service name. |
|
| string | experimentalThe service provider name. |
|
| string | experimentalThe z/OS Connect service version. |
|
| string | experimentalThe system of record identifier. The format differs depending on the SOR type. 2 |
|
| string | experimentalThe system of record reference. |
|
| string | experimentalIdentifier for the resource invoked on the system of record. The format differs depending on the SOR type. 3 |
|
| string | experimentalThe system of record type. |
|
zosconnect.request.type MUST be one of the following:
| Value | Description |
|---|---|
| admin |
| api |
| service |
| unknown |
zosconnect.sor.type MUST be one of the following:
| Value | Description |
|---|---|
| cics |
| ims |
| mq |
| rest |
| wola |