@@ -4,7 +4,8 @@ linkTitle: Auto-instrumentation
4
4
weight : 11
5
5
description :
6
6
An implementation of auto-instrumentation using the OpenTelemetry Operator.
7
- spelling : cSpell:ignore Otel
7
+ spelling :
8
+ cSpell:ignore otlpreceiver k8sattributesprocessor GRPCNETCLIENT REDISCALA
8
9
---
9
10
10
11
The OpenTelemetry Operator supports injecting and configuring
95
96
The above command results in a deployment of the Collector that you can use as
96
97
an endpoint for auto-instrumentation in your pods.
97
98
98
- ## Configure Autoinstrumentation
99
+ ## Configure Automatic Instrumentation
99
100
100
- To be able to manage autoinstrumentation , the Operator needs to be configured to
101
- know what pods to instrument and which autoinstrumentation to use for those
102
- pods. This is done via the
101
+ To be able to manage automatic instrumentation , the Operator needs to be
102
+ configured to know what pods to instrument and which automatic instrumentation
103
+ to use for those pods. This is done via the
103
104
[ Instrumentation CRD] ( https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#instrumentation ) .
104
105
105
106
Creating the Instrumentation resource correctly is paramount to getting
@@ -133,7 +134,7 @@ By default, the Instrumentation resource that auto-instruments .NET services
133
134
uses ` otlp ` with the ` http/protobuf ` protocol. This means that the configured
134
135
endpoint must be able to receive OTLP over ` http/protobuf ` . Therefore, the
135
136
example uses ` http://demo-collector:4318 ` , which will connect to the ` http ` port
136
- of the otlpreceiver of the Collector created in the previous step.
137
+ of the ` otlpreceiver ` of the Collector created in the previous step.
137
138
138
139
By default, the .NET auto-instrumentation ships with
139
140
[ many instrumentation libraries] ( https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/config.md#instrumentations ) .
@@ -261,7 +262,7 @@ By default, the Instrumentation resource that auto-instruments Node.js services
261
262
uses ` otlp ` with the ` grpc ` protocol. This means that the configured endpoint
262
263
must be able to receive OTLP over ` grpc ` . Therefore, the example uses
263
264
` http://demo-collector:4317 ` , which connects to the ` grpc ` port of the
264
- otlpreceiver of the Collector created in the previous step.
265
+ ` otlpreceiver ` of the Collector created in the previous step.
265
266
266
267
By default, the Node.js auto-instrumentation ships with
267
268
[ many instrumentation libraries] ( https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md#supported-instrumentations ) .
@@ -300,7 +301,7 @@ By default, the Instrumentation resource that auto-instruments python services
300
301
uses ` otlp ` with the ` http/protobuf ` protocol. This means that the configured
301
302
endpoint must be able to receive OTLP over ` http/protobuf ` . Therefore, the
302
303
example uses ` http://demo-collector:4318 ` , which will connect to the ` http ` port
303
- of the otlpreceiver of the Collector created in the previous step.
304
+ of the ` otlpreceiver ` of the Collector created in the previous step.
304
305
305
306
> As of operator v0.67.0, the Instrumentation resource automatically sets
306
307
> ` OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ` and ` OTEL_EXPORTER_OTLP_METRICS_PROTOCOL `
@@ -343,14 +344,14 @@ spec:
343
344
Now that your Instrumentation object is created, your cluster has the ability to
344
345
auto-instrument services and send data to an endpoint. However,
345
346
auto-instrumentation with the OpenTelemetry Operator follows an opt-in model. In
346
- order to activate autoinstrumentation , you'll need to add an annotation to your
347
- deployment.
347
+ order to activate automatic instrumentation , you'll need to add an annotation to
348
+ your deployment.
348
349
349
350
## Add annotations to existing deployments
350
351
351
- The final step is to opt in your services to autoinstrumentation . This is done
352
- by updating your service’s ` spec.template.metadata.annotations` to include a
353
- language-specific annotation :
352
+ The final step is to opt in your services to automatic instrumentation . This is
353
+ done by updating your service’s ` spec.template.metadata.annotations` to include
354
+ a language-specific annotation :
354
355
355
356
- .NET : ` instrumentation.opentelemetry.io/inject-dotnet: "true"`
356
357
- Java : ` instrumentation.opentelemetry.io/inject-java: "true"`
@@ -369,6 +370,6 @@ The possible values for the annotation can be
369
370
- ` "false"` - do not inject
370
371
371
372
Alternatively, the annotation can be added to a namespace, which will result in
372
- all services in that namespace to opt-in to autoinstrumentation . See the
373
+ all services in that namespace to opt-in to automatic instrumentation . See the
373
374
[Operators auto-instrumentation documentation](https://github.com/open-telemetry/opentelemetry-operator/blob/main/README.md#opentelemetry-auto-instrumentation-injection)
374
375
for more details.
0 commit comments