[SDK] Implement spec: MetricFilter #3235

IcySteam · 2025-01-09T11:15:28Z

Fixes #2447

Changes

This PR implements the MetricFilter spec in opentelemetry-cpp.

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
- MetricProducer::MetricProducer
- MetricCollector::MetricCollector
- MeterContext::AddMetricReader
- MeterProvider::AddMetricReader

linux-foundation-easycla · 2025-01-09T11:15:34Z

The committers listed above are authorized under a signed CLA.

✅ login: IcySteam / name: IcySteam (fcf9b60, 0451db6, 244f223)
✅ login: lalitb / name: Lalit Kumar Bhasin (fa1bef7)
✅ login: marcalff / name: Marc Alff (8d47981)

netlify · 2025-01-09T11:17:32Z

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name	Link
🔨 Latest commit	`8d47981`
🔍 Latest deploy log	https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/67d0b52ec5a8e40009fd0e8d

marcalff · 2025-01-11T17:07:19Z

@IcySteam

Thanks for the PR.

Please remember to sign the EasyCLA, so this PR can be processed.

codecov · 2025-01-12T11:08:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.49%. Comparing base (64a74bf) to head (8d47981).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3235      +/-   ##
==========================================
+ Coverage   89.41%   89.49%   +0.08%     
==========================================
  Files         207      208       +1     
  Lines        6458     6497      +39     
==========================================
+ Hits         5774     5814      +40     
+ Misses        684      683       -1

Files with missing lines	Coverage Δ
...e/opentelemetry/sdk/metrics/export/metric_filter.h	`100.00% <100.00%> (ø)`
...opentelemetry/sdk/metrics/export/metric_producer.h	`100.00% <100.00%> (ø)`
...opentelemetry/sdk/metrics/state/metric_collector.h	`100.00% <ø> (ø)`
sdk/src/metrics/meter_context.cc	`77.34% <100.00%> (ø)`
sdk/src/metrics/meter_provider.cc	`87.18% <100.00%> (ø)`
sdk/src/metrics/state/metric_collector.cc	`93.23% <100.00%> (+6.13%)`	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

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

lalitb · 2025-01-16T16:06:07Z

@IcySteam Thanks for the PR. I believe you are working to get the CLA signed, as the PR can't be reviewed without that.

IcySteam · 2025-01-17T18:47:11Z

Thanks for the reminder @marcalff and @lalitb, CLA signing should be all done now.

marcalff

Thanks for the contribution, and for signing the CLA.

Before looking in more details at the code,
please see some preliminary comments below.

There should be no changes in third_party/opentelemetry-proto.

Please make sure to initialize and update git submodules in your branch.

Please check the "include-what-you-use" build in CI for warnings,
and fix the code to resolve them.

There should be no more warnings in the PR compared to the main branch.

More comments to follow.

lalitb · 2025-01-28T21:38:33Z

sdk/include/opentelemetry/sdk/metrics/meter_context.h

-  void AddMetricReader(std::shared_ptr<MetricReader> reader) noexcept;
+  std::shared_ptr<MetricCollector> AddMetricReader(
+      std::shared_ptr<MetricReader> reader,
+      std::unique_ptr<MetricFilter> metric_filter = nullptr) noexcept;


This was righty pointed out by @marcalff in community meeting - does this method need to return shared_ptr?

@IcySteam It looks like you've now changed it to return a weak_ptr. Sorry I was not clear earlier, the question was—why does this method need to return anything at all?

@lalitb Returning the MetricCollector created by the MeterContext does seem like one of the only few ways to access the MetricCollector, as it is needed by MetricCollectorTest. Extending MetricCollector with a test class is also potentially viable, but that would require changing some of MetricCollector's private members to protected (or a friend class). What are your thoughts on writing proper tests in this case?

IcySteam · 2025-02-04T01:08:22Z

@lalitb Thanks for approving the CI workflows as always; for some reason, cmake.dll.test still fails due to apparently -- Performing Test CMAKE_HAVE_LIBC_PTHREAD - Failed. Is this a bug with the CI workflow, since nothing I changed in this PR should affect it? How could I fix this?

IcySteam · 2025-02-11T05:46:11Z

Hi @lalitb, I've pushed another commit which uses a MetricCollectorTest friend class instead of changing MeterContext's AddMetricReader. PTAL

lalitb · 2025-02-11T07:29:22Z

Hi @lalitb, I've pushed another commit which uses a MetricCollectorTest friend class instead of changing MeterContext's AddMetricReader. PTAL

Thanks @IcySteam can you also resolve the conflict, so that CI can be triggered. I will be reviewing it during this week.

IcySteam · 2025-03-03T02:37:49Z

Hi @lalitb, I've resolved the merge conflicts from the latest upstream changes. Have you had the chance to review the PR yet? Thanks.

lalitb · 2025-03-04T23:40:19Z

Hi @lalitb, I've resolved the merge conflicts from the latest upstream changes. Have you had the chance to review the PR yet? Thanks.

Thanks @IcySteam. Couldn't review it for other priorities, will do it this week.

lalitb · 2025-03-05T18:01:26Z

sdk/test/metrics/metric_collector_test.cc

+  auto context = std::shared_ptr<MeterContext>(new MeterContext(ViewRegistryFactory::Create()));
+  auto scope   = InstrumentationScope::Create("CollectWithMetricFilterTestMetricTest1");
+  auto meter   = std::shared_ptr<Meter>(new Meter(context, std::move(scope)));
+  context->AddMeter(meter);


nit - there can be a helper method to create Meter, and used across tests.

Thanks for the comment; since context and meter are directly needed by the test code below, creating a helper method here to create meter might not simplify much. We could use a common meter between test cases, but that would require us to make sure there are no duplicate instrument names. Do you think it would be better if we used a common meter?

Good point. I believe we can leave it as for now, and can improve later.

lalitb · 2025-03-05T18:20:20Z

sdk/src/metrics/state/metric_collector.cc

+        if (attributes_filter_result == MetricFilter::AttributesFilterResult::kAccept)
+        {
+          filtered_point_data_attrs.emplace_back(std::move(point_data_attr));
+        }


Can we reuse the existing vector by filtering in-place?

We could reuse the existing metric.point_data_attr_ here by deleting the filtered entries from it, but I think in this case it would be slower than creating a new vector and std::moveing the wanted entries to it.

Agree. This looks good.

lalitb

LGTM. Thanks for implementing this.

marcalff

LGTM, thanks for the feature.

IcySteam requested a review from a team as a code owner January 9, 2025 11:15

IcySteam force-pushed the otel-metricfilter-fn branch 3 times, most recently from bbd4ca5 to 9e8e4b7 Compare January 9, 2025 11:54

marcalff added the pr:waiting-on-cla Waiting on CLA label Jan 9, 2025

IcySteam force-pushed the otel-metricfilter-fn branch 4 times, most recently from d6f5504 to 1473ebe Compare January 11, 2025 16:49

IcySteam force-pushed the otel-metricfilter-fn branch 3 times, most recently from e0d8498 to 9c3f930 Compare January 12, 2025 10:38

IcySteam force-pushed the otel-metricfilter-fn branch 3 times, most recently from a36ed14 to a4384fa Compare January 13, 2025 16:08

marcalff removed the pr:waiting-on-cla Waiting on CLA label Jan 13, 2025

IcySteam force-pushed the otel-metricfilter-fn branch from a4384fa to 4bff481 Compare January 17, 2025 18:45

IcySteam force-pushed the otel-metricfilter-fn branch from 4bff481 to 7b19eb4 Compare January 18, 2025 05:50

marcalff reviewed Jan 20, 2025

View reviewed changes

marcalff self-assigned this Jan 22, 2025

lalitb self-assigned this Jan 24, 2025

lalitb reviewed Jan 28, 2025

View reviewed changes

IcySteam force-pushed the otel-metricfilter-fn branch 2 times, most recently from 72cbd97 to de7b80e Compare January 29, 2025 04:43

IcySteam force-pushed the otel-metricfilter-fn branch from de7b80e to 0421775 Compare February 3, 2025 15:09

IcySteam force-pushed the otel-metricfilter-fn branch from ca24682 to 0c944f1 Compare February 11, 2025 05:43

IcySteam force-pushed the otel-metricfilter-fn branch 2 times, most recently from eea4047 to 8fa2622 Compare February 14, 2025 04:31

IcySteam force-pushed the otel-metricfilter-fn branch from 8fa2622 to 8dd3291 Compare February 19, 2025 05:03

IcySteam force-pushed the otel-metricfilter-fn branch from 8dd3291 to 085ad96 Compare March 3, 2025 02:36

IcySteam added 3 commits March 5, 2025 14:49

otel-metricfilter-fn

fcf9b60

Fix IWYU

0451db6

Use MetricCollectorTest friend class

244f223

IcySteam force-pushed the otel-metricfilter-fn branch from 085ad96 to 244f223 Compare March 5, 2025 03:51

marcalff mentioned this pull request Mar 5, 2025

[RELEASE] Prepare release opentelemetry-cpp 1.20.0 #3291

Closed

lalitb reviewed Mar 5, 2025

View reviewed changes

Merge branch 'main' into otel-metricfilter-fn

fa1bef7

lalitb approved these changes Mar 11, 2025

View reviewed changes

marcalff approved these changes Mar 11, 2025

View reviewed changes

Merge branch 'main' into otel-metricfilter-fn

8d47981

marcalff merged commit dee5b0b into open-telemetry:main Mar 11, 2025
58 checks passed

BrewTestBot mentioned this pull request Apr 1, 2025

opentelemetry-cpp 1.20.0 Homebrew/homebrew-core#217631

Merged

yashykt mentioned this pull request May 15, 2025

SDK's MetricProducer API needs cleanup #3412

Closed

[SDK] Implement spec: MetricFilter #3235

[SDK] Implement spec: MetricFilter #3235

Uh oh!

Conversation

IcySteam commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

linux-foundation-easycla bot commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Uh oh!

marcalff commented Jan 11, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

lalitb commented Jan 16, 2025

Uh oh!

IcySteam commented Jan 17, 2025

Uh oh!

marcalff left a comment

Choose a reason for hiding this comment

Uh oh!

lalitb Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

lalitb Jan 29, 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!

IcySteam Feb 3, 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!

IcySteam commented Feb 4, 2025

Uh oh!

IcySteam commented Feb 11, 2025

Uh oh!

lalitb commented Feb 11, 2025

Uh oh!

IcySteam commented Mar 3, 2025

Uh oh!

lalitb commented Mar 4, 2025

Uh oh!

lalitb Mar 5, 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!

IcySteam Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

lalitb Mar 11, 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!

lalitb Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

IcySteam Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

lalitb Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

lalitb left a comment

Choose a reason for hiding this comment

Uh oh!

marcalff left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

IcySteam commented Jan 9, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jan 9, 2025 •

edited

Loading

netlify bot commented Jan 9, 2025 •

edited

Loading

codecov bot commented Jan 12, 2025 •

edited

Loading

lalitb Jan 29, 2025 •

edited

Loading

IcySteam Feb 3, 2025 •

edited

Loading

lalitb Mar 5, 2025 •

edited

Loading

lalitb Mar 11, 2025 •

edited

Loading