Make SpanContext Immutable #1573

Aneurysm9 · 2021-02-23T19:00:13Z

Adds NewSpanContext() constructor and SpanContextConfig{} struct for constructing a new SpanContext when all fields are known
Adds With() methods to SpanContext for deriving a SpanContext with a single field changed.
Updates all uses of SpanContext to use the new API

* Adds NewSpanContext() constructor and SpanContextConfig{} struct for constructing a new SpanContext when all fields are known * Adds With<field>() methods to SpanContext for deriving a SpanContext with a single field changed. * Updates all uses of SpanContext to use the new API Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>

Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>

codecov · 2021-02-23T19:07:49Z

Codecov Report

Merging #1573 (a54d665) into main (d75e268) will increase coverage by 0.1%.
The diff coverage is 92.4%.

@@           Coverage Diff           @@
##            main   #1573     +/-   ##
=======================================
+ Coverage   77.1%   77.2%   +0.1%     
=======================================
  Files        128     128             
  Lines       6742    6799     +57     
=======================================
+ Hits        5203    5254     +51     
- Misses      1288    1294      +6     
  Partials     251     251

Impacted Files	Coverage Δ
bridge/opencensus/bridge.go	`84.9% <0.0%> (ø)`
trace/trace.go	`86.1% <81.8%> (-0.6%)`	⬇️
oteltest/tracer.go	`93.0% <87.5%> (ø)`
bridge/opencensus/utils/utils.go	`100.0% <100.0%> (ø)`
bridge/opentracing/internal/mock.go	`74.5% <100.0%> (+0.2%)`	⬆️
exporters/otlp/internal/otlptest/data.go	`61.7% <100.0%> (ø)`
exporters/otlp/internal/transform/span.go	`98.1% <100.0%> (+<0.1%)`	⬆️
exporters/trace/jaeger/jaeger.go	`93.7% <100.0%> (+0.1%)`	⬆️
exporters/trace/zipkin/model.go	`98.6% <100.0%> (ø)`
oteltest/config.go	`92.5% <100.0%> (+0.6%)`	⬆️
... and 4 more

…y-go into OTG-1515

bogdandrutu

As a general rule that I would apply is that limit as much as possible the public API at this moment :)

trace/trace.go

bogdandrutu · 2021-02-24T01:44:18Z

@Aneurysm9 my comment is very generic if you have good usecases you can ignore it. It was more like I want to make sure this is how we think about the API :)

Aneurysm9 · 2021-02-24T01:49:20Z

@Aneurysm9 my comment is very generic if you have good usecases you can ignore it. It was more like I want to make sure this is how we think about the API :)

100% agreed. I started with just the NewSpanContext() API and expanded as I encountered uses that weren't well suited to that interface. I think it's good to question those decisions and thus why I left this as a draft and asked for feedback. Do you think additional documentation around the With* or MarshalJSON() APIs would be useful?

…y-go into OTG-1515

Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>

trace/trace.go

CHANGELOG.md

sdk/trace/batch_span_processor_test.go

sdk/trace/benchmark_test.go

…y-go into OTG-1515

