Adding target as LogRecord field, and using it as scope.name in OTLP exporter by lalitb · Pull Request #1869 · open-telemetry/opentelemetry-rust

lalitb · 2024-06-06T18:32:38Z

Changes

Add an API method LogRecord::set_target(&mut self, target: Cow<'static, str>).
Introduce target as a field in opentelemetry_sdk::logs::LogRecord:

pub struct LogRecord {
    /// Target of the log record
    pub target: Option<Cow<'static, str>>,
}

The opentelemetry-appender-tracing module will call set_target() using the tracing::metadata::target value.
The opentelemetry-appender-logs module will call set_target() using the logs::metadata::target value.
The OTLP logs exporter will:
- Copy the target to scope.name before exporting the record.

Please provide a brief description of the changes here.

Merge requirement checklist

CONTRIBUTING guidelines followed
Unit tests added/updated (if applicable)
Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
Changes in public API reviewed (if applicable)

lalitb · 2024-06-06T18:33:28Z

Moving to draft to add tests, but should be good to review otherwise.

opentelemetry-proto/src/transform/common.rs

…emetry-rust into set_instrumentation_scope

codecov · 2024-06-06T18:42:46Z

Codecov Report

Attention: Patch coverage is 47.14286% with 37 lines in your changes missing coverage. Please review.

Project coverage is 74.6%. Comparing base (e0fb7fe) to head (d372130).

❗ Current head d372130 differs from pull request most recent head e70e1d9

Please upload reports for the commit e70e1d9 to get more accurate results.

Files	Patch %	Lines
opentelemetry-proto/src/transform/common.rs	31.8%	30 Missing ⚠️
opentelemetry/src/logs/noop.rs	0.0%	5 Missing ⚠️
opentelemetry-proto/src/transform/logs.rs	0.0%	1 Missing ⚠️
opentelemetry-proto/src/transform/metrics.rs	0.0%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #1869     +/-   ##
=======================================
- Coverage   74.6%   74.6%   -0.1%     
=======================================
  Files        122     122             
  Lines      19952   20001     +49     
=======================================
+ Hits       14902   14933     +31     
- Misses      5050    5068     +18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

opentelemetry-appender-tracing/src/layer.rs

…emetry-rust into set_instrumentation_scope

cijothomas · 2024-06-19T02:20:43Z

opentelemetry-otlp/CHANGELOG.md

 - Bump MSRV to 1.70 [#1840](https://github.com/open-telemetry/opentelemetry-rust/pull/1840)
 - Fixing the OTLP HTTP/JSON exporter. [#1882](https://github.com/open-telemetry/opentelemetry-rust/pull/1882) - The exporter was broken in the
  previous release.
+- **Breaking** [1869](https://github.com/open-telemetry/opentelemetry-rust/pull/1869) The OTLP logs exporter now populates the [InstrumentationScope::name](https://github.com/open-telemetry/opentelemetry-proto/blob/b3060d2104df364136d75a35779e6bd48bac449a/opentelemetry/proto/common/v1/common.proto#L73) field with the name of the target/component emitting the logs, instead of the appender's name as done previously.


OTLP Exporter now overrides InstrumentationScope's name with target from LogRecord, if it is present.

opentelemetry-appender-tracing/CHANGELOG.md

cijothomas · 2024-06-19T02:25:57Z

opentelemetry-appender-tracing/src/layer.rs

        let mut log_record = self.logger.create_log_record();
        log_record.set_severity_number(severity_of_level(meta.level()));
        log_record.set_severity_text(meta.level().to_string().into());
+        log_record.set_target(meta.target().to_string());


the logger created by appender - please modify it to not populate version, as it'll be misleading now.

also - there is some experimental feature where target was added as an attribute. lets remove that now?

the logger created by appender - please modify it to not populate version, as it'll be misleading now.

Other thought - we can keep it, and allow users to customize the logger-name, for those interested to have the single logger, and use that created by appender?

also - there is some experimental feature where target was added as an attribute. lets remove that now?

Yeah good point. This is basically the "log.target" coming from log-to-tracing conversion. Will handle it as separate PR ?

the version will be misleading. it'll be the version of appender-crate, but the name will be that of the tracing:target. I'd suggest to remove version completely to avoid this confusion..

Agree, as of now I have removed version and attributes population from OTLP exporter. We should make this configurable in OTLP exporter - default to override the scope.name with target, unless configured otherwise. Will create a separate PR for that (and a tracing task). I think the current way of configuration is bit messy with no separate way to provide log/trace/metrics specific configuration.

#1890 to track this.

This is basically the "log.target" coming from log-to-tracing conversion. Will handle it as separate PR ?

Lets add an issue to track this too.

#1894 for tracking.

cijothomas · 2024-06-19T02:27:59Z

opentelemetry/src/logs/record.rs

    {
    }

+    /// Sets the `target` of a record


some note about the need for this as opposed to instrumentation scope would be helpful.
also mention that exporters would use target to override instrumentation scope when present.

cijothomas

Looks good, overall. Left some comments to be addressed before marking as approved.

opentelemetry-otlp/CHANGELOG.md

cijothomas

Left a suggestion to improve changelog wording, rest looks good.

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

…exporter (open-telemetry#1869) Co-authored-by: Zhongyang Wu <zhongyang.wu@outlook.com> Co-authored-by: Cijo Thomas <cijo.thomas@gmail.com> Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

When logs have a target set, the InstrumentationScope's version and attributes were being discarded during OTLP export. The target parameter now correctly overrides only the scope name, preserving other metadata. This behaviour was introduced in PR open-telemetry#1869 to avoid exporting the appender crate's version when the scope name was overridden by target. However, PRs open-telemetry#2735 and open-telemetry#2796 subsequently changed both appenders to use empty scopes, so this concern no longer applies. Additionally, users who explicitly create scopes via logger_with_scope() would reasonably expect their metadata to be preserved. Fixes open-telemetry#3276

initial commit

cef3c23

lalitb requested a review from a team June 6, 2024 18:32

Merge branch 'main' into set_instrumentation_scope

da5a284

lalitb marked this pull request as draft June 6, 2024 18:32

cijothomas reviewed Jun 6, 2024

View reviewed changes

opentelemetry-proto/src/transform/common.rs Outdated Show resolved Hide resolved

lalitb added 2 commits June 6, 2024 18:37

fix lifetime

64a4077

Merge branch 'set_instrumentation_scope' of github.com:lalitb/opentel…

01dd231

…emetry-rust into set_instrumentation_scope

lalitb added the integration tests Run integration tests label Jun 6, 2024

lalitb marked this pull request as ready for review June 7, 2024 18:00

lalitb and others added 6 commits June 7, 2024 11:45

update changelog

daf81c6

Merge branch 'main' into set_instrumentation_scope

2b3b34d

Merge branch 'main' into set_instrumentation_scope

60bd794

Merge branch 'main' into set_instrumentation_scope

804d79e

Merge branch 'main' into set_instrumentation_scope

4c9acdf

remove target conv

3c933ad

lalitb commented Jun 18, 2024

View reviewed changes

opentelemetry-appender-tracing/src/layer.rs Show resolved Hide resolved

lalitb and others added 4 commits June 18, 2024 16:08

fix review comment

c61cc57

Merge branch 'main' into set_instrumentation_scope

b580815

undo to_string

b27553b

Merge branch 'set_instrumentation_scope' of github.com:lalitb/opentel…

59ec633

…emetry-rust into set_instrumentation_scope

cijothomas reviewed Jun 19, 2024

View reviewed changes

opentelemetry-appender-tracing/CHANGELOG.md Show resolved Hide resolved

cijothomas reviewed Jun 19, 2024

View reviewed changes

lalitb added 3 commits June 19, 2024 09:50

Update CHANGELOG.md

1c68b04

set_target comment

907dcb7

populate scope.version and scope.attributes only if target is present

c88e5fd

lalitb mentioned this pull request Jun 19, 2024

Add Configuration Option in OTLP Log Exporter to Prevent Overriding scope.name with logrecord.target #1890

Open

Update CHANGELOG.md

d372130

lalitb mentioned this pull request Jun 20, 2024

Populate LogRecord.target in tracing-appender for logs-to-trace events #1894

Closed

cijothomas reviewed Jun 20, 2024

View reviewed changes

opentelemetry-otlp/CHANGELOG.md Outdated Show resolved Hide resolved

cijothomas approved these changes Jun 20, 2024

View reviewed changes

Update opentelemetry-otlp/CHANGELOG.md

e70e1d9

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

cijothomas merged commit 4d45506 into open-telemetry:main Jun 20, 2024

djvcom mentioned this pull request Jan 30, 2026

fix(proto): preserve InstrumentationScope version and attributes #3332

Open

4 tasks

Conversation

lalitb commented Jun 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

lalitb commented Jun 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jun 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

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!

cijothomas Jun 20, 2024 • 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!

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!

cijothomas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cijothomas left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lalitb commented Jun 6, 2024 •

edited

Loading

lalitb commented Jun 6, 2024 •

edited

Loading

codecov bot commented Jun 6, 2024 •

edited

Loading

cijothomas Jun 20, 2024 •

edited

Loading