Stdoutlog exporter metrics #7145

Horiodino · 2025-08-07T15:51:50Z

Summary

This PR adds self-observability metrics to the stdoutlog exporter

These metrics are enabled when the environment variable OTEL_GO_X_SELF_OBSERVABILITY is set to "true"

What's Added

Support for:
- otel.sdk.exporter.log.inflight
- otel.sdk.exporter.log.exported
- otel.sdk.exporter.operation.duration

Related Issue

Closes #7020

exporters/stdout/stdoutlog/config.go

exporters/stdout/stdoutlog/selfobservability.go

exporters/stdout/stdoutlog/exporter.go

exporters/stdout/stdoutlog/selfobservability.go

exporters/stdout/stdoutlog/selfobservability_test.go

dashpole · 2025-08-08T13:38:28Z

We should follow the existing convention for including experimental features in an internal/x directory. You can follow the example in https://github.com/open-telemetry/opentelemetry-go/pull/7133/files#diff-0dd3a4492039e9f0aa24246db2fe468b32e1285411c2625fabafb53f9d64d07eR68

exporters/stdout/stdoutlog/config.go

codecov · 2025-08-11T14:07:33Z

Codecov Report

❌ Patch coverage is 82.35294% with 18 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.9%. Comparing base (c09be18) to head (8835529).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
exporters/stdout/stdoutlog/exporter.go	76.6%	11 Missing and 7 partials ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #7145     +/-   ##
=======================================
- Coverage   82.9%   82.9%   -0.1%     
=======================================
  Files        264     265      +1     
  Lines      24628   24730    +102     
=======================================
+ Hits       20425   20505     +80     
- Misses      3820    3835     +15     
- Partials     383     390      +7

Files with missing lines	Coverage Δ
exporters/stdout/stdoutlog/config.go	`100.0% <ø> (ø)`
exporters/stdout/stdoutlog/internal/x/x.go	`100.0% <100.0%> (ø)`
exporters/stdout/stdoutlog/exporter.go	`80.9% <76.6%> (-10.0%)`	⬇️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

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

pellared · 2025-08-11T14:11:28Z

I have currently time to review this PR, but I can at least recommend looking at #7133 (that is already merged) and use similar patterns where appropriate.

exporters/stdout/stdoutlog/doc.go

exporters/stdout/stdoutlog/exporter.go

exporters/stdout/stdoutlog/doc.go

exporters/stdout/stdoutlog/exporter.go

exporters/stdout/stdoutlog/exporter_test.go

exporters/stdout/stdoutlog/exporter.go

exporters/stdout/stdoutlog/exporter_test.go

flc1125 · 2025-08-14T01:03:51Z

We are missing a CHANGELOG.

We can run make lint for lint checks and make test for unit tests, which helps address some basic issues before review.

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

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>

exporters/stdout/stdoutlog/exporter.go

MrAlias · 2025-08-16T15:27:43Z

exporters/stdout/stdoutlog/exporter.go

+		e.selfObservability.operationDurationMetric.Record(ctx, time.Since(start).Seconds(), addAttrs...)
+
+		*bufPtr = addAttrs[:0]
+		selfObservabilityBuffer.Put(bufPtr)


This needs to be defered right after the Get to ensure it will always be returned to the pool.

i’m not sure what you mean , the entire thing is deferred.

MrAlias · 2025-08-16T15:31:36Z

exporters/stdout/stdoutlog/exporter.go