- Generate `semconv/v1.31.0` - Stop generating deprecated metric semconv similar to all other generation - Fix acronyms: - `ReplicationController` - `ResourceQuota` ## [`v1.31.0` semantic convention release notes](https://github.com/open-telemetry/semantic-conventions/releases/tag/v1.31.0): <h3>🛑 Breaking changes 🛑</h3> <ul> <li> <code>code</code>: <code>code.function.name</code> value should contain the fully qualified function name, <code>code.namespace</code> is now deprecated (<a href="open-telemetry/semantic-conventions#1677" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1677/hovercard">#1677</a>) </li> <li> <code>gen-ai</code>: Introduce <code>gen_ai.output.type</code>and deprecate <code>gen_ai.openai.request.response_format</code> (<a href="open-telemetry/semantic-conventions#1757" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1757/hovercard">#1757</a>) </li> <li> <code>mobile</code>: Rework <code>device.app.lifecycle</code> mobile event. (<a href="open-telemetry/semantic-conventions#1880" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1880/hovercard">#1880</a>) The <code>device.app.lifecycle</code> event has been reworked to use attributes instead of event body fields. The <code>ios.app.state</code> and <code>android.app.state</code> attributes have been reintroduced to the attribute registry. </li> <li> <code>system</code>: Move CPU-related system.cpu.* metrics to CPU namespace (<a href="open-telemetry/semantic-conventions#1873" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1873/hovercard">#1873</a>) </li> <li> <code>k8s</code>: Change k8s.replication_controller metrics to k8s.replicationcontroller (<a href="open-telemetry/semantic-conventions#1848" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1848/hovercard">#1848</a>) </li> <li> <code>db</code>: Rename <code>db.system</code> to <code>db.system.name</code> in database metrics, and update the values to be consistent with database spans. (<a href="open-telemetry/semantic-conventions#1581" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1581/hovercard">#1581</a>) </li> <li> <code>session</code>: Move <code>session.id</code> and <code>session.previous_id</code> from body fields to event attributes, and yamlize <code>session.start</code> and <code>session.end</code> events. (<a href="open-telemetry/semantic-conventions#1845" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1845/hovercard">#1845</a>) As part of the ongoing migration of event fields from LogRecord body to extended/complex attributes, the <code>session.start</code> and <code>session.end</code> events have been redefined. </li> </ul> <h3>💡 Enhancements 💡</h3> <ul> <li> <code>code</code>: Mark <code>code.*</code> semantic conventions as release candidate (<a href="open-telemetry/semantic-conventions#1377" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1377/hovercard">#1377</a>) </li> <li> <code>gen-ai</code>: Added AI Agent Semantic Convention (<a href="open-telemetry/semantic-conventions#1732" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1732/hovercard">#1732</a>, <a href="open-telemetry/semantic-conventions#1739" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1739/hovercard">#1739</a>) </li> <li> <code>db</code>: Add database-specific notes on db.operation.name and db.collection.name for Cassandra, Cosmos DB, HBase, MongoDB, and Redis, covering their batch/bulk terms and lack of cross-table queries. (<a href="open-telemetry/semantic-conventions#1863" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1863/hovercard">#1863</a>, <a href="open-telemetry/semantic-conventions#1573" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1573/hovercard">#1573</a>) </li> <li> <code>gen-ai</code>: Adds <code>gen_ai.request.choice.count</code> span attribute (<a href="open-telemetry/semantic-conventions#1888" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1888/hovercard">#1888</a>) Enables recording target number of completions to generate </li> <li> <code>enduser</code>: Undeprecate 'enduser.id' and introduce new attribute <code>enduser.pseudo.id</code> (<a href="open-telemetry/semantic-conventions#1104" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1104/hovercard">#1104</a>) The new attribute <code>enduser.pseudo.id</code> is intended to provide a unique identifier of a pseudonymous enduser. </li> <li> <code>k8s</code>: Add <code>k8s.hpa</code>, <code>k8s.resourcequota</code> and <code>k8s.replicationcontroller</code> attributes and resources (<a href="open-telemetry/semantic-conventions#1656" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1656/hovercard">#1656</a>) </li> <li> <code>k8s</code>: How to populate resource attributes based on attributes, labels and transformation (<a href="open-telemetry/semantic-conventions#236" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/236/hovercard">#236</a>) </li> <li> <code>process</code>: Adjust the semantic expectations for <code>process.executable.name</code> (<a href="open-telemetry/semantic-conventions#1736" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1736/hovercard">#1736</a>) </li> <li> <code>otel</code>: Adds SDK self-monitoring metrics for span processing (<a href="open-telemetry/semantic-conventions#1631" data-hovercard-type="pull_request" data-hovercard-url="/open-telemetry/semantic-conventions/pull/1631/hovercard">#1631</a>) </li> <li> <code>cicd</code>: Adds a new attribute <code>cicd.pipeline.run.url.full</code> and corrects the attribute description of <code>cicd.pipeline.task.run.url.full</code> (<a href="open-telemetry/semantic-conventions#1796" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1796/hovercard">#1796</a>) </li> <li> <code>user-agent</code>: Add <code>user_agent.os.name</code> and <code>user_agent.os.version</code> attributes (<a href="open-telemetry/semantic-conventions#1433" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1433/hovercard">#1433</a>) </li> </ul> <h3>🧰 Bug fixes 🧰</h3> <ul> <li><code>process</code>: Fix units of process.open_file_descriptor.count and process.context_switches (<a href="open-telemetry/semantic-conventions#1662" data-hovercard-type="issue" data-hovercard-url="/open-telemetry/semantic-conventions/issues/1662/hovercard">#1662</a>)</li> </ul> --------- Co-authored-by: Robert Pająk <pellared@hotmail.com>

