Add OpenTelemetry support #7642

haywoodsh · 2025-04-14T11:18:56Z

Proposed changes

Add otel support for NGINX Ingress Controller OSS and Plus
Added config map keys:

  otel-exporter-endpoint: "[(http|https)://]host:port" # Required
  otel-exporter-header-name: "name" # Optional
  otel-exporter-header-value: "value" # Optional
  otel-service-name: "unknown_service:nginx" # Optional
  otel-global-trace-enabled: "false" # Optional, enables otel tracing at the http context

Checklist

Before creating a PR, run through this checklist and mark each as complete.

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have checked that all unit tests pass after adding my changes
I have updated necessary documentation
I have rebased my branch onto main
I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

codecov · 2025-04-29T19:18:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.47%. Comparing base (2f0cb58) to head (73798d5).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7642      +/-   ##
==========================================
+ Coverage   52.29%   52.47%   +0.18%     
==========================================
  Files          90       90              
  Lines       21472    21550      +78     
==========================================
+ Hits        11228    11308      +80     
+ Misses       9774     9772       -2     
  Partials      470      470

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2025-05-06T16:33:35Z

✅ Deploy Preview will be available once build job completes!

Name	Link
😎 Deploy Preview	https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/7642/

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

vepatel · 2025-05-27T14:58:08Z

site/content/configuration/global-configuration/configmap-resource.md

