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

Use same language as W3C TC spec #181

Closed
c24t opened this issue Jul 12, 2019 · 3 comments
Closed

Use same language as W3C TC spec #181

c24t opened this issue Jul 12, 2019 · 3 comments
Labels
needs discussion Need more information before all suitable labels can be applied question Question for discussion
Milestone

Comments

@c24t
Copy link
Member

c24t commented Jul 12, 2019

Motivated by @mayurkale22 and @reyang's comments on the trace state in the python client.

We use different language in the OT spec and W3C spec: "span ID" instead of "parent-id", TraceOptions instead of "trace-flags", and (in the java and js clients) "sampled" instead of "recorded". This is a minor issue at best, but may be confusing to newcomers.

Should we use the W3C terms or resolve to use our own?

@c24t c24t added the question Question for discussion label Jul 12, 2019
@reyang
Copy link
Member

reyang commented Jul 12, 2019

options versus flags seems to be a personal taste, aligning with the W3C spec would be great.

Regarding parent-id, this is what we have in OpenCensus and it is sometimes confusing:

[SpanData(name='span1_child2', context=SpanContext(trace_id=5307201ee66cb0de85dc049c6470f046, span_id=31101d982462798f, trace_options=TraceOptions(enabled=True), tracestate=None), span_id='dfd42fc07f7e519a', parent_span_id='31101d982462798f', attributes=BoundedDict({}, maxlen=32), start_time='2019-07-12T01:04:21.347327Z', end_time='2019-07-12T01:04:21.347327Z', child_span_count=0, stack_trace=None, annotations=BoundedList([], maxlen=32), message_events=BoundedList([], maxlen=128), links=BoundedList([], maxlen=32), status=None, same_process_as_parent_span=None, span_kind=0)]

It might be better if it is:

[SpanData(name='span1_child2', context=SpanContext(trace_id=5307201ee66cb0de85dc049c6470f046, parent_id=31101d982462798f, trace_options=TraceOptions(enabled=True), tracestate=None), id='dfd42fc07f7e519a', parent_id='31101d982462798f', attributes=BoundedDict({}, maxlen=32), start_time='2019-07-12T01:04:21.347327Z', end_time='2019-07-12T01:04:21.347327Z', child_span_count=0, stack_trace=None, annotations=BoundedList([], maxlen=32), message_events=BoundedList([], maxlen=128), links=BoundedList([], maxlen=32), status=None, same_process_as_parent_span=None, span_kind=0)]

@iredelmeier iredelmeier added the needs discussion Need more information before all suitable labels can be applied label Jul 30, 2019
@bogdandrutu
Copy link
Member

TraceOptions was already renamed to TraceFlags.
w3c uses sampled now.

Anything else to discuss here? May worth closing and open the parent discussion if you feel that way.

@bogdandrutu bogdandrutu added this to the Alpha v0.3 milestone Sep 30, 2019
@SergeyKanzhelev
Copy link
Member

seems to be fixed now

TuckTuckFloof pushed a commit to TuckTuckFloof/opentelemetry-specification that referenced this issue Oct 15, 2020
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 21, 2024
Fixes open-telemetry#1989

OTEP 0152 predates renaming of labels to attributes in the spec. Unfortunately
the schema file format still uses the term "label" in the metrics section this way:
```yaml
    metrics:
      changes:
        - rename_labels:
            label_map:
              # map of key/values. The keys are the old label name used
              # in the previous version, the values are the new label name
              # starting from this version.

            apply_to_metrics:
              # Optional. If it is missing the transformation is applied
              # to all metrics. If it is present the transformation is applied
              # only to the metrics with the name that is found in the sequence
              # specified below.
```

We don't want the word `label` in the schema files, instead we want the word
`attribute` to be used instead.

Discussed in spec meeting, decided:
- OTEPs which are not part of the spec repo are not considered to be final,
  or be an actual part of stable spec (OTEPs are not labeled "stable" in any way).
- Modify the OTEP, rename `label` to `attribute` (this commit).
- Merge the OTEP with the spec.
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 23, 2024
Fixes open-telemetry#1989

OTEP 0152 predates renaming of labels to attributes in the spec. Unfortunately
the schema file format still uses the term "label" in the metrics section this way:
```yaml
    metrics:
      changes:
        - rename_labels:
            label_map:
              # map of key/values. The keys are the old label name used
              # in the previous version, the values are the new label name
              # starting from this version.

            apply_to_metrics:
              # Optional. If it is missing the transformation is applied
              # to all metrics. If it is present the transformation is applied
              # only to the metrics with the name that is found in the sequence
              # specified below.
```

We don't want the word `label` in the schema files, instead we want the word
`attribute` to be used instead.

Discussed in spec meeting, decided:
- OTEPs which are not part of the spec repo are not considered to be final,
  or be an actual part of stable spec (OTEPs are not labeled "stable" in any way).
- Modify the OTEP, rename `label` to `attribute` (this commit).
- Merge the OTEP with the spec.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs discussion Need more information before all suitable labels can be applied question Question for discussion
Projects
None yet
Development

No branches or pull requests

5 participants