Added the `internal/observ` package to stdoutlog #7735

yumosx · 2025-12-22T07:13:31Z

a part of #7020

goos: windows
goarch: amd64
pkg: go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/observ
cpu: Intel(R) Core(TM) i7-14700
                                          │  result.txt  │
                                          │    sec/op    │
InstrumentationExportLogs/NoError-28        47.68n ±  5%
InstrumentationExportLogs/PartialError-28   471.6n ±  2%
InstrumentationExportLogs/FullError-28      471.9n ± 10%
geomean                                     219.7n

                                          │  result.txt  │
                                          │     B/op     │
InstrumentationExportLogs/NoError-28        0.000 ± 0%
InstrumentationExportLogs/PartialError-28   305.0 ± 0%
InstrumentationExportLogs/FullError-28      305.0 ± 0%
geomean                                                ¹
¹ summaries must be >0 to compute geomean

                                          │  result.txt  │
                                          │  allocs/op   │
InstrumentationExportLogs/NoError-28        0.000 ± 0%
InstrumentationExportLogs/PartialError-28   4.000 ± 0%
InstrumentationExportLogs/FullError-28      4.000 ± 0%
geomean                                                ¹
¹ summaries must be >0 to compute geomean

…s and error handling

codecov · 2025-12-22T07:15:16Z

Codecov Report

❌ Patch coverage is 98.64865% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.3%. Comparing base (3dc4ccc) to head (4988821).

Files with missing lines	Patch %	Lines
...tdout/stdoutlog/internal/observ/instrumentation.go	98.2%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##            main   #7735    +/-   ##
======================================
  Coverage   86.2%   86.3%            
======================================
  Files        302     306     +4     
  Lines      21991   22139   +148     
======================================
+ Hits       18968   19113   +145     
- Misses      2642    2644     +2     
- Partials     381     382     +1

Files with missing lines	Coverage Δ
...orters/stdout/stdoutlog/internal/partialsuccess.go	`100.0% <100.0%> (ø)`
exporters/stdout/stdoutlog/internal/x/features.go	`100.0% <100.0%> (ø)`
exporters/stdout/stdoutlog/internal/x/x.go	`100.0% <100.0%> (ø)`
...tdout/stdoutlog/internal/observ/instrumentation.go	`98.2% <98.2%> (ø)`

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

flc1125

Overall it looks good.

versions.yaml

pellared · 2026-01-07T08:37:23Z

versions.yaml

      - ./internal/version.go
+  go.opentelemetry.io/otel/exporters/stdout/stdoutlog:
+    version-refs:
+      - ./internal/version.go


Suggested change

- ./internal/version.go

- ./internal/version.go

Copilot

Pull request overview

This PR adds the internal/observ package to the stdoutlog exporter as part of issue #7020, introducing experimental observability metrics for the exporter. The implementation includes a feature flag system to enable/disable the observability functionality via environment variables.

Key Changes

Introduces internal/observ package with instrumentation for tracking log export metrics (inflight, exported, and operation duration)
Adds internal/x package for experimental feature flag management, specifically the Observability feature flag
Implements partial success error handling with proper error formatting
Updates module dependencies to include metric SDK support

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
versions.yaml	Adds stdoutlog exporter to version tracking
exporters/stdout/stdoutlog/internal/x/x.go	Implements feature flag framework for experimental features
exporters/stdout/stdoutlog/internal/x/x_test.go	Tests for feature flag functionality
exporters/stdout/stdoutlog/internal/x/features.go	Defines Observability feature flag
exporters/stdout/stdoutlog/internal/x/features_test.go	Tests for Observability feature
exporters/stdout/stdoutlog/internal/x/README.md	Documents experimental observability feature usage
exporters/stdout/stdoutlog/internal/version.go	Defines version constant for the exporter
exporters/stdout/stdoutlog/internal/partialsuccess.go	Implements partial success error type
exporters/stdout/stdoutlog/internal/partialsuccess_test.go	Tests for partial success error formatting
exporters/stdout/stdoutlog/internal/observ/instrumentation.go	Core instrumentation logic for metrics collection
exporters/stdout/stdoutlog/internal/observ/instrumentation_test.go	Comprehensive tests including benchmarks for instrumentation
exporters/stdout/stdoutlog/internal/gen.go	Code generation directives for template-based code
exporters/stdout/stdoutlog/go.mod	Adds metric and sdk/metric dependencies

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-07T08:48:18Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+	attrs := make([]attribute.KeyValue, 0, 2)
+	attrs = append(attrs,
+		semconv.OTelComponentName(GetComponentName(id)),
+		semconv.OTelComponentNameKey.String(ComponentType))


