feat: Rename Labels to Attributes #2523

pirgeo · 2021-10-06T16:18:54Z

Which problem is this PR solving?

This PR renames Attributes to Labels. No change in behavior is introduced in this PR.
Actually changing the type of Attributes (which are currently still string-string key-value pairs) will happen in a follow-up PR.

The opentelemetry-exporter-otlp-http package uses the Proto definitions in version 0.6.0 (https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.6.0). This release does not have the Attributes field yet. I did not want to update the proto in this PR, since that would also mean updating the hand-rolled implementation in https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/packages/opentelemetry-exporter-otlp-http/src/types.ts, which would make this change much more than a renaming. This is due to breaking changes released in 0.8.0 of the Proto, where the serialization of some instruments to OTLP was changed (see open-telemetry/opentelemetry-proto@v0.6.0...v0.8.0, metrics.proto, line 125 and below). Additionally, #2554 proposes using a shared proto impl, maybe even auto-generated from the proto files. Therefore, the opentelemetry-exporter-otlp-http package is in an intermediate state, where it, in some cases, uses attributes, but still exports lables, due to the old proto version.

Short description of the changes

s/Label/Attribute/

codecov · 2021-10-06T17:04:45Z

Codecov Report

Merging #2523 (fd89ce9) into main (28c9e88) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2523   +/-   ##
=======================================
  Coverage   93.00%   93.00%           
=======================================
  Files         138      138           
  Lines        5092     5092           
  Branches     1095     1095           
=======================================
  Hits         4736     4736           
  Misses        356      356

Impacted Files	Coverage Δ
...exporter-prometheus/src/PrometheusLabelsBatcher.ts
...rter-prometheus/src/PrometheusAttributesBatcher.ts	`100.00% <0.00%> (ø)`

experimental/packages/opentelemetry-api-metrics/src/types/Metric.ts

vmarchaud · 2021-10-09T13:47:33Z

I'm converting it back to draft just to be sure its not merged before #2496

legendecas · 2021-10-17T06:27:27Z

I'm wondering if it can be easier to review if the PR can be split into two PRs: one for renaming and one for attribute value type changes.

legendecas · 2021-10-26T16:38:53Z

@pirgeo hi, #2496 has been merged and you may need a rebase or merging the main branch.

pirgeo · 2021-10-29T09:20:18Z

Sorry for the delay, I think it should be ready for review now!

dyladan

Kind of large PR but seems pretty straightforward. Thanks for doing the work.

legendecas

👍

dyladan · 2021-11-01T16:41:00Z

experimental/packages/opentelemetry-api-metrics/src/types/BatchObserverResult.ts

@@ -14,17 +14,17 @@
 * limitations under the License.
 */

-import { Labels } from './Metric';
+import { Attributes } from './Metric';


According to spec, the attribute interface is now shared between metric and trace. Should we just use the Attributes from the 1.0 API?

https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attributes

That makes sense, but I believe this should happen in a follow-up PR. I assume there will be some breaking changes, especially with #2554 and open-telemetry/opentelemetry-proto#342 (including removing the deprecated labels field) coming up. I am not sure how to best navigate that change, as it seems quite big. I think what needs to happen for that to work is:

Update the Proto to the latest version (as the currently referenced version does not have attributes yet)

Either update the hand-rolled proto implementation, or set up a way of auto-generating JS code from the proto directly.

Then we can update the actual reference of what were labels before to the new attributes.

These things are only somewhat related to the renaming of Labels to Attributes, but without updating the underlying data structures as well as the code, I am not sure we can make this change without breaking the code or tests.

Sounds good. I'll create a follow up story for that.

dyladan · 2021-11-03T14:19:36Z

Conflicts. Conflicts everywhere.

hold off on updating labels to attributes until the proto is updated

dyladan · 2021-11-04T21:23:10Z

@open-telemetry/javascript-maintainers would like one more 👀 at this before merge. It's a simple rename so I think it's pretty safe but I might have missed something.

pragmaticivan · 2021-11-04T21:58:33Z

experimental/packages/opentelemetry-exporter-metrics-otlp-http/src/transformMetrics.ts

@@ -15,7 +15,7 @@
 */

 import { SpanAttributes, HrTime } from '@opentelemetry/api';
-import { Labels, ValueType } from '@opentelemetry/api-metrics';
+import { Attributes as Labels, ValueType } from '@opentelemetry/api-metrics';


Newbie question. On line 30-39 it would not change?

