Skip to content

Commit 683d285

Browse files
committed
Wrap long lines for system-traces
1 parent 96b9dd4 commit 683d285

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

content/en/docs/concepts/cluster-administration/system-traces.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,23 @@ weight: 60
1313

1414
System component traces record the latency of and relationships between operations in the cluster.
1515

16-
Kubernetes components emit traces using the [OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#opentelemetry-protocol-specification) with the gRPC exporter and can be collected and routed to tracing backends using an [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector#-opentelemetry-collector).
16+
Kubernetes components emit traces using the
17+
[OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#opentelemetry-protocol-specification)
18+
with the gRPC exporter and can be collected and routed to tracing backends using an
19+
[OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector#-opentelemetry-collector).
1720

1821
<!-- body -->
1922

2023
## Trace Collection
2124

22-
For a complete guide to collecting traces and using the collector, see [Getting Started with the OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/). However, there are a few things to note that are specific to Kubernetes components.
25+
For a complete guide to collecting traces and using the collector, see
26+
[Getting Started with the OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/).
27+
However, there are a few things to note that are specific to Kubernetes components.
2328

24-
By default, Kubernetes components export traces using the grpc exporter for OTLP on the [IANA OpenTelemetry port](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=opentelemetry), 4317. As an example, if the collector is running as a sidecar to a Kubernetes component, the following receiver configuration will collect spans and log them to standard output:
29+
By default, Kubernetes components export traces using the grpc exporter for OTLP on the
30+
[IANA OpenTelemetry port](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=opentelemetry), 4317.
31+
As an example, if the collector is running as a sidecar to a Kubernetes component,
32+
the following receiver configuration will collect spans and log them to standard output:
2533

2634
```yaml
2735
receivers:
@@ -43,11 +51,19 @@ service:
4351
4452
### kube-apiserver traces
4553
46-
The kube-apiserver generates spans for incoming HTTP requests, and for outgoing requests to webhooks, etcd, and re-entrant requests. It propagates the [W3C Trace Context](https://www.w3.org/TR/trace-context/) with outgoing requests but does not make use of the trace context attached to incoming requests, as the kube-apiserver is often a public endpoint.
54+
The kube-apiserver generates spans for incoming HTTP requests, and for outgoing requests
55+
to webhooks, etcd, and re-entrant requests. It propagates the
56+
[W3C Trace Context](https://www.w3.org/TR/trace-context/) with outgoing requests
57+
but does not make use of the trace context attached to incoming requests,
58+
as the kube-apiserver is often a public endpoint.
4759
4860
#### Enabling tracing in the kube-apiserver
4961
50-
To enable tracing, enable the `APIServerTracing` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) on the kube-apiserver. Also, provide the kube-apiserver with a tracing configration file with `--tracing-config-file=<path-to-config>`. This is an example config that records spans for 1 in 10000 requests, and uses the default OpenTelemetry endpoint:
62+
To enable tracing, enable the `APIServerTracing`
63+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
64+
on the kube-apiserver. Also, provide the kube-apiserver with a tracing configration file
65+
with `--tracing-config-file=<path-to-config>`. This is an example config that records
66+
spans for 1 in 10000 requests, and uses the default OpenTelemetry endpoint:
5167

5268
```yaml
5369
apiVersion: apiserver.config.k8s.io/v1alpha1
@@ -62,8 +78,12 @@ For more information about the `TracingConfiguration` struct, see
6278

6379
## Stability
6480

65-
Tracing instrumentation is still under active development, and may change in a variety of ways. This includes span names, attached attributes, instrumented endpoints, etc. Until this feature graduates to stable, there are no guarantees of backwards compatibility for tracing instrumentation.
81+
Tracing instrumentation is still under active development, and may change
82+
in a variety of ways. This includes span names, attached attributes,
83+
instrumented endpoints, etc. Until this feature graduates to stable,
84+
there are no guarantees of backwards compatibility for tracing instrumentation.
6685

6786
## {{% heading "whatsnext" %}}
6887

6988
* Read about [Getting Started with the OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/)
89+

0 commit comments

Comments
 (0)