Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[processor/probabilisticsampling] use mdatagen for metrics #33874

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/codeboten_mdatagen-probabilistic-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: bug_fix

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Fix bug where log sampling was being reported by the counter `otelcol_processor_probabilistic_sampler_count_traces_sampled`"

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

# (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: []
23 changes: 23 additions & 0 deletions processor/probabilisticsamplerprocessor/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)

# probabilistic_sampler

## Internal Telemetry

The following telemetry is emitted by this component.

### processor_probabilistic_sampler_count_logs_sampled

Count of logs that were sampled or not

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |

### processor_probabilistic_sampler_count_traces_sampled

Count of traces that were sampled or not

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
10 changes: 0 additions & 10 deletions processor/probabilisticsamplerprocessor/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,20 @@ package probabilisticsamplerprocessor // import "github.com/open-telemetry/opent

import (
"context"
"sync"

"go.opencensus.io/stats/view"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config/configtelemetry"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/processor"

"github.com/open-telemetry/opentelemetry-collector-contrib/processor/probabilisticsamplerprocessor/internal/metadata"
)

var onceMetrics sync.Once

// The default precision is 4 hex digits, slightly more the original
// component logic's 14-bits of precision.
const defaultPrecision = 4

// NewFactory returns a new factory for the Probabilistic sampler processor.
func NewFactory() processor.Factory {
onceMetrics.Do(func() {
// TODO: Handle this err
_ = view.Register(samplingProcessorMetricViews(configtelemetry.LevelNormal)...)
})

return processor.NewFactory(
metadata.Type,
createDefaultConfig,
Expand Down

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

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

6 changes: 3 additions & 3 deletions processor/probabilisticsamplerprocessor/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal v0.104.0
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/sampling v0.104.0
github.com/stretchr/testify v1.9.0
go.opencensus.io v0.24.0
go.opentelemetry.io/collector/component v0.104.0
go.opentelemetry.io/collector/config/configtelemetry v0.104.0
go.opentelemetry.io/collector/confmap v0.104.0
Expand All @@ -15,7 +14,9 @@ require (
go.opentelemetry.io/collector/pdata v1.11.0
go.opentelemetry.io/collector/processor v0.104.0
go.opentelemetry.io/collector/semconv v0.104.0
go.opentelemetry.io/otel v1.27.0
go.opentelemetry.io/otel/metric v1.27.0
go.opentelemetry.io/otel/sdk/metric v1.27.0
go.opentelemetry.io/otel/trace v1.27.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.27.0
Expand Down Expand Up @@ -58,6 +59,7 @@ require (
github.com/tklauser/go-sysconf v0.3.12 // indirect
github.com/tklauser/numcpus v0.6.1 // indirect
github.com/yusufpapurcu/wmi v1.2.4 // indirect
go.opencensus.io v0.24.0 // indirect
go.opentelemetry.io/collector v0.104.0 // indirect
go.opentelemetry.io/collector/confmap/converter/expandconverter v0.104.0 // indirect
go.opentelemetry.io/collector/confmap/provider/envprovider v0.104.0 // indirect
Expand All @@ -75,7 +77,6 @@ require (
go.opentelemetry.io/collector/service v0.104.0 // indirect
go.opentelemetry.io/contrib/config v0.7.0 // indirect
go.opentelemetry.io/contrib/propagators/b3 v1.27.0 // indirect
go.opentelemetry.io/otel v1.27.0 // indirect
go.opentelemetry.io/otel/bridge/opencensus v1.27.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.27.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp v1.27.0 // indirect
Expand All @@ -86,7 +87,6 @@ require (
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.27.0 // indirect
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.27.0 // indirect
go.opentelemetry.io/otel/sdk v1.27.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.27.0 // indirect
go.opentelemetry.io/proto/otlp v1.2.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
Expand Down

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

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

8 changes: 8 additions & 0 deletions processor/probabilisticsamplerprocessor/logsprocessor.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"go.uber.org/zap"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/sampling"
"github.com/open-telemetry/opentelemetry-collector-contrib/processor/probabilisticsamplerprocessor/internal/metadata"
)

type logsProcessor struct {
Expand All @@ -24,6 +25,7 @@ type logsProcessor struct {
precision int
failClosed bool
logger *zap.Logger
telemetryBuilder *metadata.TelemetryBuilder
}

type recordCarrier struct {
Expand Down Expand Up @@ -184,12 +186,17 @@ func (ctc *consistentTracestateCommon) randomnessFromLogRecord(logRec plog.LogRe
// newLogsProcessor returns a processor.LogsProcessor that will perform head sampling according to the given
// configuration.
func newLogsProcessor(ctx context.Context, set processor.Settings, nextConsumer consumer.Logs, cfg *Config) (processor.Logs, error) {
telemetryBuilder, err := metadata.NewTelemetryBuilder(set.TelemetrySettings)
if err != nil {
return nil, err
}
lsp := &logsProcessor{
sampler: makeSampler(cfg, true),
samplingPriority: cfg.SamplingPriority,
precision: cfg.SamplingPrecision,
failClosed: cfg.FailClosed,
logger: set.Logger,
telemetryBuilder: telemetryBuilder,
}

return processorhelper.NewLogsProcessor(
Expand All @@ -214,6 +221,7 @@ func (lsp *logsProcessor) processLogs(ctx context.Context, logsData plog.Logs) (
lsp.priorityFunc,
"logs sampler",
lsp.logger,
lsp.telemetryBuilder.ProcessorProbabilisticSamplerCountLogsSampled,
)
})
// Filter out empty ScopeLogs
Expand Down
22 changes: 17 additions & 5 deletions processor/probabilisticsamplerprocessor/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,20 @@ status:

tests:
config:
goleak:
ignore:
top:
# See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
- "go.opencensus.io/stats/view.(*worker).start"

telemetry:
metrics:
processor_probabilistic_sampler_count_traces_sampled:
enabled: true
description: Count of traces that were sampled or not
unit: "1"
sum:
value_type: int
monotonic: true
processor_probabilistic_sampler_count_logs_sampled:
enabled: true
description: Count of logs that were sampled or not
unit: "1"
sum:
value_type: int
monotonic: true
Loading