DevFW-CICD/ingress-nginx-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ingress-nginx-helm/user-guide/third-party-addons/opentelemetry/index.html
k8s-ci-robot 3c29cd3dd0 Deploy GitHub Pages
2023-06-11 20:34:45 +00:00

174 lines
No EOL
42 KiB
HTML
Raw Blame History

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href=https://kubernetes.github.io/ingress-nginx/user-guide/third-party-addons/opentelemetry/ rel=canonical><link rel="shortcut icon" href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.1.2, mkdocs-material-6.2.4"><title>OpenTelemetry - Ingress-Nginx Controller</title><link rel=stylesheet href=../../../assets/stylesheets/main.15aa0b43.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.75751829.min.css><meta name=theme-color content=#009485><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"><style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style><link rel=stylesheet href=../../../extra.css><script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-118407822-1","kubernetes.github.io"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})}),document.addEventListener("DOMContentSwitch",function(){ga("send","pageview",document.location.pathname)})</script><script async src=https://www.google-analytics.com/analytics.js></script></head> <body dir=ltr data-md-color-scheme data-md-color-primary=teal data-md-color-accent=green> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#opentelemetry class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header-nav md-grid" aria-label=Header> <a href=https://kubernetes.github.io/ingress-nginx title="Ingress-Nginx Controller" class="md-header-nav__button md-logo" aria-label="Ingress-Nginx Controller"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> </a> <label class="md-header-nav__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> </label> <div class=md-header-nav__title data-md-component=header-title> <div class=md-header-nav__ellipsis> <div class=md-header-nav__topic> <span class=md-ellipsis> Ingress-Nginx Controller </span> </div> <div class=md-header-nav__topic> <span class=md-ellipsis> OpenTelemetry </span> </div> </div> </div> <label class="md-header-nav__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query data-md-state=active required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </label> <button type=reset class="md-search__icon md-icon" aria-label=Clear data-md-component=search-reset tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> </button> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list></ol> </div> </div> </div> </div> </div> <div class=md-header-nav__source> <a href=https://github.com/kubernetes/ingress-nginx/ title="Go to repository" class=md-source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg> </div> <div class=md-source__repository> kubernetes/ingress-nginx </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class="md-tabs__inner md-grid"> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../.. class=md-tabs__link> Welcome </a> </li> <li class=md-tabs__item> <a href=../../../deploy/ class=md-tabs__link> Deployment </a> </li> <li class=md-tabs__item> <a href=../../nginx-configuration/ class="md-tabs__link md-tabs__link--active"> User guide </a> </li> <li class=md-tabs__item> <a href=../../../examples/ class=md-tabs__link> Examples </a> </li> <li class=md-tabs__item> <a href=../../../developer-guide/getting-started/ class=md-tabs__link> Developer Guide </a> </li> <li class=md-tabs__item> <a href=../../../faq/ class=md-tabs__link> FAQ </a> </li> </ul> </div> </nav> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=https://kubernetes.github.io/ingress-nginx title="Ingress-Nginx Controller" class="md-nav__button md-logo" aria-label="Ingress-Nginx Controller"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> </a> Ingress-Nginx Controller </label> <div class=md-nav__source> <a href=https://github.com/kubernetes/ingress-nginx/ title="Go to repository" class=md-source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg> </div> <div class=md-source__repository> kubernetes/ingress-nginx </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-1 type=checkbox id=nav-1> <label class=md-nav__link for=nav-1> Welcome <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Welcome data-md-level=1> <label class=md-nav__title for=nav-1> <span class="md-nav__icon md-icon"></span> Welcome </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../.. class=md-nav__link> Welcome </a> </li> <li class=md-nav__item> <a href=../../../how-it-works/ class=md-nav__link> How it works </a> </li> <li class=md-nav__item> <a href=../../../troubleshooting/ class=md-nav__link> Troubleshooting </a> </li> <li class=md-nav__item> <a href=../../../kubectl-plugin/ class=md-nav__link> kubectl plugin </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-2 type=checkbox id=nav-2> <label class=md-nav__link for=nav-2> Deployment <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Deployment data-md-level=1> <label class=md-nav__title for=nav-2> <span class="md-nav__icon md-icon"></span> Deployment </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../deploy/ class=md-nav__link> Installation Guide </a> </li> <li class=md-nav__item> <a href=../../../deploy/baremetal/ class=md-nav__link> Bare-metal considerations </a> </li> <li class=md-nav__item> <a href=../../../deploy/rbac/ class=md-nav__link> Role Based Access Control (RBAC) </a> </li> <li class=md-nav__item> <a href=../../../deploy/upgrade/ class=md-nav__link> Upgrade </a> </li> <li class=md-nav__item> <a href=../../../deploy/hardening-guide/ class=md-nav__link> Hardening guide </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3 type=checkbox id=nav-3 checked> <label class=md-nav__link for=nav-3> User guide <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="User guide" data-md-level=1> <label class=md-nav__title for=nav-3> <span class="md-nav__icon md-icon"></span> User guide </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3-1 type=checkbox id=nav-3-1> <label class=md-nav__link for=nav-3-1> NGINX Configuration <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="NGINX Configuration" data-md-level=2> <label class=md-nav__title for=nav-3-1> <span class="md-nav__icon md-icon"></span> NGINX Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../nginx-configuration/ class=md-nav__link> Introduction </a> </li> <li class=md-nav__item> <a href=../../basic-usage/ class=md-nav__link> Basic usage </a> </li> <li class=md-nav__item> <a href=../../nginx-configuration/annotations/ class=md-nav__link> Annotations </a> </li> <li class=md-nav__item> <a href=../../nginx-configuration/configmap/ class=md-nav__link> ConfigMap </a> </li> <li class=md-nav__item> <a href=../../nginx-configuration/custom-template/ class=md-nav__link> Custom NGINX template </a> </li> <li class=md-nav__item> <a href=../../nginx-configuration/log-format/ class=md-nav__link> Log format </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../cli-arguments/ class=md-nav__link> Command line arguments </a> </li> <li class=md-nav__item> <a href=../../custom-errors/ class=md-nav__link> Custom errors </a> </li> <li class=md-nav__item> <a href=../../default-backend/ class=md-nav__link> Default backend </a> </li> <li class=md-nav__item> <a href=../../exposing-tcp-udp-services/ class=md-nav__link> Exposing TCP and UDP services </a> </li> <li class=md-nav__item> <a href=../../fcgi-services/ class=md-nav__link> Exposing FCGI services </a> </li> <li class=md-nav__item> <a href=../../ingress-path-matching/ class=md-nav__link> Regular expressions in paths </a> </li> <li class=md-nav__item> <a href=../../external-articles/ class=md-nav__link> External Articles </a> </li> <li class=md-nav__item> <a href=../../miscellaneous/ class=md-nav__link> Miscellaneous </a> </li> <li class=md-nav__item> <a href=../../monitoring/ class=md-nav__link> Prometheus and Grafana installation </a> </li> <li class=md-nav__item> <a href=../../multiple-ingress/ class=md-nav__link> Multiple Ingress controllers </a> </li> <li class=md-nav__item> <a href=../../tls/ class=md-nav__link> TLS/HTTPS </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3-13 type=checkbox id=nav-3-13 checked> <label class=md-nav__link for=nav-3-13> Third party addons <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="Third party addons" data-md-level=2> <label class=md-nav__title for=nav-3-13> <span class="md-nav__icon md-icon"></span> Third party addons </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../modsecurity/ class=md-nav__link> ModSecurity Web Application Firewall </a> </li> <li class=md-nav__item> <a href=../opentracing/ class=md-nav__link> OpenTracing </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" data-md-toggle=toc type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> OpenTelemetry <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> OpenTelemetry </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#usage class=md-nav__link> Usage </a> </li> <li class=md-nav__item> <a href=#examples class=md-nav__link> Examples </a> </li> <li class=md-nav__item> <a href=#migration-from-opentracing-jaeger-zipkin-and-datadog class=md-nav__link> Migration from OpenTracing, Jaeger, Zipkin and Datadog </a> <nav class=md-nav aria-label="Migration from OpenTracing, Jaeger, Zipkin and Datadog"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#annotations class=md-nav__link> Annotations </a> </li> <li class=md-nav__item> <a href=#configs class=md-nav__link> Configs </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4 type=checkbox id=nav-4> <label class=md-nav__link for=nav-4> Examples <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Examples data-md-level=1> <label class=md-nav__title for=nav-4> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/ class=md-nav__link> Introduction </a> </li> <li class=md-nav__item> <a href=../../../examples/PREREQUISITES/ class=md-nav__link> Prerequisites </a> </li> <li class=md-nav__item> <a href=../../../examples/affinity/cookie/ class=md-nav__link> Sticky Sessions </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4-4 type=checkbox id=nav-4-4> <label class=md-nav__link for=nav-4-4> Auth <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Auth data-md-level=2> <label class=md-nav__title for=nav-4-4> <span class="md-nav__icon md-icon"></span> Auth </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/auth/basic/ class=md-nav__link> Basic Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/client-certs/ class=md-nav__link> Client Certificate Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/external-auth/ class=md-nav__link> External Basic Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/oauth-external-auth/ class=md-nav__link> External OAUTH Authentication </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4-5 type=checkbox id=nav-4-5> <label class=md-nav__link for=nav-4-5> Customization <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Customization data-md-level=2> <label class=md-nav__title for=nav-4-5> <span class="md-nav__icon md-icon"></span> Customization </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/customization/configuration-snippets/ class=md-nav__link> Configuration Snippets </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-configuration/ class=md-nav__link> Custom Configuration </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-errors/ class=md-nav__link> Custom Errors </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-headers/ class=md-nav__link> Custom Headers </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/external-auth-headers/ class=md-nav__link> External authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/ssl-dh-param/ class=md-nav__link> Custom DH parameters for perfect forward secrecy </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/sysctl/ class=md-nav__link> Sysctl tuning </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../examples/docker-registry/ class=md-nav__link> Docker registry </a> </li> <li class=md-nav__item> <a href=../../../examples/grpc/ class=md-nav__link> gRPC </a> </li> <li class=md-nav__item> <a href=../../../examples/multi-tls/ class=md-nav__link> Multi TLS certificate termination </a> </li> <li class=md-nav__item> <a href=../../../examples/rewrite/ class=md-nav__link> Rewrite </a> </li> <li class=md-nav__item> <a href=../../../examples/static-ip/ class=md-nav__link> Static IPs </a> </li> <li class=md-nav__item> <a href=../../../examples/tls-termination/ class=md-nav__link> TLS termination </a> </li> <li class=md-nav__item> <a href=../../../examples/psp/ class=md-nav__link> Pod Security Policy (PSP) </a> </li> <li class=md-nav__item> <a href=../../../examples/openpolicyagent/ class=md-nav__link> Open Policy Agent rules </a> </li> <li class=md-nav__item> <a href=../../../examples/canary/ class=md-nav__link> Canary Deployments </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-5 type=checkbox id=nav-5> <label class=md-nav__link for=nav-5> Developer Guide <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="Developer Guide" data-md-level=1> <label class=md-nav__title for=nav-5> <span class="md-nav__icon md-icon"></span> Developer Guide </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../developer-guide/getting-started/ class=md-nav__link> Getting Started </a> </li> <li class=md-nav__item> <a href=../../../developer-guide/code-overview/ class=md-nav__link> Code Overview </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../faq/ class=md-nav__link> FAQ </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#usage class=md-nav__link> Usage </a> </li> <li class=md-nav__item> <a href=#examples class=md-nav__link> Examples </a> </li> <li class=md-nav__item> <a href=#migration-from-opentracing-jaeger-zipkin-and-datadog class=md-nav__link> Migration from OpenTracing, Jaeger, Zipkin and Datadog </a> <nav class=md-nav aria-label="Migration from OpenTracing, Jaeger, Zipkin and Datadog"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#annotations class=md-nav__link> Annotations </a> </li> <li class=md-nav__item> <a href=#configs class=md-nav__link> Configs </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content> <article class="md-content__inner md-typeset"> <a href=https://github.com/kubernetes/ingress-nginx/edit/main/docs/user-guide/third-party-addons/opentelemetry.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> </a> <h1 id=opentelemetry>OpenTelemetry<a class=headerlink href=#opentelemetry title="Permanent link"></a></h1> <p>Enables requests served by NGINX for distributed telemetry via The OpenTelemetry Project.</p> <p>Using the third party module <a href=https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/nginx>opentelemetry-cpp-contrib/nginx</a> the Ingress-Nginx Controller can configure NGINX to enable <a href=http://opentelemetry.io>OpenTelemetry</a> instrumentation. By default this feature is disabled.</p> <p>Check out this demo showcasing OpenTelemetry in Ingress NGINX. The video provides an overview and practical demonstration of how OpenTelemetry can be utilized in Ingress NGINX for observability and monitoring purposes.</p> <p align=center> <a href="https://www.youtube.com/watch?v=jpBfgJpTcfw&t=129" target=_blank rel="noopener noreferrer"> <img src=https://img.youtube.com/vi/jpBfgJpTcfw/0.jpg alt="Video Thumbnail"> </a> </p> <p align=center>Demo: OpenTelemetry in Ingress NGINX.</p> <h2 id=usage>Usage<a class=headerlink href=#usage title="Permanent link"></a></h2> <p>To enable the instrumentation we must enable OpenTelemetry in the configuration ConfigMap: <div class=highlight><pre><span></span><code><span class=nt>data</span><span class=p>:</span>
<span class=nt>enable-opentelemetry</span><span class=p>:</span> <span class=s>&quot;true&quot;</span>
</code></pre></div></p> <p>To enable or disable instrumentation for a single Ingress, use the <code>enable-opentelemetry</code> annotation: <div class=highlight><pre><span></span><code><span class=nt>kind</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">Ingress</span>
<span class=nt>metadata</span><span class=p>:</span>
<span class=nt>annotations</span><span class=p>:</span>
<span class=nt>nginx.ingress.kubernetes.io/enable-opentelemetry</span><span class=p>:</span> <span class=s>&quot;true&quot;</span>
</code></pre></div></p> <p>We must also set the host to use when uploading traces:</p> <p><div class=highlight><pre><span></span><code><span class=nt>otlp-collector-host</span><span class=p>:</span> <span class=s>&quot;otel-coll-collector.otel.svc&quot;</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. <a href=https://github.com/open-telemetry/opentelemetry-collector>opentelemetry-collector</a>, <a href=https://www.jaegertracing.io/ >Jaeger</a> <a href=https://github.com/grafana/tempo>Tempo</a>, and <a href=https://zipkin.io/ >zipkin</a> have been tested.</p> <p>Other optional configuration options: <div class=highlight><pre><span></span><code><span class=c1># specifies the name to use for the server span</span>
<span class="l l-Scalar l-Scalar-Plain">opentelemetry-operation-name</span>
<span class="l l-Scalar l-Scalar-Plain"># sets whether or not to trust incoming telemetry spans</span>
<span class="l l-Scalar l-Scalar-Plain">opentelemetry-trust-incoming-span</span>
<span class="l l-Scalar l-Scalar-Plain"># specifies the port to use when uploading traces, Default</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">4317</span>
<span class="l l-Scalar l-Scalar-Plain">otlp-collector-port</span>
<span class=c1># specifies the service name to use for any traces created, Default: nginx</span>
<span class="l l-Scalar l-Scalar-Plain">otel-service-name</span>
<span class=c1># The maximum queue size. After the size is reached data are dropped.</span>
<span class="l l-Scalar l-Scalar-Plain">otel-max-queuesize</span>
<span class=c1># The delay interval in milliseconds between two consecutive exports.</span>
<span class="l l-Scalar l-Scalar-Plain">otel-schedule-delay-millis</span>
<span class=c1># How long the export can run before it is cancelled.</span>
<span class="l l-Scalar l-Scalar-Plain">otel-schedule-delay-millis</span>
<span class=c1># The maximum batch size of every export. It must be smaller or equal to maxQueueSize.</span>
<span class="l l-Scalar l-Scalar-Plain">otel-max-export-batch-size</span>
<span class=c1># specifies sample rate for any traces created, Default: 0.01</span>
<span class="l l-Scalar l-Scalar-Plain">otel-sampler-ratio</span>
<span class=c1># specifies the sampler to be used when sampling traces.</span>
<span class=c1># The available samplers are: AlwaysOn, AlwaysOff, TraceIdRatioBased, Default: AlwaysOff</span>
<span class="l l-Scalar l-Scalar-Plain">otel-sampler</span>
<span class=c1># Uses sampler implementation which by default will take a sample if parent Activity is sampled, Default: false</span>
<span class="l l-Scalar l-Scalar-Plain">otel-sampler-parent-based</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: <div class=highlight><pre><span></span><code><span class=nt>kind</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">Ingress</span>
<span class=nt>metadata</span><span class=p>:</span>
<span class=nt>annotations</span><span class=p>:</span>
<span class=nt>nginx.ingress.kubernetes.io/opentelemetry-trust-incoming-span</span><span class=p>:</span> <span class=s>&quot;true&quot;</span>
</code></pre></div></p> <h2 id=examples>Examples<a class=headerlink href=#examples title="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 <a href=https://github.com/esigo/nginx-example>esigo/nginx-example</a> GitHub repository is an example of a simple hello service:</p> <pre class=mermaid><code>graph TB
subgraph Browser
start["http://esigo.dev/hello/nginx"]
end
subgraph app
sa[service-a]
sb[service-b]
sa --&gt; |name: nginx| sb
sb --&gt; |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 --&gt; |otlp-gRPC| otc --&gt; |jaeger| backend
otc --&gt; |zipkin| zipkin
otc --&gt; |otlp-gRPC| tempo --&gt; grafana
sa --&gt; |otlp-gRPC| otc
sb --&gt; |otlp-gRPC| otc
start --&gt; ng --&gt; sa
end</code></pre> <p>To install the example and collectors run:</p> <ol> <li> <p>Enable Ingress addon with:</p> <div class=highlight><pre><span></span><code> <span class=nt>opentelemetry</span><span class=p>:</span>
<span class=nt>enabled</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
<span class=nt>image</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">registry.k8s.io/ingress-nginx/opentelemetry:v20230527@sha256:fd7ec835f31b7b37187238eb4fdad4438806e69f413a203796263131f4f02ed0</span>
<span class=nt>containerSecurityContext</span><span class=p>:</span>
<span class=nt>allowPrivilegeEscalation</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">false</span>
</code></pre></div> </li> <li> <p>Enable OpenTelemetry and set the otlp-collector-host:</p> <div class=highlight><pre><span></span><code><span class="l l-Scalar l-Scalar-Plain">$ echo &#39;</span>
<span class="l l-Scalar l-Scalar-Plain">apiVersion</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
<span class="l l-Scalar l-Scalar-Plain">kind</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">ConfigMap</span>
<span class="l l-Scalar l-Scalar-Plain">data</span><span class="p p-Indicator">:</span>
<span class=nt>enable-opentelemetry</span><span class=p>:</span> <span class=s>&quot;true&quot;</span>
<span class=nt>opentelemetry-config</span><span class=p>:</span> <span class=s>&quot;/etc/nginx/opentelemetry.toml&quot;</span>
<span class=nt>opentelemetry-operation-name</span><span class=p>:</span> <span class=s>&quot;HTTP</span><span class=nv> </span><span class=s>$request_method</span><span class=nv> </span><span class=s>$service_name</span><span class=nv> </span><span class=s>$uri&quot;</span>
<span class=nt>opentelemetry-trust-incoming-span</span><span class=p>:</span> <span class=s>&quot;true&quot;</span>
<span class=nt>otlp-collector-host</span><span class=p>:</span> <span class=s>&quot;otel-coll-collector.otel.svc&quot;</span>
<span class=nt>otlp-collector-port</span><span class=p>:</span> <span class=s>&quot;4317&quot;</span>
<span class=nt>otel-max-queuesize</span><span class=p>:</span> <span class=s>&quot;2048&quot;</span>
<span class=nt>otel-schedule-delay-millis</span><span class=p>:</span> <span class=s>&quot;5000&quot;</span>
<span class=nt>otel-max-export-batch-size</span><span class=p>:</span> <span class=s>&quot;512&quot;</span>
<span class=nt>otel-service-name</span><span class=p>:</span> <span class=s>&quot;nginx-proxy&quot;</span> <span class=c1># Opentelemetry resource name</span>
<span class=nt>otel-sampler</span><span class=p>:</span> <span class=s>&quot;AlwaysOn&quot;</span> <span class=c1># Also: AlwaysOff, TraceIdRatioBased</span>
<span class=nt>otel-sampler-ratio</span><span class=p>:</span> <span class=s>&quot;1.0&quot;</span>
<span class=nt>otel-sampler-parent-based</span><span class=p>:</span> <span class=s>&quot;false&quot;</span>
<span class=" -Error"> </span><span class=nt>metadata</span><span class=p>:</span>
<span class=nt>name</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">ingress-nginx-controller</span>
<span class=nt>namespace</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">ingress-nginx</span>
<span class=s>&#39;</span><span class=nv> </span><span class=s>|</span><span class=nv> </span><span class=s>kubectl</span><span class=nv> </span><span class=s>replace</span><span class=nv> </span><span class=s>-f</span><span class=nv> </span><span class=s>-</span>
</code></pre></div> </li> <li> <p>Deploy otel-collector, grafana and Jaeger backend:</p> <div class=highlight><pre><span></span><code><span class=c1># add helm charts needed for grafana and OpenTelemetry collector</span>
helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
<span class=c1># deply cert-manager needed for OpenTelemetry collector operator</span>
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.yaml
<span class=c1># create observability namespace</span>
kubectl apply -f https://raw.githubusercontent.com/esigo/nginx-example/main/observability/namespace.yaml
<span class=c1># install OpenTelemetry collector operator</span>
helm upgrade --install otel-collector-operator -n otel --create-namespace open-telemetry/opentelemetry-operator
<span class=c1># deploy OpenTelemetry collector</span>
kubectl apply -f https://raw.githubusercontent.com/esigo/nginx-example/main/observability/collector.yaml
<span class=c1># deploy Jaeger all-in-one</span>
kubectl apply -f https://github.com/jaegertracing/jaeger-operator/releases/download/v1.37.0/jaeger-operator.yaml -n observability
kubectl apply -f https://raw.githubusercontent.com/esigo/nginx-example/main/observability/jaeger.yaml -n observability
<span class=c1># deploy zipkin</span>
kubectl apply -f https://raw.githubusercontent.com/esigo/nginx-example/main/observability/zipkin.yaml -n observability
<span class=c1># deploy tempo and grafana</span>
helm upgrade --install tempo grafana/tempo --create-namespace -n observability
helm upgrade -f https://raw.githubusercontent.com/esigo/nginx-example/main/observability/grafana/grafana-values.yaml --install grafana grafana/grafana --create-namespace -n observability
</code></pre></div> </li> <li> <p>Build and deploy demo app:</p> <div class=highlight><pre><span></span><code><span class=c1># build images</span>
make images
<span class=c1># deploy demo app:</span>
make deploy-app
</code></pre></div> </li> <li> <p>Make a few requests to the Service:</p> <div class=highlight><pre><span></span><code>kubectl port-forward --namespace<span class=o>=</span>ingress-nginx service/ingress-nginx-controller <span class=m>8090</span>:80
curl http://esigo.dev:8090/hello/nginx
StatusCode : <span class=m>200</span>
StatusDescription : OK
Content : <span class=o>{</span><span class=s2>&quot;v&quot;</span>:<span class=s2>&quot;hello nginx!&quot;</span><span class=o>}</span>
RawContent : HTTP/1.1 <span class=m>200</span> OK
Connection: keep-alive
Content-Length: <span class=m>21</span>
Content-Type: text/plain<span class=p>;</span> <span class=nv>charset</span><span class=o>=</span>utf-8
Date: Mon, <span class=m>10</span> Oct <span class=m>2022</span> <span class=m>17</span>:43:33 GMT
<span class=o>{</span><span class=s2>&quot;v&quot;</span>:<span class=s2>&quot;hello nginx!&quot;</span><span class=o>}</span>
Forms : <span class=o>{}</span>
Headers : <span class=o>{[</span>Connection, keep-alive<span class=o>]</span>, <span class=o>[</span>Content-Length, <span class=m>21</span><span class=o>]</span>, <span class=o>[</span>Content-Type, text/plain<span class=p>;</span> <span class=nv>charset</span><span class=o>=</span>utf-8<span class=o>]</span>, <span class=o>[</span>Date,
Mon, <span class=m>10</span> Oct <span class=m>2022</span> <span class=m>17</span>:43:33 GMT<span class=o>]}</span>
Images : <span class=o>{}</span>
InputFields : <span class=o>{}</span>
Links : <span class=o>{}</span>
ParsedHtml : System.__ComObject
RawContentLength : <span class=m>21</span>
</code></pre></div> </li> <li> <p>View the Grafana UI:</p> <p><div class=highlight><pre><span></span><code>kubectl port-forward --namespace<span class=o>=</span>observability service/grafana <span class=m>3000</span>:80
</code></pre></div> In the Grafana interface we can see the details: <img alt="grafana screenshot" src=../../../images/otel-grafana-demo.png title="grafana screenshot"></p> </li> <li> <p>View the Jaeger UI:</p> <p><div class=highlight><pre><span></span><code>kubectl port-forward --namespace<span class=o>=</span>observability service/jaeger-all-in-one-query <span class=m>16686</span>:16686
</code></pre></div> In the Jaeger interface we can see the details: <img alt="Jaeger screenshot" src=../../../images/otel-jaeger-demo.png title="Jaeger screenshot"></p> </li> <li> <p>View the Zipkin UI:</p> <p><div class=highlight><pre><span></span><code>kubectl port-forward --namespace<span class=o>=</span>observability service/zipkin <span class=m>9411</span>:9411
</code></pre></div> In the Zipkin interface we can see the details: <img alt="zipkin screenshot" src=../../../images/otel-zipkin-demo.png title="zipkin screenshot"></p> </li> </ol> <h2 id=migration-from-opentracing-jaeger-zipkin-and-datadog>Migration from OpenTracing, Jaeger, Zipkin and Datadog<a class=headerlink href=#migration-from-opentracing-jaeger-zipkin-and-datadog title="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> <h3 id=annotations>Annotations<a class=headerlink href=#annotations title="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> <h3 id=configs>Configs<a class=headerlink href=#configs title="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> <footer class=md-footer> <div class=md-footer-nav> <nav class="md-footer-nav__inner md-grid" aria-label=Footer> <a href=../opentracing/ class="md-footer-nav__link md-footer-nav__link--prev" rel=prev> <div class="md-footer-nav__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </div> <div class=md-footer-nav__title> <div class=md-ellipsis> <span class=md-footer-nav__direction> Previous </span> OpenTracing </div> </div> </a> <a href=../../../examples/ class="md-footer-nav__link md-footer-nav__link--next" rel=next> <div class=md-footer-nav__title> <div class=md-ellipsis> <span class=md-footer-nav__direction> Next </span> Introduction </div> </div> <div class="md-footer-nav__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <script src=../../../assets/javascripts/vendor.93c04032.min.js></script> <script src=../../../assets/javascripts/bundle.83e5331e.min.js></script><script id=__lang type=application/json>{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script> <script>
app = initialize({
base: "../../..",
features: ['navigation.tabs', 'navigation.tabs.sticky', 'navigation.instant', 'navigation.sections'],
search: Object.assign({
worker: "../../../assets/javascripts/worker/search.8c7e0a7e.min.js"
}, typeof search !== "undefined" && search)
})
</script> </body> </html>
Reference in a new issue View git blame Copy permalink