I left it as Labels in this case, since its using the types defined for the 0.6.0 proto (until #2586 is done, probably). The field is called labels in the TS representation of the protobuf, so I kept it that way.

pragmaticivan · 2021-11-08T14:02:06Z

This one is good to go?

dyladan · 2021-11-08T14:02:25Z

Yes

pirgeo requested a review from a team as a code owner October 6, 2021 16:18

pragmaticivan mentioned this pull request Oct 7, 2021

Update Metrics API to latest Feature-Freeze Spec #2480

Closed

14 tasks

pragmaticivan reviewed Oct 7, 2021

View reviewed changes

experimental/packages/opentelemetry-api-metrics/src/types/Metric.ts Outdated Show resolved Hide resolved

vmarchaud marked this pull request as draft October 9, 2021 13:46

dyladan added this to In progress in Metrics API Oct 20, 2021

pirgeo force-pushed the use-attributes branch from fb6c327 to e11d308 Compare October 29, 2021 09:01

pirgeo changed the title ~~feat: Use Attributes instead of Labels~~ feat: Rename Attributes to Labels Oct 29, 2021

pirgeo marked this pull request as ready for review October 29, 2021 09:19

pirgeo changed the title ~~feat: Rename Attributes to Labels~~ feat: Rename Labels to Attributes Oct 29, 2021

dyladan approved these changes Nov 1, 2021

View reviewed changes

Metrics API automation moved this from In progress to Reviewer approved Nov 1, 2021

legendecas approved these changes Nov 1, 2021

View reviewed changes

dyladan reviewed Nov 1, 2021

View reviewed changes

dyladan mentioned this pull request Nov 3, 2021

Allow non-string values for attributes #2585

Closed

4 tasks

pirgeo added 4 commits November 4, 2021 09:12

feat(opentelemetry-api-metrics): rename labels to attributes

3a3c7f2

feat(opentelemetry-sdk-metrics-base): rename labels to attributes

cfa4358

feat(opentelemetry-exporter-prometheus): rename labels to attributes

3b76c24

feat(opentelemetry-exporter-otlp-http): fix otlp http exporter

4d65142

hold off on updating labels to attributes until the proto is updated

pirgeo force-pushed the use-attributes branch from e11d308 to 4d65142 Compare November 4, 2021 08:59

Merge branch 'main' into use-attributes

fdddc15

pragmaticivan reviewed Nov 4, 2021

View reviewed changes

Flarna approved these changes Nov 5, 2021

View reviewed changes

Merge branch 'main' into use-attributes

fd89ce9

obecny approved these changes Nov 5, 2021

View reviewed changes

dyladan merged commit 517a31a into open-telemetry:main Nov 8, 2021

Metrics API automation moved this from Reviewer approved to Done Nov 8, 2021

dyladan deleted the use-attributes branch November 8, 2021 14:02

dyladan added the enhancement New feature or request label Nov 9, 2021

dyladan mentioned this pull request Nov 10, 2021

chore: release proposal v1.0.1 / v0.27.0 #2611

Merged

pirgeo mentioned this pull request Nov 30, 2021

REQUEST: New membership for pirgeo open-telemetry/community#926

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Rename Labels to Attributes #2523

feat: Rename Labels to Attributes #2523

pirgeo commented Oct 6, 2021 •

edited

codecov bot commented Oct 6, 2021 •

edited

vmarchaud commented Oct 9, 2021

legendecas commented Oct 17, 2021

legendecas commented Oct 26, 2021

pirgeo commented Oct 29, 2021

dyladan left a comment

legendecas left a comment

dyladan Nov 1, 2021

pirgeo Nov 2, 2021

dyladan Nov 3, 2021

dyladan commented Nov 3, 2021

dyladan commented Nov 4, 2021

pragmaticivan Nov 4, 2021

pirgeo Nov 5, 2021

pragmaticivan commented Nov 8, 2021

dyladan commented Nov 8, 2021

feat: Rename Labels to Attributes #2523

feat: Rename Labels to Attributes #2523

Conversation

pirgeo commented Oct 6, 2021 • edited

Which problem is this PR solving?

Short description of the changes

codecov bot commented Oct 6, 2021 • edited

Codecov Report

vmarchaud commented Oct 9, 2021

legendecas commented Oct 17, 2021

legendecas commented Oct 26, 2021

pirgeo commented Oct 29, 2021

dyladan left a comment

Choose a reason for hiding this comment

legendecas left a comment

Choose a reason for hiding this comment

dyladan Nov 1, 2021

Choose a reason for hiding this comment

pirgeo Nov 2, 2021

Choose a reason for hiding this comment

dyladan Nov 3, 2021

Choose a reason for hiding this comment

dyladan commented Nov 3, 2021

dyladan commented Nov 4, 2021

pragmaticivan Nov 4, 2021

Choose a reason for hiding this comment

pirgeo Nov 5, 2021

Choose a reason for hiding this comment

pragmaticivan commented Nov 8, 2021

dyladan commented Nov 8, 2021

pirgeo commented Oct 6, 2021 •

edited

codecov bot commented Oct 6, 2021 •

edited