Skip to content

Commit 1240361

Browse files
authored
Add legacy to OpenTelemetry migration doc (#10011)
1 parent 5325464 commit 1240361

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/user-guide/third-party-addons/opentelemetry.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ Enables requests served by NGINX for distributed telemetry via The OpenTelemetry
55
Using the third party module [opentelemetry-cpp-contrib/nginx](https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/nginx) the Ingress-Nginx Controller can configure NGINX to enable [OpenTelemetry](http://opentelemetry.io) instrumentation.
66
By default this feature is disabled.
77

8+
Check out this demo showcasing OpenTelemetry in Ingress NGINX. The video provides an overview and
9+
practical demonstration of how OpenTelemetry can be utilized in Ingress NGINX for observability
10+
and monitoring purposes.
11+
12+
<p align="center">
13+
<a href="https://www.youtube.com/watch?v=jpBfgJpTcfw&t=129" target="_blank" rel="noopener noreferrer">
14+
<img src="https://img.youtube.com/vi/jpBfgJpTcfw/0.jpg" alt="Video Thumbnail" />
15+
</a>
16+
</p>
17+
18+
<p align="center">Demo: OpenTelemetry in Ingress NGINX.</p>
19+
820
## Usage
921

1022
To enable the instrumentation we must enable OpenTelemetry in the configuration ConfigMap:
@@ -258,3 +270,45 @@ To install the example and collectors run:
258270
```
259271
In the Zipkin interface we can see the details:
260272
![zipkin screenshot](../../images/otel-zipkin-demo.png "zipkin screenshot")
273+
274+
## Migration from OpenTracing, Jaeger, Zipkin and Datadog
275+
276+
If you are migrating from OpenTracing, Jaeger, Zipkin, or Datadog to OpenTelemetry,
277+
you may need to update various annotations and configurations. Here are the mappings
278+
for common annotations and configurations:
279+
280+
### Annotations
281+
282+
| Legacy | OpenTelemetry |
283+
|--------------------------------------------------|--------------------------------------------------|
284+
| `nginx.ingress.kubernetes.io/enable-opentracing` | `nginx.ingress.kubernetes.io/enable-opentelemetry` |
285+
| `opentracing-trust-incoming-span` | `opentracing-trust-incoming-span` |
286+
287+
### Configs
288+
289+
| Legacy | OpenTelemetry |
290+
|---------------------------------------|----------------------------------------------|
291+
| `opentracing-operation-name` | `opentelemetry-operation-name` |
292+
| `opentracing-location-operation-name` | `opentelemetry-operation-name` |
293+
| `opentracing-trust-incoming-span` | `opentelemetry-trust-incoming-span` |
294+
| `zipkin-collector-port` | `otlp-collector-port` |
295+
| `zipkin-service-name` | `otel-service-name` |
296+
| `zipkin-sample-rate` | `otel-sampler-ratio` |
297+
| `jaeger-collector-port` | `otlp-collector-port` |
298+
| `jaeger-endpoint` | `otlp-collector-port`, `otlp-collector-host` |
299+
| `jaeger-service-name` | `otel-service-name` |
300+
| `jaeger-propagation-format` | `N/A` |
301+
| `jaeger-sampler-type` | `otel-sampler` |
302+
| `jaeger-sampler-param` | `otel-sampler` |
303+
| `jaeger-sampler-host` | `N/A` |
304+
| `jaeger-sampler-port` | `N/A` |
305+
| `jaeger-trace-context-header-name` | `N/A` |
306+
| `jaeger-debug-header` | `N/A` |
307+
| `jaeger-baggage-header` | `N/A` |
308+
| `jaeger-tracer-baggage-header-prefix` | `N/A` |
309+
| `datadog-collector-port` | `otlp-collector-port` |
310+
| `datadog-service-name` | `otel-service-name` |
311+
| `datadog-environment` | `N/A` |
312+
| `datadog-operation-name-override` | `N/A` |
313+
| `datadog-priority-sampling` | `otel-sampler` |
314+
| `datadog-sample-rate` | `otel-sampler-ratio` |

0 commit comments

Comments
 (0)