feat(otel): add OpenTelemetry support

Makefile

@@ -20,16 +20,16 @@ API_BIND_IP=
 API_START_TIMEOUT=30s
 API_TIMEOUT=30s
 API_BODY_LIMIT=
-API_ROOT_PATH="/"
-API_TRACE_HEADER=Gotenberg-Trace
+API_ROOT_PATH=/
+API_CORRELATION_ID_HEADER=Gotenberg-Trace
 API_ENABLE_BASIC_AUTH=false
 GOTENBERG_API_BASIC_AUTH_USERNAME=
 GOTENBERG_API_BASIC_AUTH_PASSWORD=
-API-DOWNLOAD-FROM-ALLOW-LIST=
-API-DOWNLOAD-FROM-DENY-LIST=
-API-DOWNLOAD-FROM-FROM-MAX-RETRY=4
-API-DISABLE-DOWNLOAD-FROM=false
-API_DISABLE_HEALTH_CHECK_LOGGING=false
+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_ENABLE_DEBUG_ROUTE=false
 CHROMIUM_RESTART_AFTER=100
 CHROMIUM_MAX_QUEUE_SIZE=0
@@ -54,9 +54,9 @@ LIBREOFFICE_AUTO_START=false
 LIBREOFFICE_START_TIMEOUT=20s
 LIBREOFFICE_DISABLE_ROUTES=false
 LOG_LEVEL=info
-LOG_FORMAT=auto
 LOG_FIELDS_PREFIX=
-LOG_ENABLE_GCP_FIELDS=false
+LOG_STD_FORMAT=auto
+LOG_STD_ENABLE_GCP_FIELDS=false
 PDFENGINES_DISABLE_ROUTES=false
 PDFENGINES_MERGE_ENGINES=qpdf,pdfcpu,pdftk
 PDFENGINES_SPLIT_ENGINES=pdfcpu,qpdf,pdftk
@@ -76,6 +76,13 @@ PROMETHEUS_COLLECT_INTERVAL=1s
 PROMETHEUS_DISABLE_ROUTE_LOGGING=false
 PROMETHEUS_DISABLE_COLLECT=false
 PROMETHEUS_METRICS_PATH=/prometheus/metrics
+OTEL_SERVICE_NAME=gotenberg
+OTEL_TRACES_EXPORTER=none
+OTEL_METRICS_EXPORTER=none
+OTEL_LOGS_EXPORTER=none
+OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4317
+OTEL_EXPORTER_OTLP_INSECURE=true
 WEBHOOK_ENABLE_SYNC_MODE=false
 WEBHOOK_ALLOW_LIST=
 WEBHOOK_DENY_LIST=
@@ -87,88 +94,20 @@ WEBHOOK_RETRY_MAX_WAIT=30s
 WEBHOOK_CLIENT_TIMEOUT=30s
 WEBHOOK_DISABLE=false
 
+# Export all variables so they are available to Compose
+export
+
 .PHONY: run
