Skip to content

Commit

Permalink
Deprecating The Datadog Processor (#25437)
Browse files Browse the repository at this point in the history
The Datadog Processor is deprecated in favor of the Datadog Connector

Link to issue:
#19740

---------

Co-authored-by: Yang Song <[email protected]>
Co-authored-by: Alex Boten <[email protected]>
  • Loading branch information
3 people authored Aug 18, 2023
1 parent 06f1f57 commit 4036a3d
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 4 deletions.
27 changes: 27 additions & 0 deletions .chloggen/deprecate-processor.yaml
Original file line number Diff line number Diff line change
@@ -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: datadogprocessor

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecation of Datadog processor in favor of Datadog connector

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [19740]

# (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: [user]
7 changes: 5 additions & 2 deletions processor/datadogprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
<!-- status autogenerated section -->
| 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%3Aprocessor%2Fdatadog%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aprocessor%2Fdatadog) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aprocessor%2Fdatadog%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aprocessor%2Fdatadog) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@mx-psi](https://github.com/mx-psi), [@gbbr](https://github.com/gbbr), [@dineshg13](https://github.com/dineshg13) |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[deprecated]: https://github.com/open-telemetry/opentelemetry-collector#deprecated
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

## Description


This component has been deprecated in favor of its successor the [Datadog Connector](../../connector/datadogconnector/README.md) which serves the same purpose and should be used in place of the Datadog processor.

The Datadog Processor can be used to compute Datadog APM Stats pre-sampling. For example, when using the [tailsamplingprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/tailsamplingprocessor#tail-sampling-processor) or [probabilisticsamplerprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor) components, the `datadogprocessor` can be prepended into the pipeline to ensure that Datadog APM Stats are accurate and include the dropped traces.

## Usage
Expand Down
1 change: 1 addition & 0 deletions processor/datadogprocessor/go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Deprecated: Use Datadog connector instead.
module github.com/open-telemetry/opentelemetry-collector-contrib/processor/datadogprocessor

go 1.20
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion processor/datadogprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: datadog
status:
class: processor
stability:
beta: [traces]
deprecated: [traces]
distributions: [contrib]
codeowners:
active: [mx-psi, gbbr, dineshg13]
1 change: 1 addition & 0 deletions processor/datadogprocessor/processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ func newProcessor(ctx context.Context, logger *zap.Logger, config component.Conf
if err != nil {
return nil, err
}
logger.Warn("This component is deprecated in favor of the Datadog connector")
return &datadogProcessor{
logger: logger,
nextConsumer: nextConsumer,
Expand Down

0 comments on commit 4036a3d

Please sign in to comment.