Stdoutlog exporter metrics #7351

Horiodino · 2025-09-11T13:16:06Z

This PR adds self-observability metrics to the stdoutlog exporter, gated by the environment variable:

OTEL_GO_X_OBSERVABILITY=true

What's added

otel.sdk.exporter.log.inflight
otel.sdk.exporter.log.exported (success and error support)
otel.sdk.exporter.operation.duration

🔗 Related Issues & PRs

Closes: Logs SDK observability - stdoutlog exporter metrics #7020
Replaces: Stdoutlog exporter metrics #7145 (due to review complexity and outdated comments)

flc1125

Review only the functional parts; the unit tests will be reviewed after the functional adjustments.

exporters/stdout/stdoutlog/internal/x/README.md

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

exporters/stdout/stdoutlog/exporter.go

flc1125 · 2025-09-12T04:50:27Z

exporters/stdout/stdoutlog/exporter.go

+
+	e.inst.inflightMetric.Add(ctx, count, e.inst.attrs...)
+
+	bufPtrAny := attrPool.Get()


Can we refer to the standard for the changes in this section: https://github.com/open-telemetry/opentelemetry-go/blob/main/CONTRIBUTING.md#attribute-and-option-allocation-management

flc1125 · 2025-09-12T04:51:02Z

CHANGELOG.md

 ### Added

+- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.
+  Check the `go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/x` package documentation for more information.


Suggested change

Check the `go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/x` package documentation for more information.