@@ -230,6 +230,11 @@ If you encounter the error `error [emerg] 13#13: "zone_sync" directive is duplic
 {{<bootstrap-table "table table-striped table-bordered table-responsive">}}
 |ConfigMap Key | Description | Default | Example |
 | ---| ---| ---| --- |
+|*otel-exporter-endpoint* | OTLP/gRPC endpoint that will accept [OpenTelemetry](https://opentelemetry.io) data. Set `otel-trace-in-http` to *True* to enable OpenTelemetry at global level. Example: *"https://otel-collector:4317"*. Note: requires the Ingress Controller image with OpenTelemetry module. | | |


we can specify N/A as defaults for the ones without

vepatel · 2025-05-27T14:58:43Z

site/content/configuration/global-configuration/configmap-resource.md

+|*otel-exporter-header-name* | The name of a custom HTTP header to add to telemetry export request. Example: *"X-custom-header"*. `otel-exporter-endpoint` and `otel-exporter-header-value` required. | | |
+|*otel-exporter-header-value* | The value of a custom HTTP header to add to telemetry export request.Example: *"custom-value"*. `otel-exporter-endpoint` and `otel-exporter-header-name` required. | | |
+|*otel-service-name* | Sets the `service.name` attribute of the OTel resource. Example: *"nginx-ingress-controller:nginx"*. `otel-exporter-endpoint` required. | |  |
+| *otel-trace-in-http* | Enables [OpenTelemetry](https://opentelemetry.io) globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Set this to *False* to enable OpenTelemetry for individual routes with snippets. `otel-exporter-endpoint` required. | *False* | |
 |*opentracing* | Removed in v5.0.0.  Enables [OpenTracing](https://opentracing.io) globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Note: requires the Ingress Controller image with OpenTracing module and a tracer. See the [docs]({{< relref "/installation/integrations/opentracing.md" >}}) for more information. | *False* |  |


since this is more of a replacement, should we remove opentracing entries now? @shaun-nx

vepatel · 2025-05-27T15:01:21Z

.github/data/matrix-smoke-nap.json

@@ -5,7 +5,7 @@
      "image": "ubi-8-plus-nap",
      "type": "plus",
      "nap_modules": "waf",
-      "marker": "appprotect_waf_policies_allow",
+      "marker": "'appprotect_waf_policies_allow or otel'",


Imo we should create a new entry for Otel like OIDC, mixing it with other unrelated markers is a bit confusing especially since the configuration is controlled using configmap only

vepatel · 2025-05-27T15:04:10Z

tests/suite/utils/resources_utils.py

@@ -1022,7 +1022,7 @@ def get_nginx_template_conf(v1: CoreV1Api, ingress_namespace, ic_pod_name=None)
    if ic_pod_name is None:
        ic_pod_name = get_first_pod_name(v1, ingress_namespace)
    file_path = "/etc/nginx/nginx.conf"
-    return get_file_contents(v1, file_path, ic_pod_name, ingress_namespace)
+    return get_file_contents(v1, file_path, ic_pod_name, ingress_namespace, print_log)


do we need to pass print_log as default is true?

vepatel · 2025-05-27T15:09:20Z

build/dependencies/Dockerfile.ubi8

@@ -0,0 +1,10 @@
+# syntax=docker/dockerfile:1.8


need to update docker-updater as it looks for Dockerfile.ubi https://github.com/nginx/kubernetes-ingress/actions/runs/15278931054/job/42972620331#step:3:37
cc @pdabelf5

github-actions bot added enhancement Pull requests for new features/feature enhancements go Pull requests that update Go code docker Pull requests that update Docker code labels Apr 14, 2025

haywoodsh linked an issue Apr 23, 2025 that may be closed by this pull request

Implement basic support for Otel #7640

Open

7 tasks

pdabelf5 force-pushed the feat/add-otel-support branch from 3f111b2 to 8c598c6 Compare April 29, 2025 16:47

github-actions bot added the chore Pull requests for routine tasks label Apr 30, 2025

haywoodsh force-pushed the feat/add-otel-support branch from 22e590f to 4cf0f62 Compare May 2, 2025 15:05

github-actions bot removed the chore Pull requests for routine tasks label May 2, 2025

haywoodsh force-pushed the feat/add-otel-support branch from 25f53b4 to bee7750 Compare May 6, 2025 15:27

github-actions bot added the documentation Pull requests/issues for documentation label May 6, 2025

haywoodsh force-pushed the feat/add-otel-support branch from 8ad0ac7 to bee7750 Compare May 6, 2025 16:32

github-actions bot removed the documentation Pull requests/issues for documentation label May 6, 2025

haywoodsh force-pushed the feat/add-otel-support branch from 01535d0 to 1d581b5 Compare May 15, 2025 15:15

haywoodsh force-pushed the feat/add-otel-support branch from 714a273 to 406b1b8 Compare May 16, 2025 08:51

github-actions bot added python Pull requests that update Python code tests Pull requests that update tests github_actions Pull requests that update Github_actions code chore Pull requests for routine tasks labels May 16, 2025

pdabelf5 and others added 18 commits May 22, 2025 11:41

trigger build by changing CI file

c963587

add c-ares to all ubi based images

1d80cfd

remove testing branch from dependency dockerfile

1241373

remove duplicated package installation

39db632

add otel tests to all images

a4de5c6

move extract_block() to resource_utils package

15b8fbb

add test to ensure otel is disabled if endpoint is missing

c6fa5b8

update docs

31412e6

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

add single qoutes to NAP test markers

a4d45e4

add single qoutes to all otel test markers

55b5547

add example

89b1579

allow partially valid otel config, add validation and unit tests

ab7fcf5

Signed-off-by: Haywood Shannon <[email protected]> Signed-off-by: Haywood Shannon <[email protected]>

add additional comment to configmap

a05419c

update plus modules

fc727e5

tryout unordered list for modules

33efb5e

complete list of modules in tech specs

89c924d

replace unordered list with single line break

c877936

fix rebase issue

93b48df

pdabelf5 force-pushed the feat/add-otel-support branch from 2aade5c to 93b48df Compare May 22, 2025 10:53

github-actions bot added chore Pull requests for routine tasks tests Pull requests that update tests and removed dependencies Pull requests that update a dependency file helm_chart Pull requests that update the Helm Chart labels May 22, 2025

remove unused image import

73798d5

AlexFenlon approved these changes May 22, 2025

View reviewed changes

vepatel reviewed May 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add OpenTelemetry support #7642

Add OpenTelemetry support #7642

haywoodsh commented Apr 14, 2025 •

edited

Loading

Uh oh!

codecov bot commented Apr 29, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 6, 2025

Uh oh!

vepatel May 27, 2025 •

edited

Loading

Uh oh!

vepatel May 27, 2025 •

edited

Loading

Uh oh!

vepatel May 27, 2025

Uh oh!

vepatel May 27, 2025

Uh oh!

vepatel May 27, 2025

Uh oh!

Uh oh!

Add OpenTelemetry support #7642

Are you sure you want to change the base?

Add OpenTelemetry support #7642

Conversation

haywoodsh commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Checklist

Uh oh!

codecov bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented May 6, 2025

✅ Deploy Preview will be available once build job completes!

Uh oh!

vepatel May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vepatel May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vepatel May 27, 2025

Choose a reason for hiding this comment

Uh oh!

vepatel May 27, 2025

Choose a reason for hiding this comment

Uh oh!

vepatel May 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

haywoodsh commented Apr 14, 2025 •

edited

Loading

codecov bot commented Apr 29, 2025 •

edited

Loading

vepatel May 27, 2025 •

edited

Loading

vepatel May 27, 2025 •

edited

Loading