From 722786cfad8d895ca918b8d2910b1b56838aec96 Mon Sep 17 00:00:00 2001 From: asreehari-splunk <74424581+asreehari-splunk@users.noreply.github.com> Date: Thu, 19 Dec 2024 10:49:45 -0800 Subject: [PATCH] [exporter/sapm] Deprecate SAPM exporter (#36028) #### Description In this PR we are making the SAPM Exporter as deprecated. Please use the otlphttp exporter instead --------- Co-authored-by: Dmitrii Anoshin --- .chloggen/deprecate_sapmexporter.yaml | 36 +++++++++++++++++++ exporter/sapmexporter/README.md | 17 +++++++-- .../internal/metadata/generated_status.go | 2 +- exporter/sapmexporter/metadata.yaml | 2 +- 4 files changed, 53 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..4ecadeafb967 --- /dev/null +++ b/.chloggen/deprecate_sapmexporter.yaml @@ -0,0 +1,36 @@ +# 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: | + 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: + otlphttp: + traces_endpoint: "${SPLUNK_INGEST_URL}/v2/trace/otlp" + headers: + "X-SF-Token": "${SPLUNK_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. +# 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: [] diff --git a/exporter/sapmexporter/README.md b/exporter/sapmexporter/README.md index 8c391ef71c3a..b3e612898cc0 100644 --- a/exporter/sapmexporter/README.md +++ b/exporter/sapmexporter/README.md @@ -3,15 +3,28 @@ | 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/blob/main/docs/component-stability.md#deprecated [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/). 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]