+		if err != nil {
+			addAttrs = append(addAttrs, semconv.ErrorType(err))
+		} else {
+			e.selfObservability.exportedMetric.Add(ctx, count, addAttrs...)


This only adds success metrics for exported count, and it only does so when there are no errors. This does not add counts for errored exports and it does not support partial successes.

For example, if the export is successfully able to export 4 records and fails on 2, this instrument needs to record both 4 and 2 with the appropriate attributes, if it fails all 6 it needs to record all 6 as errored, and if it succeeds for a 6 then 6 needs to be recorded without any error attribute.

exporters/stdout/stdoutlog/exporter.go

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

pellared · 2025-09-01T20:00:10Z

@Horiodino PTAL #7272

flc1125 · 2025-09-11T01:26:03Z

Hi, since this process involves specification adjustments and historical review records (which may contain invalid review suggestions), it’s impossible to tell which items need attention amid the large volume of information.

Could we create a new PR based on the current branch before preparing for the review, so that subsequent reviews can proceed more smoothly?

Thanks~

Horiodino requested review from MrAlias, XSAM, dashpole, dmathieu, flc1125 and pellared as code owners August 7, 2025 15:51

Horiodino force-pushed the stdoutlog_exporter_metrics branch from e7d6c0f to 8a95ca4 Compare August 8, 2025 07:58

flc1125 reviewed Aug 8, 2025

View reviewed changes

dashpole reviewed Aug 8, 2025

View reviewed changes

exporters/stdout/stdoutlog/config.go Outdated Show resolved Hide resolved

flc1125 mentioned this pull request Aug 11, 2025

feat: add self-observability metrics to otlpmetricgrpc metric exporters #7120

Open

Horiodino force-pushed the stdoutlog_exporter_metrics branch from caad2dd to 14d1c03 Compare August 13, 2025 13:18

MrAlias reviewed Aug 13, 2025

View reviewed changes

exporters/stdout/stdoutlog/doc.go Outdated Show resolved Hide resolved

MrAlias reviewed Aug 13, 2025

View reviewed changes

flc1125 reviewed Aug 14, 2025

View reviewed changes

exporters/stdout/stdoutlog/internal/x/README.md Show resolved Hide resolved

Horiodino added 6 commits August 14, 2025 19:16

Add self-observability metrics to stdoutlog exporter

8a09fd0

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

Add test case for self-observability metrics for stdoutlog exporter

bb3d1b6

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

simplify nil checks

37ddfc9

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

follow existing convention for including experimental features in an …

9bfd698

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

updates testcase and using AssertEqual

484dc64

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

ad65ca8

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

Horiodino force-pushed the stdoutlog_exporter_metrics branch from 14d1c03 to f54728a Compare August 14, 2025 13:51

fix: resolve merge conflicts

8835529

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

Horiodino force-pushed the stdoutlog_exporter_metrics branch from f54728a to 8835529 Compare August 14, 2025 14:44

refactor: use standalone newSelfObservability instead of e.initSelfOb…

76f0019

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

MrAlias reviewed Aug 16, 2025

View reviewed changes

exporters/stdout/stdoutlog/exporter.go Outdated Show resolved Hide resolved

MrAlias reviewed Aug 16, 2025

View reviewed changes

exporters/stdout/stdoutlog/exporter.go Outdated Show resolved Hide resolved

MrAlias reviewed Aug 16, 2025

View reviewed changes

exporters/stdout/stdoutlog/exporter.go Outdated Show resolved Hide resolved

MrAlias reviewed Aug 16, 2025

View reviewed changes

exporters/stdout/stdoutlog/exporter.go Outdated Show resolved Hide resolved

refactor: record both success and error metrics in exportWithSelfObse…

249a004

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

Horiodino requested a review from MrAlias August 24, 2025 11:11

Horiodino closed this Sep 11, 2025

Horiodino mentioned this pull request Sep 11, 2025

Stdoutlog exporter metrics #7351

Open

Stdoutlog exporter metrics #7145

Stdoutlog exporter metrics #7145

Uh oh!

Conversation

Horiodino commented Aug 7, 2025

Summary

What's Added

Related Issue

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dashpole commented Aug 8, 2025

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

flc1125 commented Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MrAlias Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Horiodino Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

MrAlias Aug 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pellared commented Sep 1, 2025

Uh oh!

flc1125 commented Sep 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Aug 11, 2025 •

edited

Loading

pellared commented Aug 11, 2025 •

edited

Loading

MrAlias Aug 16, 2025 •

edited

Loading