-run: ## Start a Gotenberg container
-	docker run --rm -it \
-	-p $(API_PORT):$(API_PORT) \
-	-e GOTENBERG_API_BASIC_AUTH_USERNAME=$(GOTENBERG_API_BASIC_AUTH_USERNAME) \
-	-e GOTENBERG_API_BASIC_AUTH_PASSWORD=$(GOTENBERG_API_BASIC_AUTH_PASSWORD) \
-	-e TZ=$(TZ) \
-	$(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY):$(GOTENBERG_VERSION) \
-	gotenberg \
-	--gotenberg-hide-banner=$(GOTENBERG_HIDE_BANNER) \
-	--gotenberg-graceful-shutdown-duration=$(GOTENBERG_GRACEFUL_SHUTDOWN_DURATION) \
-	--gotenberg-build-debug-data="$(GOTENBERG_BUILD_DEBUG_DATA)" \
-	--api-port=$(API_PORT) \
-	--api-port-from-env=$(API_PORT_FROM_ENV) \
-	--api-bind-ip=$(API_BIND_IP) \
-	--api-start-timeout=$(API_START_TIMEOUT) \
-	--api-timeout=$(API_TIMEOUT) \
-	--api-body-limit="$(API_BODY_LIMIT)" \
-	--api-root-path=$(API_ROOT_PATH) \
-	--api-trace-header=$(API_TRACE_HEADER) \
-	--api-enable-basic-auth=$(API_ENABLE_BASIC_AUTH) \
-	--api-download-from-allow-list=$(API-DOWNLOAD-FROM-ALLOW-LIST) \
-	--api-download-from-deny-list=$(API-DOWNLOAD-FROM-DENY-LIST) \
-	--api-download-from-max-retry=$(API-DOWNLOAD-FROM-FROM-MAX-RETRY) \
-	--api-disable-download-from=$(API-DISABLE-DOWNLOAD-FROM) \
-	--api-disable-health-check-logging=$(API_DISABLE_HEALTH_CHECK_LOGGING) \
-	--api-enable-debug-route=$(API_ENABLE_DEBUG_ROUTE) \
-	--chromium-restart-after=$(CHROMIUM_RESTART_AFTER) \
-	--chromium-auto-start=$(CHROMIUM_AUTO_START) \
-	--chromium-max-queue-size=$(CHROMIUM_MAX_QUEUE_SIZE) \
-	--chromium-max-concurrency=$(CHROMIUM_MAX_CONCURRENCY) \
-	--chromium-start-timeout=$(CHROMIUM_START_TIMEOUT) \
-	--chromium-allow-insecure-localhost=$(CHROMIUM_ALLOW_INSECURE_LOCALHOST) \
-	--chromium-ignore-certificate-errors=$(CHROMIUM_IGNORE_CERTIFICATE_ERRORS) \
-	--chromium-disable-web-security=$(CHROMIUM_DISABLE_WEB_SECURITY) \
-	--chromium-allow-file-access-from-files=$(CHROMIUM_ALLOW_FILE_ACCESS_FROM_FILES) \
-	--chromium-host-resolver-rules=$(CHROMIUM_HOST_RESOLVER_RULES) \
-	--chromium-proxy-server=$(CHROMIUM_PROXY_SERVER) \
-	--chromium-allow-list="$(CHROMIUM_ALLOW_LIST)" \
-	--chromium-deny-list="$(CHROMIUM_DENY_LIST)" \
-	--chromium-clear-cache=$(CHROMIUM_CLEAR_CACHE) \
-	--chromium-clear-cookies=$(CHROMIUM_CLEAR_COOKIES) \
-	--chromium-disable-javascript=$(CHROMIUM_DISABLE_JAVASCRIPT) \
-	--chromium-disable-routes=$(CHROMIUM_DISABLE_ROUTES) \
-	--libreoffice-restart-after=$(LIBREOFFICE_RESTART_AFTER) \
-	--libreoffice-max-queue-size=$(LIBREOFFICE_MAX_QUEUE_SIZE) \
-	--libreoffice-auto-start=$(LIBREOFFICE_AUTO_START) \
-	--libreoffice-start-timeout=$(LIBREOFFICE_START_TIMEOUT) \
-	--libreoffice-disable-routes=$(LIBREOFFICE_DISABLE_ROUTES) \
-	--log-level=$(LOG_LEVEL) \
-	--log-format=$(LOG_FORMAT) \
-	--log-fields-prefix=$(LOG_FIELDS_PREFIX) \
-	--log-enable-gcp-fields=$(LOG_ENABLE_GCP_FIELDS) \
-	--pdfengines-disable-routes=$(PDFENGINES_DISABLE_ROUTES) \
-	--pdfengines-merge-engines=$(PDFENGINES_MERGE_ENGINES) \
-	--pdfengines-split-engines=$(PDFENGINES_SPLIT_ENGINES) \
-	--pdfengines-flatten-engines=$(PDFENGINES_FLATTEN_ENGINES) \
-	--pdfengines-convert-engines=$(PDFENGINES_CONVERT_ENGINES) \
-	--pdfengines-read-metadata-engines=$(PDFENGINES_READ_METADATA_ENGINES) \
-	--pdfengines-write-metadata-engines=$(PDFENGINES_WRITE_METADATA_ENGINES) \
-	--pdfengines-read-bookmarks-engines=$(PDFENGINES_READ_BOOKMARKS_ENGINES) \
-	--pdfengines-write-bookmarks-engines=$(PDFENGINES_WRITE_BOOKMARKS_ENGINES) \
-	--pdfengines-watermark-engines=$(PDFENGINES_WATERMARK_ENGINES) \
-	--pdfengines-stamp-engines=$(PDFENGINES_STAMP_ENGINES) \
-	--pdfengines-encrypt-engines=$(PDFENGINES_ENCRYPT_ENGINES) \
-	--pdfengines-rotate-engines=$(PDFENGINES_ROTATE_ENGINES) \
-	--pdfengines-embed-engines=$(PDFENGINES_EMBED_ENGINES) \
-	--prometheus-namespace=$(PROMETHEUS_NAMESPACE) \
-	--prometheus-collect-interval=$(PROMETHEUS_COLLECT_INTERVAL) \
-	--prometheus-disable-route-logging=$(PROMETHEUS_DISABLE_ROUTE_LOGGING) \
-	--prometheus-disable-collect=$(PROMETHEUS_DISABLE_COLLECT) \
-	--prometheus-metrics-path=$(PROMETHEUS_METRICS_PATH) \
-	--webhook-enable-sync-mode="$(WEBHOOK_ENABLE_SYNC_MODE)" \
-	--webhook-allow-list="$(WEBHOOK_ALLOW_LIST)" \
-	--webhook-deny-list="$(WEBHOOK_DENY_LIST)" \
-	--webhook-error-allow-list=$(WEBHOOK_ERROR_ALLOW_LIST) \
-	--webhook-error-deny-list=$(WEBHOOK_ERROR_DENY_LIST) \
-	--webhook-max-retry=$(WEBHOOK_MAX_RETRY) \
-	--webhook-retry-min-wait=$(WEBHOOK_RETRY_MIN_WAIT) \
-	--webhook-retry-max-wait=$(WEBHOOK_RETRY_MAX_WAIT) \
-	--webhook-client-timeout=$(WEBHOOK_CLIENT_TIMEOUT) \
-	--webhook-disable=$(WEBHOOK_DISABLE)
+run: ## Start a Gotenberg container via Compose
+	docker compose up gotenberg
+
+.PHONY: telemetry
+telemetry: ## Start an OpenTelemetry collector and OpenObserve containers via Compose
+	docker compose up otel-collector openobserve
+
+.PHONY: down
+down: ## Stop all containers
+	docker compose down -v
 
 .PHONY: test-unit
 test-unit: ## Run unit tests