Migrate APM custom reporting to OpenTelemetry Java Agent 2.0 🔗
Version 2.0 of the Splunk Distribution of OpenTelemetry Java agent includes breaking changes to HTTP semantic conventions. While the release of version 2.0 is to be determined, you can migrate to affected attributes in advance of updating so you can ensure your Splunk APM experience is minimally affected.
If you continue to use deprecated OTel attributes, the following aspects of custom reporting in APM are affected by updating to version 2.0 of the Splunk Distribution of OpenTelemetry Java agent:
Tag Spotlight
Custom charts and dashboards that you created
Detectors
HTTP semantic convention changes 🔗
The following table covers the current HTTP OpenTelemetry (OTel) attributes that changed from version 1.0 to version 2.0 in the Splunk Distribution of OpenTelemetry Java agent.
Note
Until the release of version 2.0 of the OpenTelemetry Java agent, this list is subject to change.
Version 1.0 OTel attribute |
Version 2.0 OTel attribute |
Why the change |
---|---|---|
|
|
Updated for consistent namespacing. |
|
|
Updated for consistent namespacing. |
|
|
Updated for consistent namespacing. |
|
|
Updated for consistent namespacing. |
|
|
Updated to avoid separate fields for various URL types and simplify telemetry correlation across different URL types like ftp://, ssh://, file://, data://, and so on. |
|
|
Updated to avoid separate fields for various URL types and simplify telemetry correlation across different URL types like ftp://, ssh://, file://, data://, and so on. |
|
|
Updated to avoid separate fields for various URL types and simplify telemetry correlation across different URL types like ftp://, ssh://, file://, data://, and so on. |
|
|
Updated to reflect the latest attribute definition. |
Assess if you’re affected by updating 🔗
To determine if your APM experience is affected by the update, check whether you are indexing the affected OTel attributes as custom tags in Splunk APM:
Note
The HTTP method attribute is stored as a system tag by default in Splunk Observability Cloud. You don’t need to index the HTTP method attribute to use it as a Troubleshooting MetricSet (TMS) or Monitoring MetricSet (MMS).
Go to Settings, then APM MetricSets. You must have the admin role to access APM MetricSets.
- Cross-reference the tags indexed in the APM MetricSets list with the list of new OTel attributes. See HTTP semantic convention changes.
If 1 or more affected tags are listed on the APM MetricSets page, determine if each tag is indexed as only a Troubleshooting MetricSet (TMS) or as a Monitoring MetricSet (MMS) as well. Then, see the Migration steps section for more information.
If you are not indexing any of the affected tags, you do not need to take action to migrate tags. Ensure you use the new HTTP conventions going forward.
Migration steps 🔗
If you determine that you need to migrate, follow these steps:
Update your charts and dashboards to use the new indexed tags.
(Optional) Delete MetricSets that use the deprecated attributes as tags.
Time your update 🔗
As of August 7, 2023, Splunk APM began populating the new attributes of raw trace data. However, TMS and MMS for these new attributes have not been created. you need to create TMS and MMS in order to receive any data. To prepare for the update you need to index the new attributes as tags so custom TMS and MMS begin receiving data for reporting. For TMS, which are used in Tag Spotlight, plan to index the new data at least 8 days in advance of the update. For MMS, which are used in dashboard charts and detectors, you’ll need to update the SignalFlow for charts and dashboards to filter for both the old and new tags to prevent gaps in data.