Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sdk-metrics-base): document and export basic APIs #2725

Merged
merged 5 commits into from
Jan 26, 2022

Conversation

legendecas
Copy link
Member

Which problem is this PR solving?

Document and export basic public APIs for implementing an exporter.

Type of change

  • This change requires a documentation update

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@legendecas legendecas requested a review from a team January 20, 2022 03:47
@codecov
Copy link

codecov bot commented Jan 20, 2022

Codecov Report

Merging #2725 (7fd0561) into main (63cff1c) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2725      +/-   ##
==========================================
+ Coverage   93.23%   93.26%   +0.03%     
==========================================
  Files         158      158              
  Lines        5436     5434       -2     
  Branches     1141     1141              
==========================================
  Hits         5068     5068              
+ Misses        368      366       -2     
Impacted Files Coverage Δ
.../opentelemetry-sdk-metrics-base/src/Instruments.ts 57.89% <0.00%> (-11.34%) ⬇️
...pentelemetry-sdk-metrics-base/src/MeterProvider.ts 57.50% <0.00%> (ø)
...telemetry-sdk-metrics-base/src/ObservableResult.ts 100.00% <0.00%> (ø)
...telemetry-sdk-metrics-base/src/view/Aggregation.ts 100.00% <0.00%> (ø)
...elemetry-sdk-metrics-base/src/export/MetricData.ts 100.00% <0.00%> (ø)
...metry-sdk-metrics-base/src/InstrumentDescriptor.ts 100.00% <0.00%> (ø)
...-metrics-base/src/export/AggregationTemporality.ts 100.00% <0.00%> (ø)
...xemplar/AlignedHistogramBucketExemplarReservoir.ts 92.30% <0.00%> (ø)
...ckages/opentelemetry-sdk-metrics-base/src/Meter.ts 97.95% <0.00%> (+3.84%) ⬆️

import { View } from './view/View';

/**
* Supported types of metric instruments.
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument
Copy link
Member

Choose a reason for hiding this comment

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

maybe better to point to a tag/commit instead main which moves day by day.
applies also to other places.

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, like said, the spec is being updated day by day and it has not been released with a "tagged" version yet. I'd remove these links for now.

Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

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

Great work! 👍
Just two nits to make the use of '.' more consistent, feel free to ignore :)

Copy link
Member

@vmarchaud vmarchaud left a comment

Choose a reason for hiding this comment

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

i agree with Flarna that we should pin the version of the spec that the SDK target, may be worth to add it inside the readme too (a beginning of compat matrix) otherwise lgtm

@legendecas legendecas requested a review from a team January 25, 2022 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants