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.

Sign up for GitHub

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

fix(api): deprecate MetricAttributes and MetricAttributeValue #3406

Merged
merged 5 commits into from
Nov 16, 2022
Merged

fix(api): deprecate MetricAttributes and MetricAttributeValue #3406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d1c89f7
docs: fix comment in metrics api refering to span
Nov 12, 2022
1ae7563
fix(api): deprecate MetricsAttributes and MetricAttributeValue
Nov 12, 2022
de0da6f
fix: typo in changelog
Nov 12, 2022
56f276b
Merge branch 'main' into metrics-comment
dyladan Nov 14, 2022
041f2a0
Merge branch 'main' into metrics-comment
dyladan Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.

## Unreleased

* fix(api): deprecate MetricAttributes and MetricAttributeValue [#3406](https://github.com/open-telemetry/opentelemetry-js/pull/3406) @blumamir
* test(api): disable module concatenation in tree-shaking test [#3409](https://github.com/open-telemetry/opentelemetry-js/pull/3409) @legendecas

## [1.3.0](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.2.0...v1.3.0)
Expand Down
10 changes: 2 additions & 8 deletions api/src/metrics/Metric.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,13 @@ export interface Histogram<AttributesTypes extends MetricAttributes = MetricAttr
record(value: number, attributes?: AttributesTypes, context?: Context): void;
}

// api.SpanAttributes instead of api.Attributes is used here for api package backward compatibility.
/**
* Attributes is a map from string to attribute values.
*
* Note: only the own enumerable keys are counted as valid attribute keys.
* @deprecated please use {@link Attributes}
*/
export type MetricAttributes = Attributes;

// api.SpanAttributeValue instead of api.AttributeValue is used here for api package backward compatibility.
/**
* Attribute values may be any non-nullish primitive value except an object.
*
* null or undefined attribute values are invalid and will result in undefined behavior.
* @deprecated please use {@link AttributeValue}
*/
export type MetricAttributeValue = AttributeValue;

Expand Down