Skip to content

Commit

Permalink
[processor/groupbytrace] do not expose method (open-telemetry#27061)
Browse files Browse the repository at this point in the history
Do not export the function `MetricViews` and pass checkapi.

open-telemetry#26304
  • Loading branch information
sakulali committed Sep 21, 2023
1 parent ae2cfaf commit 5f52cb6
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 6 deletions.
27 changes: 27 additions & 0 deletions .chloggen/groupbytraceprocessor-checkapi-26304.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: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: groupbytraceprocessor

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Do not export the function `MetricViews` and pass checkapi.

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

# (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: [api]
1 change: 0 additions & 1 deletion cmd/checkapi/allowlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ exporter/pulsarexporter
exporter/sumologicexporter
extension/observer/ecsobserver
extension/observer
processor/groupbytraceprocessor
processor/servicegraphprocessor
receiver/carbonreceiver
receiver/collectdreceiver
Expand Down
2 changes: 1 addition & 1 deletion processor/groupbytraceprocessor/event_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ func TestEventShutdown(t *testing.T) {

func TestPeriodicMetrics(t *testing.T) {
// prepare
views := MetricViews()
views := metricViews()

// ensure that we are starting with a clean state
view.Unregister(views...)
Expand Down
2 changes: 1 addition & 1 deletion processor/groupbytraceprocessor/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var (
// NewFactory returns a new factory for the Filter processor.
func NewFactory() processor.Factory {
// TODO: find a more appropriate way to get this done, as we are swallowing the error here
_ = view.Register(MetricViews()...)
_ = view.Register(metricViews()...)

return processor.NewFactory(
metadata.Type,
Expand Down
4 changes: 2 additions & 2 deletions processor/groupbytraceprocessor/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ var (
mEventLatency = stats.Int64("processor_groupbytrace_event_latency", "How long the queue events are taking to be processed", stats.UnitMilliseconds)
)

// MetricViews return the metrics views according to given telemetry level.
func MetricViews() []*view.View {
// metricViews return the metrics views according to given telemetry level.
func metricViews() []*view.View {
return []*view.View{
{
Name: processorhelper.BuildCustomMetricName(string(metadata.Type), mNumTracesConf.Name()),
Expand Down
2 changes: 1 addition & 1 deletion processor/groupbytraceprocessor/metrics_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func TestProcessorMetrics(t *testing.T) {
"processor/groupbytrace/processor_groupbytrace_event_latency",
}

views := MetricViews()
views := metricViews()
for i, viewName := range expectedViewNames {
assert.Equal(t, viewName, views[i].Name)
}
Expand Down

0 comments on commit 5f52cb6

Please sign in to comment.