Skip to content

Commit 9f043c9

Browse files
committed
address feedback
1 parent 76c29a3 commit 9f043c9

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

contributors/devel/sig-instrumentation/trace-instrumentation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ performing any real work, or making any network requests.
3838
### Configuration and Setup
3939

4040
Kubernetes components should expose a flag, `--tracing-config-file`, which accepts a
41-
[TracingConfiguration](https://github.com/kubernetes/kubernetes/blob/cb989b84c82ab8c695d02c9a1866bc27de37caec/staging/src/k8s.io/component-base/tracing/api/v1/types.go)
41+
[TracingConfiguration](https://kubernetes.io/docs/reference/config-api/apiserver-config.v1beta1/#apiserver-k8s-io-v1beta1-TracingConfiguration)
4242
object. The `component-base/tracing` library provides a `NewProvider()` helper
4343
to convert a TracingConfiguration to a TracerProvider, which can be used to
4444
record spans. Components should avoid using OpenTelemetry globals, and instead
@@ -66,6 +66,10 @@ Follow the OpenTelemetry [guidelines for span naming](https://opentelemetry.io/d
6666
### Tracing stability
6767

6868
Tracing instrumentation in Kubernetes components does not currently have
69-
stability guarantees. Component owners should avoid breaking context
70-
propagation, or removing trace instrumentation entirely. Component owners may
71-
rename spans, or span attributes.
69+
stability guarantees, but component owners should be aware of which changes are
70+
breaking to users so such changes are done with proper consideration. In
71+
particular, is is breaking for users for a component to stop propagating
72+
context in a way that breaks parent/child relationships for spans, to remove
73+
spans without replacement, or to remove an attribute from a span without
74+
replacement. Component owners should not treat general modification spans
75+
(e.g. renaming the span, or renaming an attribute) as breaking.

0 commit comments

Comments
 (0)