From 435d5578ccea3d5ce02f8055241561d34efc9560 Mon Sep 17 00:00:00 2001 From: Ajay Sreehari Date: Mon, 28 Oct 2024 10:50:39 -0700 Subject: [PATCH 1/4] [exporter/sapm] Deprecate SAPM exporter --- .chloggen/deprecate_sapmexporter.yaml | 27 +++++++++++++++++++ exporter/sapmexporter/README.md | 4 +-- .../internal/metadata/generated_status.go | 2 +- exporter/sapmexporter/metadata.yaml | 2 +- 4 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 .chloggen/deprecate_sapmexporter.yaml diff --git a/.chloggen/deprecate_sapmexporter.yaml b/.chloggen/deprecate_sapmexporter.yaml new file mode 100644 index 000000000000..fa32c688efe7 --- /dev/null +++ b/.chloggen/deprecate_sapmexporter.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: deprecation + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: sapmexporter + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Deprecate SAPM exporter + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [36028] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] \ No newline at end of file diff --git a/exporter/sapmexporter/README.md b/exporter/sapmexporter/README.md index 8c391ef71c3a..6c3d7aea1c02 100644 --- a/exporter/sapmexporter/README.md +++ b/exporter/sapmexporter/README.md @@ -3,12 +3,12 @@ | Status | | | ------------- |-----------| -| Stability | [beta]: traces | +| Stability | [deprecated]: traces | | Distributions | [contrib] | | Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aexporter%2Fsapm%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aexporter%2Fsapm) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aexporter%2Fsapm%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aexporter%2Fsapm) | | [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@dmitryax](https://www.github.com/dmitryax), [@atoulme](https://www.github.com/atoulme) | -[beta]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#beta +[deprecated]: https://github.com/open-telemetry/opentelemetry-collector#deprecated [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib diff --git a/exporter/sapmexporter/internal/metadata/generated_status.go b/exporter/sapmexporter/internal/metadata/generated_status.go index 9e925424f0ed..ccd9875059a5 100644 --- a/exporter/sapmexporter/internal/metadata/generated_status.go +++ b/exporter/sapmexporter/internal/metadata/generated_status.go @@ -12,5 +12,5 @@ var ( ) const ( - TracesStability = component.StabilityLevelBeta + TracesStability = component.StabilityLevelDeprecated ) diff --git a/exporter/sapmexporter/metadata.yaml b/exporter/sapmexporter/metadata.yaml index 4bab1554171d..5f708f58cb15 100644 --- a/exporter/sapmexporter/metadata.yaml +++ b/exporter/sapmexporter/metadata.yaml @@ -3,7 +3,7 @@ type: sapm status: class: exporter stability: - beta: [traces] + deprecated: [traces] distributions: [contrib] codeowners: active: [dmitryax, atoulme] From 08f4e01a2e467efaae42e52c97edb620e94e6618 Mon Sep 17 00:00:00 2001 From: Ajay Sreehari Date: Tue, 17 Dec 2024 13:19:39 -0800 Subject: [PATCH 2/4] update changelog to show otlphttp as replacement --- .chloggen/deprecate_sapmexporter.yaml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.chloggen/deprecate_sapmexporter.yaml b/.chloggen/deprecate_sapmexporter.yaml index fa32c688efe7..4d997796fb34 100644 --- a/.chloggen/deprecate_sapmexporter.yaml +++ b/.chloggen/deprecate_sapmexporter.yaml @@ -15,7 +15,16 @@ issues: [36028] # (Optional) One or more lines of additional information to render under the primary note. # These lines will be padded with 2 spaces and then inserted directly into the document. # Use pipe (|) for multiline entries. -subtext: +subtext: | + The SAPM exporter is deprecated. Please use the `otlphttp` exporter with the configuration shown + below. Also update your pipeline configuration for Traces accordingly. + ```yaml + exporters: + otlphttp: + traces_endpoint: "${INGEST_URL}/v2/trace/otlp" + headers: + "X-SF-Token": "${ACCESS_TOKEN}" + ``` # If your change doesn't affect end users or the exported elements of any package, # you should instead start your pull request title with [chore] or use the "Skip Changelog" label. From 40dc427997a0746258507fa3e7d1028f09df4f3b Mon Sep 17 00:00:00 2001 From: asreehari-splunk <74424581+asreehari-splunk@users.noreply.github.com> Date: Tue, 17 Dec 2024 14:49:19 -0800 Subject: [PATCH 3/4] Update deprecate_sapmexporter.yaml minor update to description --- .chloggen/deprecate_sapmexporter.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.chloggen/deprecate_sapmexporter.yaml b/.chloggen/deprecate_sapmexporter.yaml index 4d997796fb34..0fc2826d62b1 100644 --- a/.chloggen/deprecate_sapmexporter.yaml +++ b/.chloggen/deprecate_sapmexporter.yaml @@ -16,7 +16,7 @@ issues: [36028] # These lines will be padded with 2 spaces and then inserted directly into the document. # Use pipe (|) for multiline entries. subtext: | - The SAPM exporter is deprecated. Please use the `otlphttp` exporter with the configuration shown + The SAPM exporter is being marked as deprecated. Please use the `otlphttp` exporter with the configuration shown below. Also update your pipeline configuration for Traces accordingly. ```yaml exporters: @@ -33,4 +33,4 @@ subtext: | # Include 'user' if the change is relevant to end users. # Include 'api' if there is a change to a library API. # Default: '[user]' -change_logs: [] \ No newline at end of file +change_logs: [] From d7308d62f00a12cd4410c220d067f13c152d6638 Mon Sep 17 00:00:00 2001 From: Ajay Sreehari Date: Tue, 17 Dec 2024 15:22:59 -0800 Subject: [PATCH 4/4] Update readme --- .chloggen/deprecate_sapmexporter.yaml | 4 ++-- exporter/sapmexporter/README.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/.chloggen/deprecate_sapmexporter.yaml b/.chloggen/deprecate_sapmexporter.yaml index 0fc2826d62b1..4ecadeafb967 100644 --- a/.chloggen/deprecate_sapmexporter.yaml +++ b/.chloggen/deprecate_sapmexporter.yaml @@ -21,9 +21,9 @@ subtext: | ```yaml exporters: otlphttp: - traces_endpoint: "${INGEST_URL}/v2/trace/otlp" + traces_endpoint: "${SPLUNK_INGEST_URL}/v2/trace/otlp" headers: - "X-SF-Token": "${ACCESS_TOKEN}" + "X-SF-Token": "${SPLUNK_ACCESS_TOKEN}" ``` # If your change doesn't affect end users or the exported elements of any package, diff --git a/exporter/sapmexporter/README.md b/exporter/sapmexporter/README.md index 6c3d7aea1c02..2a0db027f236 100644 --- a/exporter/sapmexporter/README.md +++ b/exporter/sapmexporter/README.md @@ -12,6 +12,21 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib +### Deprecated +> The SAPM protocol is based on the Jaeger protocol, which is no longer the preferred approach of the community, with the advent of the OTLP protocol. The Jaeger exporters have been removed from the collector already. Jaeger itself is migrating to use the OTel data format internally. + +> As a result, the SAPM exporter is being deprecated in favor of the OTLPHTTP exporter. The following configuration can be used for the OTLPHTTP exporter + +```yaml +exporters: + otlphttp: + traces_endpoint: "${SPLUNK_INGEST_URL}/v2/trace/otlp" + headers: + "X-SF-Token": "${SPLUNK_ACCESS_TOKEN}" +``` + + + The SAPM exporter builds on the Jaeger proto and adds additional batching on top. This allows the collector to export traces from multiples nodes/services in a single batch. The SAPM proto and some useful related utilities can be found [here](https://github.com/signalfx/sapm-proto/).