Skip to content

Commit f9bfe9a

Browse files
asreehari-splunkdmitryax
authored andcommitted
[exporter/sapm] Deprecate SAPM exporter (open-telemetry#36028)
#### Description In this PR we are making the SAPM Exporter as deprecated. Please use the otlphttp exporter instead --------- Co-authored-by: Dmitrii Anoshin <[email protected]>
1 parent cc176a4 commit f9bfe9a

File tree

4 files changed

+53
-4
lines changed

4 files changed

+53
-4
lines changed

.chloggen/deprecate_sapmexporter.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: deprecation
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: sapmexporter
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Deprecate SAPM exporter
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [36028]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: |
19+
The SAPM exporter is being marked as deprecated. Please use the `otlphttp` exporter with the configuration shown
20+
below. Also update your pipeline configuration for Traces accordingly.
21+
```yaml
22+
exporters:
23+
otlphttp:
24+
traces_endpoint: "${SPLUNK_INGEST_URL}/v2/trace/otlp"
25+
headers:
26+
"X-SF-Token": "${SPLUNK_ACCESS_TOKEN}"
27+
```
28+
29+
# If your change doesn't affect end users or the exported elements of any package,
30+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
31+
# Optional: The change log or logs in which this entry should be included.
32+
# e.g. '[user]' or '[user, api]'
33+
# Include 'user' if the change is relevant to end users.
34+
# Include 'api' if there is a change to a library API.
35+
# Default: '[user]'
36+
change_logs: []

exporter/sapmexporter/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,28 @@
33
<!-- status autogenerated section -->
44
| Status | |
55
| ------------- |-----------|
6-
| Stability | [beta]: traces |
6+
| Stability | [deprecated]: traces |
77
| Distributions | [contrib] |
88
| 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) |
99
| [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) |
1010

11-
[beta]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#beta
11+
[deprecated]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#deprecated
1212
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
1313
<!-- end autogenerated section -->
1414

15+
### Deprecated
16+
17+
> 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.
18+
19+
> 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
20+
21+
```yaml
22+
exporters:
23+
otlphttp:
24+
traces_endpoint: "${SPLUNK_INGEST_URL}/v2/trace/otlp"
25+
headers:
26+
"X-SF-Token": "${SPLUNK_ACCESS_TOKEN}"
27+
```
1528
The SAPM exporter builds on the Jaeger proto and adds additional batching on top. This allows
1629
the collector to export traces from multiples nodes/services in a single batch. The SAPM proto
1730
and some useful related utilities can be found [here](https://github.com/signalfx/sapm-proto/).

exporter/sapmexporter/internal/metadata/generated_status.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

exporter/sapmexporter/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ type: sapm
33
status:
44
class: exporter
55
stability:
6-
beta: [traces]
6+
deprecated: [traces]
77
distributions: [contrib]
88
codeowners:
99
active: [dmitryax, atoulme]

0 commit comments

Comments
 (0)