From e5d861def3b6dc10eac722ae1273cb0367af7f62 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Sat, 28 Mar 2026 14:08:50 +0100 Subject: [PATCH] refactor(otel): disable telemetry by default for system routes --- Makefile | 10 +++++----- pkg/modules/api/api.go | 8 ++++---- pkg/modules/prometheus/prometheus.go | 2 +- test/integration/features/debug.feature | 20 ++++++++++---------- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Makefile b/Makefile index fa8f9af2..e6cc3bd6 100644 --- a/Makefile +++ b/Makefile @@ -29,10 +29,10 @@ API_DOWNLOAD_FROM_ALLOW_LIST= API_DOWNLOAD_FROM_DENY_LIST= API_DOWNLOAD_FROM_MAX_RETRY=4 API_DISABLE_DOWNLOAD_FROM=false -API_DISABLE_HEALTH_CHECK_ROUTE_TELEMETRY=false -API_DISABLE_ROOT_ROUTE_TELEMETRY=false -API_DISABLE_DEBUG_ROUTE_TELEMETRY=false -API_DISABLE_VERSION_ROUTE_TELEMETRY=false +API_DISABLE_HEALTH_CHECK_ROUTE_TELEMETRY=true +API_DISABLE_ROOT_ROUTE_TELEMETRY=true +API_DISABLE_DEBUG_ROUTE_TELEMETRY=true +API_DISABLE_VERSION_ROUTE_TELEMETRY=true API_ENABLE_DEBUG_ROUTE=false CHROMIUM_RESTART_AFTER=100 CHROMIUM_MAX_QUEUE_SIZE=0 @@ -79,7 +79,7 @@ PDFENGINES_EMBED_ENGINES=pdfcpu PROMETHEUS_NAMESPACE=gotenberg PROMETHEUS_COLLECT_INTERVAL=1s PROMETHEUS_DISABLE_ROUTE_LOGGING=false -PROMETHEUS_DISABLE_ROUTE_TELEMETRY=false +PROMETHEUS_DISABLE_ROUTE_TELEMETRY=true PROMETHEUS_DISABLE_COLLECT=false PROMETHEUS_METRICS_PATH=/prometheus/metrics OTEL_SERVICE_NAME=gotenberg diff --git a/pkg/modules/api/api.go b/pkg/modules/api/api.go index f1be7fc2..3a9545ae 100644 --- a/pkg/modules/api/api.go +++ b/pkg/modules/api/api.go @@ -199,10 +199,10 @@ func (a *Api) Descriptor() gotenberg.ModuleDescriptor { fs.StringSlice("api-download-from-deny-list", []string{}, "Set the denied URLs for the download from feature using regular expressions - supports multiple values") fs.Int("api-download-from-max-retry", 4, "Set the maximum number of retries for the download from feature") fs.Bool("api-disable-download-from", false, "Disable the download from feature") - fs.Bool("api-disable-health-check-route-telemetry", false, "Disable telemetry for health check route") - fs.Bool("api-disable-root-route-telemetry", false, "Disable telemetry for the root route") - fs.Bool("api-disable-debug-route-telemetry", false, "Disable telemetry for the debug route") - fs.Bool("api-disable-version-route-telemetry", false, "Disable telemetry for the version route") + fs.Bool("api-disable-health-check-route-telemetry", true, "Disable telemetry for health check route") + fs.Bool("api-disable-root-route-telemetry", true, "Disable telemetry for the root route") + fs.Bool("api-disable-debug-route-telemetry", true, "Disable telemetry for the debug route") + fs.Bool("api-disable-version-route-telemetry", true, "Disable telemetry for the version route") fs.Bool("api-enable-debug-route", false, "Enable the debug route") // Deprecated flags. diff --git a/pkg/modules/prometheus/prometheus.go b/pkg/modules/prometheus/prometheus.go index 107d2b70..469cbbd3 100644 --- a/pkg/modules/prometheus/prometheus.go +++ b/pkg/modules/prometheus/prometheus.go @@ -41,7 +41,7 @@ func (mod *Prometheus) Descriptor() gotenberg.ModuleDescriptor { fs := flag.NewFlagSet("prometheus", flag.ExitOnError) fs.String("prometheus-namespace", "gotenberg", "Set the namespace of modules' metrics") fs.Duration("prometheus-collect-interval", time.Duration(1)*time.Second, "Set the interval for collecting modules' metrics") - fs.Bool("prometheus-disable-route-telemetry", false, "Disable telemetry for the Prometheus metrics route") + fs.Bool("prometheus-disable-route-telemetry", true, "Disable telemetry for the Prometheus metrics route") fs.Bool("prometheus-disable-collect", false, "Disable the collect of metrics") fs.String("prometheus-metrics-path", "/prometheus/metrics", "Path for Prometheus metrics endpoint") diff --git a/test/integration/features/debug.feature b/test/integration/features/debug.feature index 431ff8b3..ca4ba602 100644 --- a/test/integration/features/debug.feature +++ b/test/integration/features/debug.feature @@ -58,10 +58,10 @@ Feature: /debug "api-correlation-id-header": "Gotenberg-Trace", "api-disable-download-from": "false", "api-disable-health-check-logging": "false", - "api-disable-debug-route-telemetry": "false", - "api-disable-health-check-route-telemetry": "false", - "api-disable-root-route-telemetry": "false", - "api-disable-version-route-telemetry": "false", + "api-disable-debug-route-telemetry": "true", + "api-disable-health-check-route-telemetry": "true", + "api-disable-root-route-telemetry": "true", + "api-disable-version-route-telemetry": "true", "api-download-from-allow-list": "[]", "api-download-from-deny-list": "[]", "api-download-from-max-retry": "4", @@ -121,7 +121,7 @@ Feature: /debug "prometheus-collect-interval": "1s", "prometheus-disable-collect": "false", "prometheus-disable-route-logging": "false", - "prometheus-disable-route-telemetry": "false", + "prometheus-disable-route-telemetry": "true", "prometheus-namespace": "gotenberg", "prometheus-metrics-path": "/prometheus/metrics", "webhook-allow-list": "[]", @@ -190,10 +190,10 @@ Feature: /debug "api-correlation-id-header": "Gotenberg-Trace", "api-disable-download-from": "false", "api-disable-health-check-logging": "false", - "api-disable-debug-route-telemetry": "false", - "api-disable-health-check-route-telemetry": "false", - "api-disable-root-route-telemetry": "false", - "api-disable-version-route-telemetry": "false", + "api-disable-debug-route-telemetry": "true", + "api-disable-health-check-route-telemetry": "true", + "api-disable-root-route-telemetry": "true", + "api-disable-version-route-telemetry": "true", "api-download-from-allow-list": "[]", "api-download-from-deny-list": "[]", "api-download-from-max-retry": "4", @@ -253,7 +253,7 @@ Feature: /debug "prometheus-collect-interval": "1s", "prometheus-disable-collect": "false", "prometheus-disable-route-logging": "false", - "prometheus-disable-route-telemetry": "false", + "prometheus-disable-route-telemetry": "true", "prometheus-namespace": "gotenberg", "prometheus-metrics-path": "/prometheus/metrics", "webhook-allow-list": "[]",