feat: Add otel instrumentation to internal gateway (#126)

Author: ilia-medvedev-codefresh

charts/internal-gateway/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v0.0.0
 description: A Helm chart for Codefresh Internal Gateway
 name: internal-gateway
-version: 0.11.0
+version: 0.12.0
 home: https://github.com/codefresh-io/helm-charts
 keywords:
   - codefresh

charts/internal-gateway/README.md

@@ -1,6 +1,6 @@
 # internal-gateway
 
-![Version: 0.11.0](https://img.shields.io/badge/Version-0.11.0-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
+![Version: 0.12.0](https://img.shields.io/badge/Version-0.12.0-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
 
 A Helm chart for Codefresh Internal Gateway
 
@@ -55,6 +55,11 @@ A Helm chart for Codefresh Internal Gateway
 | nginx.config.workerRlimitNofile | string | `"1047552"` | Changes the limit on the largest size of a core file (RLIMIT_CORE) for worker processes. Used to increase the limit without restarting the main process. |
 | nginx.extraConfigsPatterns | list | `[]` |  |
 | nginx.scriptFilesPatterns | list | `[]` | Path to NJS scripts |
+| otel.config.endpoint | string | `"localhost:4317"` |  |
+| otel.config.service_name | string | `"codefresh-internal-gateway"` |  |
+| otel.enabled | bool | `false` |  |
+| otel.httpSnippet | string | `"otel_trace on;\notel_service_name {{ default \"codefresh-internal-gateway\"  .Values.otel.config.service_name }};\notel_trace_context \"inject\";\notel_exporter {\n  endpoint {{ .Values.otel.config.endpoint}};\n}\n"` | Snippet to be included in the http block of nginx.conf for OTEL configs. See here for available directives https://nginx.org/en/docs/ngx_otel_module.html |
+| otel.modulePath | string | `"modules/ngx_otel_module.so"` | Path to the OpenTelemetry NGINX module - should be present in the NGINX image, images with -otel tags include it |
 | pdb | object | See below | PDB parameters |
 | podAnnotations | object | See below | Pod annotations |
 | podSecurityContext | object | See below | Pod Security Context parameters |

charts/internal-gateway/templates/_components/_configmap.tpl

@@ -14,6 +14,9 @@ metadata:
     {{- include "internal-gateway.labels" . | nindent 4 }}
 data:
   nginx.conf: |
+    {{- if .Values.otel.enabled }}
+    load_module modules/ngx_otel_module.so;
+    {{- end }}
     worker_processes {{ $nginxConfig.workerProcesses }};
     error_log  /dev/stderr {{ $nginxConfig.errorLogLevel }};
     pid        /tmp/nginx.pid;
@@ -68,6 +71,10 @@ data:
       resolver {{ .Values.global.dnsService }}.{{ .Values.global.dnsNamespace }}.svc.{{ .Values.global.clusterDomain }};
       {{- end }}
 
+      {{- if .Values.otel.enabled }}
+        {{- tpl .Values.otel.httpSnippet . | nindent 6 }}
+      {{- end }}
+
       {{- with $nginxConfig.httpSnippet }}
       {{ . | nindent 6 }}
       {{- end }}

charts/internal-gateway/values.yaml

@@ -195,7 +195,7 @@ container:
   image:
     registry: docker.io
     repository: nginxinc/nginx-unprivileged
-    tag: 1.29-alpine
+    tag: 1.29-alpine-otel
 
   env: {}
   envFrom: []
@@ -329,3 +329,19 @@ rbac:
 
 keda:
   enabled: false
+
+otel:
+  enabled: false
+  # -- Path to the OpenTelemetry NGINX module - should be present in the NGINX image, images with -otel tags include it
+  modulePath: "modules/ngx_otel_module.so"
+  config:
+    service_name: "codefresh-internal-gateway"
+    endpoint: "localhost:4317"
+  # -- Snippet to be included in the http block of nginx.conf for OTEL configs. See here for available directives https://nginx.org/en/docs/ngx_otel_module.html
+  httpSnippet: |
+    otel_trace on;
+    otel_service_name {{ default "codefresh-internal-gateway"  .Values.otel.config.service_name }};
+    otel_trace_context "inject";
+    otel_exporter {
+      endpoint {{ .Values.otel.config.endpoint}};
+    }