Upgrade `instrumentation_library_metrics` to `scope_metrics` #1507

owent · 2022-07-20T05:03:16Z

Signed-off-by: owentou [email protected]

Fixes #1492
Fixed #1506

Changes

Change the name of instrumentation_info_metric_data_ in ResourceMetrics and instrumentation_info_metrics in MetricCollector::Collect
PopulateResourceMetrics to scope_metrics in OTLP exporters
Rename InstrumentationInfoMetrics to ScopeMetrics
Rename instrumentation_library_ to scope_
Rename instrumentation_metrics to scope_metrics
Rename InstrumentationLibrary to InstrumentationScope
Rename GetInstrumentationLibrary to GetInstrumentationScope
Rename SetInstrumentationLibrary to SetInstrumentationScope
Rename printInstrumentationLibrary to printInstrumentationScope
Rename instrumentation_library_ to instrumentation_scope_
Rename instrumentation_library to instrumentation_library
Move instrumentationlibrary/instrumentation_library.h to instrumentationscope/instrumentation_scope.h
Add deprecated message for legacy GetInstrumentationLibrary and SetInstrumentationLibrary

For significant contributions please make sure you have completed the following items:

CHANGELOG.md updated for non-trivial changes
Unit tests have been added
Changes in public API reviewed

codecov · 2022-07-20T05:15:37Z

Codecov Report

Merging #1507 (ec2f2bb) into main (0015475) will increase coverage by 0.02%.
The diff coverage is 90.67%.

@@            Coverage Diff             @@
##             main    #1507      +/-   ##
==========================================
+ Coverage   84.61%   84.63%   +0.02%     
==========================================
  Files         155      155              
  Lines        4782     4781       -1     
==========================================
  Hits         4046     4046              
+ Misses        736      735       -1

Impacted Files	Coverage Δ
...de/opentelemetry/exporters/ostream/span_exporter.h	`100.00% <ø> (ø)`
sdk/include/opentelemetry/sdk/metrics/meter.h	`0.00% <0.00%> (ø)`
...clude/opentelemetry/sdk/metrics/sync_instruments.h	`100.00% <ø> (ø)`
sdk/include/opentelemetry/sdk/trace/recordable.h	`100.00% <ø> (ø)`
sdk/src/metrics/state/metric_collector.cc	`50.00% <0.00%> (ø)`
sdk/src/metrics/meter.cc	`6.32% <83.34%> (+0.07%)`	⬆️
sdk/include/opentelemetry/sdk/trace/span_data.h	`98.67% <87.50%> (ø)`
exporters/ostream/src/metric_exporter.cc	`91.84% <100.00%> (ø)`
exporters/ostream/src/span_exporter.cc	`90.82% <100.00%> (ø)`
exporters/ostream/test/ostream_metric_test.cc	`100.00% <100.00%> (ø)`
... and 8 more

lalitb · 2022-07-21T18:24:57Z

Thanks for the PR. Looks good in general. One suggestion - do you think we should introduce opentelemetry::sdk::instrumentationScope::InstrumentationScope class and start using that for metrics (and probably also for logs). We can later deprecate "InstrumentationLibrary" once we remove it from traces. This way, we also add field attributes in InstrumentationScope as introduced here - open-telemetry/opentelemetry-specification#2579. Should be fine to do this in separate or current PR.

owent · 2022-07-22T02:51:17Z

Thanks for the PR. Looks good in general. One suggestion - do you think we should introduce opentelemetry::sdk::instrumentationScope::InstrumentationScope class and start using that for metrics (and probably also for logs). We can later deprecate "InstrumentationLibrary" once we remove it from traces. This way, we also add field attributes in InstrumentationScope as introduced here - open-telemetry/opentelemetry-specification#2579. Should be fine to do this in separate or current PR.

Agree, do you think if we can rename InstrumentationLibrary to InstrumentationScope and add a alias with using InstrumentationLibrary = InstrumentationScope to keep compatibility for one or two versions? It's a break change to stable trace APIs if we just change the name.

lalitb · 2022-07-22T04:18:15Z

Thanks for the PR. Looks good in general. One suggestion - do you think we should introduce opentelemetry::sdk::instrumentationScope::InstrumentationScope class and start using that for metrics (and probably also for logs). We can later deprecate "InstrumentationLibrary" once we remove it from traces. This way, we also add field attributes in InstrumentationScope as introduced here - open-telemetry/opentelemetry-specification#2579. Should be fine to do this in separate or current PR.

Agree, do you think if we can rename InstrumentationLibrary to InstrumentationScope and add a alias with using InstrumentationLibrary = InstrumentationScope to keep compatibility for one or two versions? It's a break change to stable trace APIs if we just change the name.

Yes, that's a good idea. I was actually thinking to keep both, but your suggestion seems better, as cleanup would be easy.

owent · 2022-07-22T10:42:38Z

Thanks for the PR. Looks good in general. One suggestion - do you think we should introduce opentelemetry::sdk::instrumentationScope::InstrumentationScope class and start using that for metrics (and probably also for logs). We can later deprecate "InstrumentationLibrary" once we remove it from traces. This way, we also add field attributes in InstrumentationScope as introduced here - open-telemetry/opentelemetry-specification#2579. Should be fine to do this in separate or current PR.

Agree, do you think if we can rename InstrumentationLibrary to InstrumentationScope and add a alias with using InstrumentationLibrary = InstrumentationScope to keep compatibility for one or two versions? It's a break change to stable trace APIs if we just change the name.

Yes, that's a good idea. I was actually thinking to keep both, but your suggestion seems better, as cleanup would be easy.

Done

exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_log_recordable.h

sdk/src/trace/tracer_provider.cc

exporters/otlp/src/otlp_metric_utils.cc

exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h

lalitb

LGTM once all the comments are resolved.

lalitb · 2022-07-28T19:59:36Z

This looks good to merge, but being bigger PR, we can wait for @esigo or @ThomsonTan to review it.

owent · 2022-07-29T01:00:33Z

This looks good to merge, but being bigger PR, we can wait for @esigo or @ThomsonTan to review it.

Thanks

esigo

LGTM
Thanks @owent for the PR :)

lalitb · 2022-07-29T17:54:12Z

@owent - Need to rebase this to merge :)

Signed-off-by: owentou <[email protected]>

owent · 2022-07-30T08:06:17Z

@owent - Need to rebase this to merge :)

Thanks and done.

Signed-off-by: owentou <[email protected]>

…lemetry#1507) * Upgrade `instrumentation_library_metrics` to `scope_metrics` Signed-off-by: owentou <[email protected]> * Rename `InstrumentationLibrary` -> `InstrumentationScope` Signed-off-by: owentou <[email protected]> * Fix style Signed-off-by: owentou <[email protected]> * Fix compiling Signed-off-by: owentou <[email protected]> * Remove duplicated `ElasticSearchRecordable::SetInstrumentationLibrary` Signed-off-by: owentou <[email protected]> * Fix comments Signed-off-by: owentou <[email protected]> * Update the usage of `instrumentation_library` of prometheus exporter. Signed-off-by: owentou <[email protected]>

owent requested a review from a team July 20, 2022 05:03

owent force-pushed the Upgrade_instrumentation_library_metrics_to_scope_metrics branch from 1e83f0f to 2e6ad6f Compare July 22, 2022 08:42

lalitb reviewed Jul 25, 2022

View reviewed changes

exporters/otlp/src/otlp_metric_utils.cc Outdated Show resolved Hide resolved

lalitb reviewed Jul 25, 2022

View reviewed changes

exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h Outdated Show resolved Hide resolved

owent force-pushed the Upgrade_instrumentation_library_metrics_to_scope_metrics branch from 648269b to e94545f Compare July 26, 2022 02:44

lalitb reviewed Jul 26, 2022

View reviewed changes

exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h Outdated Show resolved Hide resolved

owent force-pushed the Upgrade_instrumentation_library_metrics_to_scope_metrics branch from e94545f to 6d2bacc Compare July 27, 2022 04:32

lalitb approved these changes Jul 27, 2022

View reviewed changes

bsarden mentioned this pull request Jul 29, 2022

fix(metrics): ostream exporter should print out resource attributes #1523

Merged

esigo approved these changes Jul 29, 2022

View reviewed changes

owent added 6 commits July 30, 2022 16:05

Upgrade instrumentation_library_metrics to scope_metrics

7306fd4

Signed-off-by: owentou <[email protected]>

Rename InstrumentationLibrary -> InstrumentationScope

4fb1920

Signed-off-by: owentou <[email protected]>

Fix style

2e9b0e0

Signed-off-by: owentou <[email protected]>

Fix compiling

9825dac

Signed-off-by: owentou <[email protected]>

Remove duplicated ElasticSearchRecordable::SetInstrumentationLibrary

e742915

Signed-off-by: owentou <[email protected]>

Fix comments

45bc9ea

Signed-off-by: owentou <[email protected]>

owent force-pushed the Upgrade_instrumentation_library_metrics_to_scope_metrics branch from 6d2bacc to 45bc9ea Compare July 30, 2022 08:05

owent mentioned this pull request Jul 30, 2022

Prepare v1.5.0 release #1528

Merged

3 tasks

Update the usage of instrumentation_library of prometheus exporter.

ec2f2bb

Signed-off-by: owentou <[email protected]>

lalitb merged commit 59e7496 into open-telemetry:main Jul 30, 2022

owent deleted the Upgrade_instrumentation_library_metrics_to_scope_metrics branch August 2, 2022 06:12

maxgolov mentioned this pull request Aug 29, 2022

fluentd: resolve compatibility issues with OpenTelemetry C++ SDK v1.6.0 open-telemetry/opentelemetry-cpp-contrib#207

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade `instrumentation_library_metrics` to `scope_metrics` #1507

Upgrade `instrumentation_library_metrics` to `scope_metrics` #1507

owent commented Jul 20, 2022 •

edited

Loading

codecov bot commented Jul 20, 2022 •

edited

Loading

lalitb commented Jul 21, 2022 •

edited

Loading

owent commented Jul 22, 2022

lalitb commented Jul 22, 2022

owent commented Jul 22, 2022

lalitb left a comment

lalitb commented Jul 28, 2022

owent commented Jul 29, 2022

esigo left a comment

lalitb commented Jul 29, 2022

owent commented Jul 30, 2022

Upgrade instrumentation_library_metrics to scope_metrics #1507

Upgrade instrumentation_library_metrics to scope_metrics #1507

Conversation

owent commented Jul 20, 2022 • edited Loading

Changes

codecov bot commented Jul 20, 2022 • edited Loading

Codecov Report

lalitb commented Jul 21, 2022 • edited Loading

owent commented Jul 22, 2022

lalitb commented Jul 22, 2022

owent commented Jul 22, 2022

lalitb left a comment

Choose a reason for hiding this comment

lalitb commented Jul 28, 2022

owent commented Jul 29, 2022

esigo left a comment

Choose a reason for hiding this comment

lalitb commented Jul 29, 2022

owent commented Jul 30, 2022

Upgrade `instrumentation_library_metrics` to `scope_metrics` #1507

Upgrade `instrumentation_library_metrics` to `scope_metrics` #1507

owent commented Jul 20, 2022 •

edited

Loading

codecov bot commented Jul 20, 2022 •

edited

Loading

lalitb commented Jul 21, 2022 •

edited

Loading