Skip to content

Commit

Permalink
[processorhelper] deprecating unused methods (#11083)
Browse files Browse the repository at this point in the history
`[Logs|Traces|Metrics]Inserted` was not used in the core/contrib repos,
marking them as deprecated.

---------

Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
  • Loading branch information
codeboten committed Sep 9, 2024
1 parent 6925a30 commit 3f9bc53
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .chloggen/codeboten_deprecate-unused-methods.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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. otlpreceiver)
component: processorhelper

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: These funcs are not used anywhere, marking them deprecated.

# One or more tracking issues or pull requests related to the change
issues: [11083]

# (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:

# 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: []
6 changes: 6 additions & 0 deletions processor/processorhelper/obsreport.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ func (or *ObsReport) TracesDropped(ctx context.Context, numSpans int) {
}

// TracesInserted reports that the trace data was inserted.
//
// Deprecated: [v0.109.0] This method was not used in core/contrib and it's unclear when it should have been used.
func (or *ObsReport) TracesInserted(ctx context.Context, numSpans int) {
or.recordData(ctx, component.DataTypeTraces, int64(0), int64(0), int64(0), int64(numSpans))
}
Expand All @@ -140,6 +142,8 @@ func (or *ObsReport) MetricsDropped(ctx context.Context, numPoints int) {
}

// MetricsInserted reports that the metrics were inserted.
//
// Deprecated: [v0.109.0] This method was not used in core/contrib and it's unclear when it should have been used.
func (or *ObsReport) MetricsInserted(ctx context.Context, numPoints int) {
or.recordData(ctx, component.DataTypeMetrics, int64(0), int64(0), int64(0), int64(numPoints))
}
Expand All @@ -160,6 +164,8 @@ func (or *ObsReport) LogsDropped(ctx context.Context, numRecords int) {
}

// LogsInserted reports that the logs were inserted.
//
// Deprecated: [v0.109.0] This method was not used in core/contrib and it's unclear when it should have been used.
func (or *ObsReport) LogsInserted(ctx context.Context, numRecords int) {
or.recordData(ctx, component.DataTypeLogs, int64(0), int64(0), int64(0), int64(numRecords))
}

0 comments on commit 3f9bc53

Please sign in to comment.