</code></pre></div></p><p>To enable or disable instrumentation for a single Ingress, use the <code>enable-opentelemetry</code> annotation: <divclass=highlight><pre><span></span><code><spanclass=nt>kind</span><spanclass=p>:</span><spanclass="l l-Scalar l-Scalar-Plain">Ingress</span>
</code></pre></div></p><p>We must also set the host to use when uploading traces:</p><p><divclass=highlight><pre><span></span><code><spanclass=nt>otlp-collector-host</span><spanclass=p>:</span><spanclass=s>"otel-coll-collector.otel.svc"</span>
</code></pre></div> NOTE: While the option is called <code>otlp-collector-host</code>, you will need to point this to any backend that receives otlp-grpc.</p><p>Next you will need to deploy a distributed telemetry system which uses OpenTelemetry. <ahref=https://github.com/open-telemetry/opentelemetry-collector>opentelemetry-collector</a>, <ahref=https://www.jaegertracing.io/>Jaeger</a><ahref=https://github.com/grafana/tempo>Tempo</a>, and <ahref=https://zipkin.io/>zipkin</a> have been tested.</p><p>Other optional configuration options: <divclass=highlight><pre><span></span><code><spanclass=c1># specifies the name to use for the server span</span>
<spanclass="l l-Scalar l-Scalar-Plain"># specifies the port to use when uploading traces, Default</span><spanclass="p p-Indicator">:</span><spanclass="l l-Scalar l-Scalar-Plain">4317</span>
</code></pre></div></p><p>Note that you can also set whether to trust incoming spans (global default is true) per-location using annotations like the following: <divclass=highlight><pre><span></span><code><spanclass=nt>kind</span><spanclass=p>:</span><spanclass="l l-Scalar l-Scalar-Plain">Ingress</span>
</code></pre></div></p><h2id=examples>Examples<aclass=headerlinkhref=#examplestitle="Permanent link"> ¶</a></h2><p>The following examples show how to deploy and test different distributed telemetry systems. These example can be performed using Docker Desktop.</p><p>In the <ahref=https://github.com/esigo/nginx-example>esigo/nginx-example</a> GitHub repository is an example of a simple hello service:</p><preclass=mermaid><code>graph TB
subgraph Browser
start["http://esigo.dev/hello/nginx"]
end
subgraph app
sa[service-a]
sb[service-b]
sa --> |name: nginx| sb
sb --> |hello nginx!| sa
end
subgraph otel
otc["Otel Collector"]
end
subgraph observability
tempo["Tempo"]
grafana["Grafana"]
backend["Jaeger"]
zipkin["Zipkin"]
end
subgraph ingress-nginx
ngx[nginx]
end
subgraph ngx[nginx]
ng[nginx]
om[OpenTelemetry module]
end
subgraph Node
app
otel
observability
ingress-nginx
om --> |otlp-gRPC| otc --> |jaeger| backend
otc --> |zipkin| zipkin
otc --> |otlp-gRPC| tempo --> grafana
sa --> |otlp-gRPC| otc
sb --> |otlp-gRPC| otc
start --> ng --> sa
end</code></pre><p>To install the example and collectors run:</p><ol><li><p>Enable Ingress addon with:</p><divclass=highlight><pre><span></span><code><spanclass=nt>opentelemetry</span><spanclass=p>:</span>
</code></pre></div></li><li><p>Enable OpenTelemetry and set the otlp-collector-host:</p><divclass=highlight><pre><span></span><code><spanclass="l l-Scalar l-Scalar-Plain">$ echo '</span>
</code></pre></div></li><li><p>Deploy otel-collector, grafana and Jaeger backend:</p><divclass=highlight><pre><span></span><code><spanclass=c1># add helm charts needed for grafana and OpenTelemetry collector</span>
</code></pre></div></li><li><p>Build and deploy demo app:</p><divclass=highlight><pre><span></span><code><spanclass=c1># build images</span>
make images
<spanclass=c1># deploy demo app:</span>
make deploy-app
</code></pre></div></li><li><p>Make a few requests to the Service:</p><divclass=highlight><pre><span></span><code>kubectl port-forward --namespace<spanclass=o>=</span>ingress-nginx service/ingress-nginx-controller <spanclass=m>8090</span>:80
Mon, <spanclass=m>10</span> Oct <spanclass=m>2022</span><spanclass=m>17</span>:43:33 GMT<spanclass=o>]}</span>
Images : <spanclass=o>{}</span>
InputFields : <spanclass=o>{}</span>
Links : <spanclass=o>{}</span>
ParsedHtml : System.__ComObject
RawContentLength : <spanclass=m>21</span>
</code></pre></div></li><li><p>View the Grafana UI:</p><p><divclass=highlight><pre><span></span><code>kubectl port-forward --namespace<spanclass=o>=</span>observability service/grafana <spanclass=m>3000</span>:80
</code></pre></div> In the Grafana interface we can see the details: <imgalt="grafana screenshot"src=../../../images/otel-grafana-demo.pngtitle="grafana screenshot"></p></li><li><p>View the Jaeger UI:</p><p><divclass=highlight><pre><span></span><code>kubectl port-forward --namespace<spanclass=o>=</span>observability service/jaeger-all-in-one-query <spanclass=m>16686</span>:16686
</code></pre></div> In the Jaeger interface we can see the details: <imgalt="Jaeger screenshot"src=../../../images/otel-jaeger-demo.pngtitle="Jaeger screenshot"></p></li><li><p>View the Zipkin UI:</p><p><divclass=highlight><pre><span></span><code>kubectl port-forward --namespace<spanclass=o>=</span>observability service/zipkin <spanclass=m>9411</span>:9411
</code></pre></div> In the Zipkin interface we can see the details: <imgalt="zipkin screenshot"src=../../../images/otel-zipkin-demo.pngtitle="zipkin screenshot"></p></li></ol><h2id=migration-from-opentracing-jaeger-zipkin-and-datadog>Migration from OpenTracing, Jaeger, Zipkin and Datadog<aclass=headerlinkhref=#migration-from-opentracing-jaeger-zipkin-and-datadogtitle="Permanent link"> ¶</a></h2><p>If you are migrating from OpenTracing, Jaeger, Zipkin, or Datadog to OpenTelemetry, you may need to update various annotations and configurations. Here are the mappings for common annotations and configurations:</p><h3id=annotations>Annotations<aclass=headerlinkhref=#annotationstitle="Permanent link"> ¶</a></h3><table><thead><tr><th>Legacy</th><th>OpenTelemetry</th></tr></thead><tbody><tr><td><code>nginx.ingress.kubernetes.io/enable-opentracing</code></td><td><code>nginx.ingress.kubernetes.io/enable-opentelemetry</code></td></tr><tr><td><code>opentracing-trust-incoming-span</code></td><td><code>opentracing-trust-incoming-span</code></td></tr></tbody></table><h3id=configs>Configs<aclass=headerlinkhref=#configstitle="Permanent link"> ¶</a></h3><table><thead><tr><th>Legacy</th><th>OpenTelemetry</th></tr></thead><tbody><tr><td><code>opentracing-operation-name</code></td><td><code>opentelemetry-operation-name</code></td></tr><tr><td><code>opentracing-location-operation-name</code></td><td><code>opentelemetry-operation-name</code></td></tr><tr><td><code>opentracing-trust-incoming-span</code></td><td><code>opentelemetry-trust-incoming-span</code></td></tr><tr><td><code>zipkin-collector-port</code></td><td><code>otlp-collector-port</code></td></tr><tr><td><code>zipkin-service-name</code></td><td><code>otel-service-name</code></td></tr><tr><td><code>zipkin-sample-rate</code></td><td><code>otel-sampler-ratio</code></td></tr><tr><td><code>jaeger-collector-port</code></td><td><code>otlp-collector-port</code></td></tr><tr><td><code>jaeger-endpoint</code></td><td><code>otlp-collector-port</code>, <code>otlp-collector-host</code></td></tr><tr><td><code>jaeger-service-name</code></td><td><code>otel-service-name</code></td></tr><tr><td><code>jaeger-propagation-format</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-sampler-type</code></td><td><code>otel-sampler</code></td></tr><tr><td><code>jaeger-sampler-param</code></td><td><code>otel-sampler</code></td></tr><tr><td><code>jaeger-sampler-host</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-sampler-port</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-trace-context-header-name</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-debug-header</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-baggage-header</code></td><td><code>N/A</code></td></tr><tr><td><code>jaeger-tracer-baggage-header-prefix</code></td><td><code>N/A</code></td></tr><tr><td><code>datadog-collector-port</code></td><td><code>otlp-collector-port</code></td></tr><tr><td><code>datadog-service-name</code></td><td><code>otel-service-name</code></td></tr><tr><td><code>datadog-environment</code></td><td><code>N/A</code></td></tr><tr><td><code>datadog-operation-name-override</code></td><td><code>N/A</code></td></tr><tr><td><code>datadog-priority-sampling</code></td><td><code>otel-sampler</code></td></tr><tr><td><code>datadog-sample-rate</code></td><td><code>otel-sampler-ratio</code></td></tr></tbody></table></article></div></div></main><footerclass=md-footer><divclass=md-footer-nav><navclass="md-footer-nav__inner md-grid"aria-label=Footer><ahref=../opentracing/class="md-footer-nav__link md-footer-nav__link--prev"rel=prev><divclass="md-footer-nav__button md-icon"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg></div><divclass=md-footer-nav__title><divclass=md-ellipsis><spanclass=md-footer-nav__direction> Previous </