The attribute key used here appears incorrect. The code uses semconv.OTelComponentNameKey.String(ComponentType) which creates an attribute with key "otel.component.name" and value ComponentType. However, based on the semantic conventions, there should be a "otel.component.type" attribute. This line should likely use semconv.OTelComponentType(ComponentType) instead of semconv.OTelComponentNameKey.String(ComponentType) to properly set the component type.

Suggested change

semconv.OTelComponentNameKey.String(ComponentType))

semconv.OTelComponentType(ComponentType))

Copilot · 2026-01-07T08:48:18Z

exporters/stdout/stdoutlog/internal/observ/instrumentation_test.go

+func set(err error) attribute.Set {
+	attrs := []attribute.KeyValue{
+		semconv.OTelComponentName(GetComponentName(ID)),
+		semconv.OTelComponentNameKey.String(ComponentType),


The attribute key used here appears incorrect. The code uses semconv.OTelComponentNameKey.String(ComponentType) which creates an attribute with key "otel.component.name" and value ComponentType. However, based on the semantic conventions, there should be a "otel.component.type" attribute. This line should likely use semconv.OTelComponentType(ComponentType) instead of semconv.OTelComponentNameKey.String(ComponentType) to properly set the component type.

Suggested change

semconv.OTelComponentNameKey.String(ComponentType),

semconv.OTelComponentType(ComponentType),

Copilot · 2026-01-07T08:48:19Z

exporters/stdout/stdoutlog/internal/x/x_test.go

+// source: internal/shared/x/x_text.go.tmpl
+
+// Copyright The OpenTelemetry Authors


The source template filename appears to have a typo. It references "x_text.go.tmpl" but should likely be "x_test.go.tmpl" based on the file being generated (x_test.go).

Suggested change

// source: internal/shared/x/x_text.go.tmpl

// Copyright The OpenTelemetry Authors

// source: internal/shared/x/x_test.go.tmpl

Copyright The OpenTelemetry Authors

This might require another PR to fix it.

Copilot · 2026-01-07T08:48:19Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+		e = fmt.Errorf("failed to create the inflight metric %w", e)
+		err = errors.Join(err, e)
+	}
+	inst.inflight = inflight.Inst()
+
+	exported, e := otelconv.NewSDKExporterLogExported(m)
+	if e != nil {
+		e = fmt.Errorf("failed to create the exported metric %w", e)
+		err = errors.Join(err, e)
+	}
+	inst.exported = exported.Inst()
+
+	duration, e := otelconv.NewSDKExporterOperationDuration(m)
+	if e != nil {
+		e = fmt.Errorf("failed to create the duration metric %w", e)


The error message is missing a colon separator between the message text and the wrapped error. This should be "failed to create the inflight metric: %w" to properly format the error chain.

Suggested change

e = fmt.Errorf("failed to create the inflight metric %w", e)

err = errors.Join(err, e)

}

inst.inflight = inflight.Inst()

exported, e := otelconv.NewSDKExporterLogExported(m)

if e != nil {

e = fmt.Errorf("failed to create the exported metric %w", e)

err = errors.Join(err, e)

}

inst.exported = exported.Inst()

duration, e := otelconv.NewSDKExporterOperationDuration(m)

if e != nil {

e = fmt.Errorf("failed to create the duration metric %w", e)

e = fmt.Errorf("failed to create the inflight metric: %w", e)

err = errors.Join(err, e)

}

inst.inflight = inflight.Inst()

exported, e := otelconv.NewSDKExporterLogExported(m)

if e != nil {

e = fmt.Errorf("failed to create the exported metric: %w", e)

err = errors.Join(err, e)

}

inst.exported = exported.Inst()

duration, e := otelconv.NewSDKExporterOperationDuration(m)

if e != nil {

e = fmt.Errorf("failed to create the duration metric: %w", e)

Copilot · 2026-01-07T08:48:19Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+
+	exported, e := otelconv.NewSDKExporterLogExported(m)
+	if e != nil {
+		e = fmt.Errorf("failed to create the exported metric %w", e)


The error message is missing a colon separator between the message text and the wrapped error. This should be "failed to create the exported metric: %w" to properly format the error chain.

Suggested change

e = fmt.Errorf("failed to create the exported metric %w", e)

e = fmt.Errorf("failed to create the exported metric: %w", e)

Copilot · 2026-01-07T08:48:20Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+
+	duration, e := otelconv.NewSDKExporterOperationDuration(m)
+	if e != nil {
+		e = fmt.Errorf("failed to create the duration metric %w", e)


The error message is missing a colon separator between the message text and the wrapped error. This should be "failed to create the duration metric: %w" to properly format the error chain.

Suggested change

e = fmt.Errorf("failed to create the duration metric %w", e)

e = fmt.Errorf("failed to create the duration metric: %w", e)

Copilot · 2026-01-07T08:48:20Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+	if errors.As(err, ps) {
+		return min(max(ps.RejectedItems, 0), n)
+	}
+	// all logs exporter


The comment contains a typo: "exporter" should be "exported". The comment should read "// all logs exported".

Suggested change

// all logs exporter

// all logs exported

Copilot · 2026-01-07T08:48:20Z

exporters/stdout/stdoutlog/internal/observ/instrumentation.go

+	},
+}
+
+// rejectedCount returns how many out of the n logs exporter were rejected based on


The comment contains a typo: "exporter" should be "exported". The comment should read "// rejectedCount returns how many out of the n logs exported were rejected based on".

yumosx added 3 commits December 10, 2025 22:21

init the instrumentation

1e995f4

added rejectedCount

6edd5a5

feat(exporters/stdout): enhance stdoutlog instrumentation with metric…

64aa687

…s and error handling

yumosx requested review from MrAlias, XSAM, dashpole, dmathieu, flc1125 and pellared as code owners December 22, 2025 07:13

yumosx marked this pull request as draft December 22, 2025 07:13

yumosx changed the title ~~[WIP] Added the internal/observ package to stdout log~~ Added the internal/observ package to stdoutlog Jan 2, 2026

yumosx marked this pull request as ready for review January 2, 2026 18:23

yumosx added 2 commits January 4, 2026 09:10

feat: add experimental feature control infrastructure

71d5f01

fix

ebffa09

yumosx force-pushed the inst-stdout-log branch from 671f7c2 to ebffa09 Compare January 4, 2026 01:20

Merge remote-tracking branch 'upstream/main' into inst-stdout-log

68d2723

flc1125 approved these changes Jan 4, 2026

View reviewed changes

versions.yaml Outdated Show resolved Hide resolved

flc1125 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 4, 2026

fix the yaml fmt

c74fc1c

flc1125 approved these changes Jan 4, 2026

View reviewed changes

flc1125 mentioned this pull request Jan 4, 2026

feat: Instrument self-observability metrics for stdoutlog exporter #7749

Closed

Merge branch 'main' into inst-stdout-log

4988821

pellared reviewed Jan 7, 2026

View reviewed changes

pellared requested a review from Copilot January 7, 2026 08:37

Copilot started reviewing on behalf of pellared January 7, 2026 08:38 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

	semconv.OTelComponentNameKey.String(ComponentType))
	semconv.OTelComponentType(ComponentType))

		// source: internal/shared/x/x_text.go.tmpl

		// Copyright The OpenTelemetry Authors

	e = fmt.Errorf("failed to create the exported metric %w", e)
	e = fmt.Errorf("failed to create the exported metric: %w", e)

	e = fmt.Errorf("failed to create the duration metric %w", e)
	e = fmt.Errorf("failed to create the duration metric: %w", e)

Added the internal/observ package to stdoutlog #7735

Are you sure you want to change the base?

Added the internal/observ package to stdoutlog #7735

Uh oh!

Conversation

yumosx commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

flc1125 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pellared Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

flc1125 Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Added the `internal/observ` package to stdoutlog #7735

Added the `internal/observ` package to stdoutlog #7735

yumosx commented Dec 22, 2025 •

edited

Loading

codecov bot commented Dec 22, 2025 •

edited

Loading