Aneurysm9 added 2 commits February 23, 2021 13:55

Update CHANGELOG.md

975d2aa

Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>

Aneurysm9 requested review from rakyll, bogdandrutu and MrAlias February 23, 2021 19:11

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

7afb15a

…y-go into OTG-1515

bogdandrutu reviewed Feb 24, 2021

View reviewed changes

trace/trace.go Show resolved Hide resolved

trace/trace.go Show resolved Hide resolved

Aneurysm9 added 2 commits February 25, 2021 12:49

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

550d903

…y-go into OTG-1515

Add tests for new SpanContext constructor and derivation

aff859c

Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>

Aneurysm9 marked this pull request as ready for review February 26, 2021 20:23

Aneurysm9 requested review from dashpole, evantorrie, jmacd, lizthegrey and XSAM as code owners February 26, 2021 20:23

MrAlias approved these changes Mar 1, 2021

View reviewed changes

MrAlias added pkg:SDK release:required-for-ga labels Mar 4, 2021

MrAlias added this to the RC1 milestone Mar 4, 2021

MrAlias mentioned this pull request Mar 5, 2021

Spec Conformance Review: Span Get Context #1628

Closed

2 tasks

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

f0b76fd

…y-go into OTG-1515

Aneurysm9 requested a review from MrAlias March 5, 2021 22:49

Address PR feedback

a05cc39

MrAlias approved these changes Mar 8, 2021

View reviewed changes

Aneurysm9 added 2 commits March 9, 2021 01:06

Merge remote-tracking branch 'origin/main' into OTG-1515

5e1b127

Fix new uses of SpanContext from main

a54d665

XSAM approved these changes Mar 9, 2021

View reviewed changes

MrAlias merged commit e88a091 into open-telemetry:main Mar 9, 2021

MrAlias mentioned this pull request Mar 18, 2021

Release v0.19.0 #1710

Merged

vreynolds mentioned this pull request Apr 7, 2021

Bump go.opentelemetry.io/otel from 0.18.0 to 0.19.0 honeycombio/beeline-go#208

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make SpanContext Immutable #1573

Make SpanContext Immutable #1573

Aneurysm9 commented Feb 23, 2021

Uh oh!

codecov bot commented Feb 23, 2021 •

edited

Loading

Uh oh!

bogdandrutu left a comment

Uh oh!

Uh oh!

Uh oh!

bogdandrutu commented Feb 24, 2021

Uh oh!

Aneurysm9 commented Feb 24, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Make SpanContext Immutable #1573

Make SpanContext Immutable #1573

Conversation

Aneurysm9 commented Feb 23, 2021

Uh oh!

codecov bot commented Feb 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bogdandrutu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bogdandrutu commented Feb 24, 2021

Uh oh!

Aneurysm9 commented Feb 24, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 23, 2021 •

edited

Loading