Check the `go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/x` package documentation for more information. (#7351)

flc1125 · 2025-09-12T04:51:33Z

CHANGELOG.md


 ### Added

+- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.


Usually we place it at the very bottom of this small node.

exporters/stdout/stdoutlog/exporter.go

codecov · 2025-09-15T18:15:02Z

Codecov Report

❌ Patch coverage is 89.87342% with 16 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.5%. Comparing base (0db5ac7) to head (6eac6ed).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...tdout/stdoutlog/internal/observ/instrumentation.go	88.6%	8 Missing and 4 partials ⚠️
exporters/stdout/stdoutlog/exporter.go	81.8%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##            main   #7351    +/-   ##
======================================
  Coverage   85.5%   85.5%            
======================================
  Files        278     281     +3     
  Lines      24654   24808   +154     
======================================
+ Hits       21088   21224   +136     
- Misses      3187    3200    +13     
- Partials     379     384     +5

Files with missing lines	Coverage Δ
...rters/stdout/stdoutlog/internal/counter/counter.go	`100.0% <100.0%> (ø)`
exporters/stdout/stdoutlog/internal/x/x.go	`100.0% <100.0%> (ø)`
exporters/stdout/stdoutlog/record.go	`97.4% <ø> (ø)`
exporters/stdout/stdoutlog/exporter.go	`88.2% <81.8%> (-2.7%)`	⬇️
...tdout/stdoutlog/internal/observ/instrumentation.go	`88.6% <88.6%> (ø)`

... 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.

MrAlias

Please take a look at the project guidelines regarding observability. The check list for the issue this is resolving should all be checked and completed before this PR is ready to be reviewed.

MrAlias · 2025-09-15T20:05:02Z

CHANGELOG.md


 ### Added

+- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.


Suggested change

- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.

- Add experimental observability for the log exporter in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.

exporters/stdout/stdoutlog/exporter.go

MrAlias · 2025-09-15T20:09:23Z

exporters/stdout/stdoutlog/internal/x/README.md

Do not use the term "self observability". It should just be "observability".

This has not been addressed.

Signed-off-by: Praful <holiodin@gmail.com>

…internal/x Signed-off-by: Praful <holiodin@gmail.com>

Signed-off-by: Praful <holiodin@gmail.com> follow existing convention for including experimental features in an internal/x Signed-off-by: Praful <holiodin@gmail.com>

Signed-off-by: Praful <holiodin@gmail.com>

Signed-off-by: Praful <holiodin@gmail.com> fix: resolve linter err Signed-off-by: Praful <holiodin@gmail.com>

…servability Signed-off-by: Praful <holiodin@gmail.com> refactor: test case from TestSelfObservability to TestNewSelfObservability Signed-off-by: Praful <holiodin@gmail.com>

…rvability Signed-off-by: Praful <holiodin@gmail.com>

…contributing guidelines Signed-off-by: Praful Khanduri <holiodin@gmail.com> added chloggen Signed-off-by: Praful Khanduri <holiodin@gmail.com> fix: return err Signed-off-by: Praful Khanduri <holiodin@gmail.com>

Signed-off-by: Praful <holiodin@gmail.com>

MrAlias

Thank you for the contribution. Please see the instrumentation checklist and the project instrumentation guidelines. Please ensure that these things are followed and the PR is updated to address all the mentioned issues.

MrAlias · 2025-10-07T17:56:39Z

exporters/stdout/stdoutlog/exporter.go

+	// Version is the current version of this instrumentation.
+	//
+	// This matches the version of the exporter.
+	Version = internal.Version


This adds to the public API of the package, it should not be exported.

It does not seem needed either. Using just internal.Version should be adequate.

MrAlias · 2025-10-07T17:59:04Z

exporters/stdout/stdoutlog/exporter.go


+// otelComponentType is a name identifying the type of the OpenTelemetry component.
+const (
+	otelComponentType = "go.opentelemetry.io/otel/exporters/stdout/stdoutlog"


This should be defined in observ not here. It is only used there and passed from here. This is an unneeded coupling.

MrAlias · 2025-10-07T17:59:40Z

exporters/stdout/stdoutlog/exporter.go


 // Export exports log records to writer.
 func (e *Exporter) Export(ctx context.Context, records []log.Record) error {
+	if inst := e.instrumentation; inst != nil {


Just shorten the field name to inst if you want to do things like this.

MrAlias · 2025-10-07T18:02:36Z

exporters/stdout/stdoutlog/exporter.go

+	if inst := e.instrumentation; inst != nil {
+		done := inst.ExportLogs(ctx, len(records))
+		exported, err := e.exportRecords(ctx, records)
+		done(exported, err)
+		return err
+	}
+
+	_, err := e.exportRecords(ctx, records)
+	return err


This should not be needed to be called in two different code paths. Use defer:

Suggested change

if inst := e.instrumentation; inst != nil {

done := inst.ExportLogs(ctx, len(records))

exported, err := e.exportRecords(ctx, records)

done(exported, err)

return err

}

_, err := e.exportRecords(ctx, records)

return err

var n int64

var err error

if inst := e.instrumentation; inst != nil {

done := inst.ExportLogs(ctx, len(records))

defer func() { done(n, err) }()

}

n, err = e.exportRecords(ctx, records)

return err

MrAlias · 2025-10-07T18:03:10Z

exporters/stdout/stdoutlog/exporter_test.go

+	"go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/counter"
 	"go.opentelemetry.io/otel/log"
-	"go.opentelemetry.io/otel/sdk/instrumentation"
+	sdkinstrumentation "go.opentelemetry.io/otel/sdk/instrumentation"


Why rename the package import?

MrAlias · 2025-10-07T18:17:44Z

exporters/stdout/stdoutlog/exporter_test.go

+				var exportedMetric metricdata.Metrics
+				exportedInstrument := otelconv.SDKExporterLogExported{}
+				for _, m := range got.Metrics {
+					if m.Name == exportedInstrument.Name() {
+						exportedMetric = m
+						break
+					}
+				}
+				require.NotEmpty(t, exportedMetric, "exported metric not found")
+
+				data := exportedMetric.Data.(metricdata.Sum[int64])
+				require.Len(t, data.DataPoints, 1)
+
+				dataPoint := data.DataPoints[0]
+				assert.Equal(t, int64(2), dataPoint.Value)


This is an incomplete evaluation of what is expected. A full test needs to be done for this testing scenario.

MrAlias · 2025-10-07T18:20:26Z

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

+// ExportLogs instruments the exporter Export method. It returns a callback that
+// MUST be invoked when the export completes with the number of successfully
+// exported records and the resulting error.
+func (i *Instrumentation) ExportLogs(ctx context.Context, total int) ExportLogsDone {


Returning ExportLogsDone will add an additional allocation.

Benchmarking should be done to evaluate switching to a solution similar to

opentelemetry-go/exporters/stdout/stdouttrace/internal/observ/instrumentation.go

Line 150 in 5f5f4af

func (i *Instrumentation) ExportSpans(ctx context.Context, nSpans int) ExportOp {

MrAlias · 2025-10-07T18:20:44Z

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

There are no tests or benchmarks for this instrumentation or package.

MrAlias · 2025-10-07T18:21:23Z

exporters/stdout/stdoutlog/internal/x/README.md

This has not been addressed.

MrAlias · 2025-10-07T18:21:59Z

exporters/stdout/stdoutlog/record.go

Please revert these changes. They do not belong this PR.

Horiodino requested review from MrAlias, XSAM, dashpole, pellared, dmathieu and flc1125 as code owners September 11, 2025 13:16

flc1125 reviewed Sep 12, 2025

View reviewed changes

MrAlias added this to the v1.40.0 milestone Sep 15, 2025

MrAlias reviewed Sep 15, 2025

View reviewed changes

Horiodino added 11 commits September 27, 2025 15:20

Add self-observability metrics to stdoutlog exporter

6aa74c9

Signed-off-by: Praful <holiodin@gmail.com>

Add test case for self-observability metrics for stdoutlog exporter

9242601

Signed-off-by: Praful <holiodin@gmail.com>

simplify nil checks

36b381a

Signed-off-by: Praful <holiodin@gmail.com>

follow existing convention for including experimental features in an …

f8b91e1

…internal/x Signed-off-by: Praful <holiodin@gmail.com>

updates testcase and using AssertEqual

a35fc1b

Signed-off-by: Praful <holiodin@gmail.com> follow existing convention for including experimental features in an internal/x Signed-off-by: Praful <holiodin@gmail.com>

feat(stdoutlog): refactor and added memory pooling

8ab2b0b

Signed-off-by: Praful <holiodin@gmail.com>

fix: resolve merge conflicts

55909d0

Signed-off-by: Praful <holiodin@gmail.com> fix: resolve linter err Signed-off-by: Praful <holiodin@gmail.com>

refactor: use standalone newSelfObservability instead of e.initSelfOb…

253afc2

…servability Signed-off-by: Praful <holiodin@gmail.com> refactor: test case from TestSelfObservability to TestNewSelfObservability Signed-off-by: Praful <holiodin@gmail.com>

refactor: record both success and error metrics in exportWithSelfObse…

26a279b

…rvability Signed-off-by: Praful <holiodin@gmail.com>

refactor (stdoutlog): implement self-observability metrics following …

670c3ab

…contributing guidelines Signed-off-by: Praful Khanduri <holiodin@gmail.com> added chloggen Signed-off-by: Praful Khanduri <holiodin@gmail.com> fix: return err Signed-off-by: Praful Khanduri <holiodin@gmail.com>

refactor(stdoutlog): improve test cases and standardize code style

6eac6ed

Signed-off-by: Praful <holiodin@gmail.com>

Horiodino force-pushed the stdoutlog_exporter_metrics branch from ada09f6 to 6eac6ed Compare September 27, 2025 15:31

MrAlias requested changes Oct 7, 2025

View reviewed changes


		e.inst.inflightMetric.Add(ctx, count, e.inst.attrs...)

		bufPtrAny := attrPool.Get()

	Check the `go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/x` package documentation for more information.
	Check the `go.opentelemetry.io/otel/exporters/stdout/stdoutlog/internal/x` package documentation for more information. (#7351)


		### Added

		- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.

	- Add experimental self-observability log exporter metrics in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.
	- Add experimental observability for the log exporter in `go.opentelemetry.io/otel/exporters/stdout/stdoutlog`.

Stdoutlog exporter metrics #7351

Are you sure you want to change the base?

Stdoutlog exporter metrics #7351

Uh oh!

Conversation

Horiodino commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's added

🔗 Related Issues & PRs

Uh oh!

flc1125 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

MrAlias left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MrAlias left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Horiodino commented Sep 11, 2025 •

edited

Loading

codecov bot commented Sep 15, 2025 •

edited

Loading