Skip to content

[Metrics SDK] Only record non-negative / finite / Non-NAN histogram values - #1427

Merged
lalitb merged 7 commits into
open-telemetry:mainfrom
lalitb:validate-histogram-value
Jun 3, 2022
Merged

[Metrics SDK] Only record non-negative / finite / Non-NAN histogram values#1427
lalitb merged 7 commits into
open-telemetry:mainfrom
lalitb:validate-histogram-value

Conversation

@lalitb

@lalitb lalitb commented Jun 2, 2022

Copy link
Copy Markdown
Member

Changes

As per the specs, negative values are not allowed to be recorded for the histogram:

Parameters:

  • The amount of the Measurement, which MUST be a non-negative numeric value.
  • Optional attributes.

Also as per specs, NaN and Infinites values should be handled.

The PR validates the value and records only if it is non-negative, valid number, and non-infinite.

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

@lalitb
lalitb requested a review from a team June 2, 2022 20:24
@codecov

codecov Bot commented Jun 2, 2022

Copy link
Copy Markdown

Codecov Report

Merging #1427 (b924f4c) into main (81df64b) will decrease coverage by 0.06%.
The diff coverage is 66.67%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1427      +/-   ##
==========================================
- Coverage   85.37%   85.32%   -0.05%     
==========================================
  Files         152      152              
  Lines        4352     4364      +12     
==========================================
+ Hits         3715     3723       +8     
- Misses        637      641       +4     
Impacted Files Coverage Δ
sdk/src/metrics/sync_instruments.cc 95.24% <66.67%> (-4.76%) ⬇️

@reyang reyang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, consider:

  1. double check how NaN value is handled (e.g. I don't recall if NaN < 0 is true or false)
  2. add a changelog entry

@lalitb

lalitb commented Jun 2, 2022

Copy link
Copy Markdown
Member Author
  • double check how NaN value is handled (e.g. I don't recall if NaN < 0 is true or false)

Good point. NaN < 0 is false, so I think NaN values should be handled separately... I will update this PR.

@lalitb lalitb changed the title [Metrics SDK] Only record non-negative histogram values [Metrics SDK] Only record non-negative / finite / Non-NAN histogram values Jun 2, 2022
@lalitb
lalitb merged commit 62b65fa into open-telemetry:main Jun 3, 2022
lalitb added a commit that referenced this pull request Jun 15, 2022
* install sdk config (#1273)

* Bump actions/cache from 2 to 3 (#1277)

* Add owent as an Approver (#1276)

* add owent as reviewer

* fix order

* Disable benchmark action failure (#1284)

* metrics exemplar round 1 (#1264)

* [Metrics SDK] - fix spelling (AggregationTemporarily to AggregationTemporality) (#1288)

* fix compilation error with protobuf 3.5 (#1289)

* Fix span SetAttribute crash (#1283)

* Synchronous Metric collection (Delta , Cumulative) (#1265)

* Rename `http_client_curl` to `opentelemetry_http_client_curl` (#1301)

Signed-off-by: owent <admin@owent.net>

* Don't show coverage annotation for pull requests (#1304)

* Implement periodic exporting metric reader (#1286)

* Add `async-changes` branch to pull_request of github action (#1309)

Signed-off-by: owent <admin@owent.net>

* Add InstrumentationInfo and Resource to the metrics data to be exported. (#1299)

* Excempt should be applied on issue instead of PR (#1316)

* Bump codecov/codecov-action from 2.1.0 to 3 (#1318)

* Move public definitions into `opentelemetry_api`. (#1314)

Signed-off-by: owent <admin@owent.net>

* Add building test without RTTI (#1294)

* Remove implicitly deleted default constructor (#1267)

Co-authored-by: Tom Tan <Tom.Tan@microsoft.com>
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* [ETW Exporter] - ETW provider handle cleanup (#1322)

* Bump actions/stale from 4 to 5 (#1323)

* ostream metrics example (#1312)

* Prepare v1.3.0 release (#1324)

* Update yield logic for ARM processor (#1325)

* Fix for #1292 (#1326)

* Implement Merge and Diff operation for Histogram Aggregation (#1303)

* fix metrics compiler warnings (#1328)

* Replace deprecated googletest API (#1327)

* Remove redundant tail / in CMake install (#1329)

* dependencies image as artifact (#1333)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* metrics histogram example (#1330)

* Link `opentelemetry_ext` with `opentelemetry_api` (#1336)

* ostream metrics cmake (#1344)

* prometheus exporter (#1331)

* remove exporter registration to meter provider (#1350)

* Bump github/codeql-action from 1 to 2 (#1351)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add explicit type cast in baggage UrlDecode (#1353)

* Fix scalar delete against array (#1356)

* conditional include for codecvt header (#1355)

* Add missing include guard (#1357)

* Use latest TraceLoggingDynamic.h (#1354)

* prometheus example (#1332)

* Fix output time in metrics OStream exporter (#1346)

* Simplify SDK Configuration: Use View with default aggregation if no matching View is configured (#1358)

* Fix class member initialization order (#1360)

* codecov ignore (#1364)

* export opentelemetry_otlp_recordable (#1365)

* Disable test on prometheus-cpp which not need (#1363)

* Enable metric collection for Async Instruments - Delta and Cumulative  (#1334)

* fix baggage propagation for empty/invalid baggage context (#1367)

* Fix empty tracestate header propagation (#1373)

* Bump docker/setup-qemu-action from 1 to 2 (#1375)

* Add noexcept/const qualifier at missing places for Trace API. (#1374)

* fix noxcept

* fix etw

* Bump docker/build-push-action from 2 to 3 (#1377)

* Bump docker/setup-buildx-action from 1 to 2 (#1376)

* [Metrics SDK] Remove un-necessary files. (#1379)

* reuse temporal metric storage for sync storage (#1369)

* Prometheus exporter meters and instrument name (#1378)

* Fix sharing resource in batched exported spans (#1386)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* fix: missing link to nlohmann_json (#1390)

* Getting started document using ostream exporter (#1394)

Co-authored-by: Reiley Yang <reyang@microsoft.com>

* Connect async storage with async instruments (#1388)

* get span_id from context when Logger::Log received invalid span_id  (#1398)

* Alpine image (#1382)

* Upgrade proto to v0.17.0, update log data model (#1383)

* Prepare v1.4.0 release (#1404)

* Fix vcpkg package name in doc (#1392)

* Document Getting Started with Prometheus and Grafana (#1396)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* fix OTEL_INTERNAL_LOG_INFO (#1407)

* fix: WaitOnSocket select error when sockfd above FD_SETSIZE (#1410)

* [BUILD] fix nlohmann_json's (third party) include dir (#1415)

* [Metrics API/SDK] - Pass state to async callback function. (#1408)

* Copy string_view passed to ETW exporter in PropertyVariant (#1425)

* Fix ETW log exporter header inclusion (#1426)

* [Metrics SDK] Only record non-negative / finite / Non-NAN histogram values (#1427)

* validate histogram value

* handle Nan

* add changelog

* divide by 0 error on windows

* fix markdown lint

* Fix global log handle symbols when using dlopen (#1420)

* Add attributes/dimensions to metrics ostream exporter (#1400)

* Log current timestamp instead of epoch time (#1434)

* install sdk-config.h (#1419)

* Fix GettingStarted documentation for Jaeger HTTP exporter (#1347) (#1439)

* fix histogram (#1440)

* Upgrade nlohmann_json to 3.10.5 (#1438) (#1441)

* Fixed broken link to OpenTelemetry.io (#1445) (#1446)

Co-authored-by: Ehsan Saei <71217171+esigo@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>
Co-authored-by: Tom Tan <Tom.Tan@microsoft.com>
Co-authored-by: Ben Landrum <71329856+benlandrum@users.noreply.github.com>
Co-authored-by: jmanjon <67091862+juandemanjon@users.noreply.github.com>
Co-authored-by: Zsolt Bölöny <bolony.zsolt@gmail.com>
Co-authored-by: Leo Di Donato <leodidonato@gmail.com>
Co-authored-by: Reiley Yang <reyang@microsoft.com>
Co-authored-by: Lalit Kumar Bhasin <labhas@microsoft.com>
Co-authored-by: Hamed Mansouri <hamed0381@gmail.com>
Co-authored-by: ztao <t@taozj.org>
Co-authored-by: Flier Lu <flier@users.noreply.github.com>
Co-authored-by: Marc Alff <marc.alff@free.fr>
Co-authored-by: Marc Alff <marc.alff@oracle.com>
owent added a commit that referenced this pull request Jun 17, 2022
* install sdk config (#1273)

* Bump actions/cache from 2 to 3 (#1277)

* Add owent as an Approver (#1276)

* add owent as reviewer

* fix order

* Disable benchmark action failure (#1284)

* metrics exemplar round 1 (#1264)

* [Metrics SDK] - fix spelling (AggregationTemporarily to AggregationTemporality) (#1288)

* fix compilation error with protobuf 3.5 (#1289)

* Fix span SetAttribute crash (#1283)

* Synchronous Metric collection (Delta , Cumulative) (#1265)

* Rename `http_client_curl` to `opentelemetry_http_client_curl` (#1301)

Signed-off-by: owent <admin@owent.net>

* Don't show coverage annotation for pull requests (#1304)

* Implement periodic exporting metric reader (#1286)

* Add `async-changes` branch to pull_request of github action (#1309)

Signed-off-by: owent <admin@owent.net>

* Add InstrumentationInfo and Resource to the metrics data to be exported. (#1299)

* Excempt should be applied on issue instead of PR (#1316)

* Bump codecov/codecov-action from 2.1.0 to 3 (#1318)

* Move public definitions into `opentelemetry_api`. (#1314)

Signed-off-by: owent <admin@owent.net>

* Add building test without RTTI (#1294)

* Remove implicitly deleted default constructor (#1267)

Co-authored-by: Tom Tan <Tom.Tan@microsoft.com>
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* [ETW Exporter] - ETW provider handle cleanup (#1322)

* Bump actions/stale from 4 to 5 (#1323)

* ostream metrics example (#1312)

* Prepare v1.3.0 release (#1324)

* Update yield logic for ARM processor (#1325)

* Fix for #1292 (#1326)

* Implement Merge and Diff operation for Histogram Aggregation (#1303)

* fix metrics compiler warnings (#1328)

* Replace deprecated googletest API (#1327)

* Remove redundant tail / in CMake install (#1329)

* dependencies image as artifact (#1333)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* metrics histogram example (#1330)

* Link `opentelemetry_ext` with `opentelemetry_api` (#1336)

* ostream metrics cmake (#1344)

* prometheus exporter (#1331)

* remove exporter registration to meter provider (#1350)

* Bump github/codeql-action from 1 to 2 (#1351)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add explicit type cast in baggage UrlDecode (#1353)

* Fix scalar delete against array (#1356)

* conditional include for codecvt header (#1355)

* Add missing include guard (#1357)

* Use latest TraceLoggingDynamic.h (#1354)

* prometheus example (#1332)

* Fix output time in metrics OStream exporter (#1346)

* Simplify SDK Configuration: Use View with default aggregation if no matching View is configured (#1358)

* Fix class member initialization order (#1360)

* codecov ignore (#1364)

* export opentelemetry_otlp_recordable (#1365)

* Disable test on prometheus-cpp which not need (#1363)

* Enable metric collection for Async Instruments - Delta and Cumulative  (#1334)

* fix baggage propagation for empty/invalid baggage context (#1367)

* Fix empty tracestate header propagation (#1373)

* Bump docker/setup-qemu-action from 1 to 2 (#1375)

* Add noexcept/const qualifier at missing places for Trace API. (#1374)

* fix noxcept

* fix etw

* Bump docker/build-push-action from 2 to 3 (#1377)

* Bump docker/setup-buildx-action from 1 to 2 (#1376)

* [Metrics SDK] Remove un-necessary files. (#1379)

* reuse temporal metric storage for sync storage (#1369)

* Prometheus exporter meters and instrument name (#1378)

* Fix sharing resource in batched exported spans (#1386)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* fix: missing link to nlohmann_json (#1390)

* Getting started document using ostream exporter (#1394)

Co-authored-by: Reiley Yang <reyang@microsoft.com>

* Connect async storage with async instruments (#1388)

* get span_id from context when Logger::Log received invalid span_id  (#1398)

* Alpine image (#1382)

* Upgrade proto to v0.17.0, update log data model (#1383)

* Prepare v1.4.0 release (#1404)

* Fix vcpkg package name in doc (#1392)

* Document Getting Started with Prometheus and Grafana (#1396)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

* fix OTEL_INTERNAL_LOG_INFO (#1407)

* fix: WaitOnSocket select error when sockfd above FD_SETSIZE (#1410)

* [BUILD] fix nlohmann_json's (third party) include dir (#1415)

* [Metrics API/SDK] - Pass state to async callback function. (#1408)

* Copy string_view passed to ETW exporter in PropertyVariant (#1425)

* Fix ETW log exporter header inclusion (#1426)

* [Metrics SDK] Only record non-negative / finite / Non-NAN histogram values (#1427)

* validate histogram value

* handle Nan

* add changelog

* divide by 0 error on windows

* fix markdown lint

* Fix global log handle symbols when using dlopen (#1420)

* Add attributes/dimensions to metrics ostream exporter (#1400)

* Log current timestamp instead of epoch time (#1434)

* install sdk-config.h (#1419)

* Fix GettingStarted documentation for Jaeger HTTP exporter (#1347) (#1439)

* fix histogram (#1440)

* Upgrade nlohmann_json to 3.10.5 (#1438) (#1441)

* Fixed broken link to OpenTelemetry.io (#1445) (#1446)

* Fix variables inizialization (#1430)

* Remove `AsyncBatch*Processor`, implement [opentelemetry-specification#2452](open-telemetry/opentelemetry-specification#2452)

Signed-off-by: WenTao Ou <admin@owent.net>

* Remove invalid changelog

Signed-off-by: WenTao Ou <admin@owent.net>

* Fix compiling problems without `ENABLE_ASYNC_EXPORT`

Signed-off-by: WenTao Ou <admin@owent.net>

* Always return `ExportResult::kSuccess`

Signed-off-by: WenTao Ou <admin@owent.net>

Co-authored-by: Ehsan Saei <71217171+esigo@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>
Co-authored-by: Tom Tan <Tom.Tan@microsoft.com>
Co-authored-by: Ben Landrum <71329856+benlandrum@users.noreply.github.com>
Co-authored-by: jmanjon <67091862+juandemanjon@users.noreply.github.com>
Co-authored-by: Zsolt Bölöny <bolony.zsolt@gmail.com>
Co-authored-by: Leo Di Donato <leodidonato@gmail.com>
Co-authored-by: Reiley Yang <reyang@microsoft.com>
Co-authored-by: Lalit Kumar Bhasin <labhas@microsoft.com>
Co-authored-by: Hamed Mansouri <hamed0381@gmail.com>
Co-authored-by: ztao <t@taozj.org>
Co-authored-by: Flier Lu <flier@users.noreply.github.com>
Co-authored-by: Marc Alff <marc.alff@free.fr>
Co-authored-by: Marc Alff <marc.alff@oracle.com>
Co-authored-by: univisionsrl <31103417+univisionsrl@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants