chore: update Go dependencies

feat(logging): add a new flag for preprending a prefix to each field in the logs (close #659 )
feat: improve Dockerfiles for a better DX
2026-08-08 00:22:14 +01:00 · 2023-07-19 22:03:45 +02:00 · 2023-07-19 22:03:09 +02:00 · 2023-07-19 09:50:43 +02:00 · 2023-07-18 14:46:23 +02:00
12 changed files with 434 additions and 221 deletions
--- a/2
+++ b/2
@@ -48,6 +48,7 @@ CHROMIUM_DISABLE_ROUTES=false
 LIBREOFFICE_DISABLES_ROUTES=false
 LOG_LEVEL=info
 LOG_FORMAT=auto
+LOG_FIELDS_PREFIX=
 PDFENGINES_ENGINES=
 PDFENGINES_DISABLE_ROUTES=false
 PROMETHEUS_NAMESPACE=gotenberg
@@ -94,6 +95,7 @@ run: ## Start a Gotenberg container
 	--libreoffice-disable-routes=$(LIBREOFFICE_DISABLES_ROUTES) \
 	--log-level=$(LOG_LEVEL) \
 	--log-format=$(LOG_FORMAT) \
+	--log-fields-prefix=$(LOG_FIELDS_PREFIX) \
 	--pdfengines-engines=$(PDFENGINES_ENGINES) \
 	--pdfengines-disable-routes=$(PDFENGINES_DISABLE_ROUTES) \
 	--prometheus-namespace=$(PROMETHEUS_NAMESPACE) \
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -0,0 +1,41 @@
+# Security Policy
+
+## Supported Versions
+
+Please ensure to keep your environment up-to-date and use only the latest version of Gotenberg. 
+Security updates and patches will be applied only to the most recent version.
+
+## Reporting a Vulnerability
+
+Your help in identifying vulnerabilities in our project is much appreciated. 
+We take all reports regarding security seriously.
+
+If you discover a security vulnerability, please refrain from publishing it publicly. 
+Instead, kindly send us the details via email to *neuhart [dot] julien [at] gmail [dot] com*.
+
+In the subject of your email, please indicate that it's a security vulnerability report for Gotenberg. 
+In your message, please include:
+
+* A detailed description of the vulnerability.
+* The steps to reproduce the issue.
+* Any potential impact of the vulnerability on the users or system.
+
+Please remember that this process is done in a *'best-effort'* manner. 
+This means we strive to respond and act as quickly as possible, but the speed may vary depending on the severity of
+the issue and our resources.
+
+Thank you in advance for helping to keep our project safe!
+
+## Disclosure Policy
+
+Once we have received your vulnerability report, we will work to validate and reproduce the issue. 
+If we can confirm the vulnerability, we will proceed to:
+
+* Work on a fix and a release timeline.
+* Notify you when the fix has been implemented and released.
+* Credit you for discovering the vulnerability (unless you request anonymity).
+* Please note that we will do our best to keep you informed about the progress towards resolving the issue.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved, please submit a pull request.
--- a/build/Dockerfile
+++ b/build/Dockerfile
@@ -1,11 +1,15 @@
-# Note: ARG instructions do not create additional layers.
-# Instead, next layers will concatenate them.
+# ARG instructions do not create additional layers. Instead, next layers will
+# concatenate them. Also, we have to repeat ARG instructions in each build
+# stage that uses them.
 ARG GOLANG_VERSION
-# Note: we have to repeat ARG instructions in each build stage that uses them.
 ARG GOTENBERG_VERSION

-FROM golang:$GOLANG_VERSION AS builder
+# ----------------------------------------------
+# Gotenberg binary build stage
+# ----------------------------------------------
+FROM golang:$GOLANG_VERSION AS binary-stage

+ARG GOTENBERG_VERSION
 ENV CGO_ENABLED 0

 # Define the working directory outside of $GOPATH (we're using go modules).
@@ -21,14 +25,18 @@ RUN go mod download &&\
 COPY cmd ./cmd
 COPY pkg ./pkg

-# Build the binary.
-ARG GOTENBERG_VERSION
-
 RUN go build -o gotenberg -ldflags "-X 'github.com/gotenberg/gotenberg/v7/cmd.Version=$GOTENBERG_VERSION'" cmd/gotenberg/main.go

+# ----------------------------------------------
+# Final stage
+# ----------------------------------------------
 FROM debian:11-slim

 ARG GOTENBERG_VERSION
+ARG GOTENBERG_USER_GID
+ARG GOTENBERG_USER_UID
+ARG NOTO_COLOR_EMOJI_VERSION
+ARG PDFTK_VERSION

 LABEL author="Julien Neuhart" \
      description="A Docker-powered stateless API for PDF files." \
@@ -36,43 +44,33 @@ LABEL author="Julien Neuhart" \
      version="$GOTENBERG_VERSION" \
      website="https://gotenberg.dev"

-# Improve fonts subpixel hinting and smoothing.
-# Credits:
-# https://github.com/arachnys/athenapdf/issues/69.
-# https://github.com/arachnys/athenapdf/commit/ba25a8d80a25d08d58865519c4cd8756dc9a336d.
-COPY build/fonts.conf /etc/fonts/conf.d/100-gotenberg.conf
-
-# Simple wrapper around Java and PDFtk.
-COPY build/pdftk.sh /usr/bin/pdftk
-
-# Setup the Docker image.
-ARG GOTENBERG_USER_GID
-ARG GOTENBERG_USER_UID
-ARG NOTO_COLOR_EMOJI_VERSION
-ARG PDFTK_VERSION
-
-# Script for installing either Google Chrome stable on amd64 architecture or
-# Chromium on other architectures.
-# See https://github.com/gotenberg/gotenberg/issues/328.
-COPY build/install-chromium.sh /tmp/install-chromium.sh
-
 RUN \
    # Create a non-root user.
    # All processes in the Docker container will run with this dedicated user.
    groupadd --gid "$GOTENBERG_USER_GID" gotenberg &&\
    useradd --uid "$GOTENBERG_USER_UID" --gid gotenberg --shell /bin/bash --home /home/gotenberg --no-create-home gotenberg &&\
    mkdir /home/gotenberg &&\
-    chown gotenberg: /home/gotenberg &&\
-    # Install dependencies required for the next instructions or debugging.
+    chown gotenberg: /home/gotenberg
+
+RUN \
+    # Install system dependencies required for the next instructions or debugging.
    # Note: tini is a helper for reaping zombie processes.
    apt-get update -qq &&\
    DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends curl gnupg htop tini python3 default-jre-headless &&\
    ln -s /usr/bin/htop /usr/bin/top &&\
+    # Cleanup.
+    # Note: the Debian image does automatically a clean after each install thanks to a hook.
+    # Therefore, there is no need for apt-get clean.
+    # See https://stackoverflow.com/a/24417119/3248473.
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN \
    # Install fonts.
    # Credits:
    # https://github.com/arachnys/athenapdf/blob/master/cli/Dockerfile.
    # https://help.accusoft.com/PrizmDoc/v12.1/HTML/Installing_Asian_Fonts_on_Ubuntu_and_Debian.html.
    curl -o ./ttf-mscorefonts-installer_3.8_all.deb http://httpredir.debian.org/debian/pool/contrib/m/msttcorefonts/ttf-mscorefonts-installer_3.8_all.deb &&\
+    apt-get update -qq &&\
    DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends \
    ./ttf-mscorefonts-installer_3.8_all.deb \
    culmus \
@@ -115,53 +113,69 @@ RUN \
    # https://github.com/gotenberg/gotenberg/pull/325.
    # https://github.com/googlefonts/noto-emoji.
    curl -Ls "https://github.com/googlefonts/noto-emoji/raw/$NOTO_COLOR_EMOJI_VERSION/fonts/NotoColorEmoji.ttf" -o /usr/local/share/fonts/NotoColorEmoji.ttf &&\
-    # Install Google Chrome / Chromium.
-    /tmp/install-chromium.sh &&\
-    # Install LibreOffice.
+    # Cleanup.
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN \
+    # Install either Google Chrome stable on amd64 architecture or
+    # Chromium on other architectures.
+    # See https://github.com/gotenberg/gotenberg/issues/328.
+    /bin/bash -c \
+    'set -e &&\
+    if [[ "$(dpkg --print-architecture)" == "amd64" ]]; then \
+      curl https://dl.google.com/linux/linux_signing_key.pub | apt-key add - &&\
+      echo "deb http://dl.google.com/linux/chrome/deb/ stable main" | tee /etc/apt/sources.list.d/google-chrome.list &&\
+      apt-get update -qq &&\
+      DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends --allow-unauthenticated google-chrome-stable &&\
+      mv /usr/bin/google-chrome-stable /usr/bin/chromium; \
+    else \
+      apt-get update -qq &&\
+      DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends chromium; \
+    fi' &&\
+    # Verify installation.
+    chromium --version &&\
+    # Cleanup.
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN \
+    # Install LibreOffice & unoconv.
+    apt-get update -qq &&\
    DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends libreoffice &&\
-    # Next lines are not currently relevant, as latest versions of LibreOffice
-    # (i.e., > 7.0.4) are causing troubles.
-    # See:
-    # https://packages.debian.org/search?keywords=libreoffice.
-    # https://github.com/gotenberg/gotenberg/issues/442.
-    # https://github.com/gotenberg/gotenberg/issues/516.
-    # https://github.com/gotenberg/gotenberg/issues/529.
-    # https://github.com/gotenberg/gotenberg/issues/537.
-    # https://github.com/gotenberg/gotenberg/issues/568.
-        # Note: we use the bullseye-backports distribution to get the latest LibreOffice version.
-        # See:
-        # https://github.com/gotenberg/gotenberg/pull/322.
-        # https://github.com/gotenberg/gotenberg/issues/403.
-        #echo "deb https://httpredir.debian.org/debian/ bullseye-backports main contrib non-free" >> /etc/apt/sources.list &&\
-        #apt-get update -qq &&\
-        #DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends -t bullseye-backports libreoffice &&\
-    # Download unoconv (Python script).
    curl -Ls https://raw.githubusercontent.com/dagwieers/unoconv/master/unoconv -o /usr/bin/unoconv &&\
    chmod +x /usr/bin/unoconv &&\
    # unoconv will look for the Python binary, which has to be at version 3.
    ln -s /usr/bin/python3 /usr/bin/python &&\
-    # Download PDFtk.
-    # See https://github.com/gotenberg/gotenberg/pull/273. \
+    # Verify installations.
+    libreoffice --version &&\
+    unoconv --version &&\
+    # Cleanup.
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN \
+    # Install PDFtk & QPDF (PDF engines).
+    # See https://github.com/gotenberg/gotenberg/pull/273.
    curl -o /usr/bin/pdftk-all.jar "https://gitlab.com/api/v4/projects/5024297/packages/generic/pdftk-java/$PDFTK_VERSION/pdftk-all.jar" &&\
    chmod a+x /usr/bin/pdftk-all.jar &&\
-    # Download QPDF.
+    echo '#!/bin/bash\n\nexec java -jar /usr/bin/pdftk-all.jar "$@"' > /usr/bin/pdftk && \
+    chmod +x /usr/bin/pdftk &&\
+    apt-get update -qq &&\
    DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends qpdf &&\
    # See https://github.com/nextcloud/docker/issues/380.
    mkdir -p /usr/share/man/man1 &&\
-    # Cleanup.
-    # Note: the Debian image does automatically a clean after each install thanks to a hook.
-    # Therefore, there is no need for apt-get clean.
-    # See https://stackoverflow.com/a/24417119/3248473.
-    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* &&\
-    # Print versions of main dependencies.
-    chromium --version &&\
-    libreoffice --version &&\
-    unoconv --version &&\
+    # Verify installations.
    pdftk --version &&\
-    qpdf --version
+    qpdf --version &&\
+    # Cleanup.
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Improve fonts subpixel hinting and smoothing.
+# Credits:
+# https://github.com/arachnys/athenapdf/issues/69.
+# https://github.com/arachnys/athenapdf/commit/ba25a8d80a25d08d58865519c4cd8756dc9a336d.
+COPY build/fonts.conf /etc/fonts/conf.d/100-gotenberg.conf

 # Copy the Gotenberg binary from the builder stage.
-COPY --from=builder /home/gotenberg /usr/bin/
+COPY --from=binary-stage /home/gotenberg /usr/bin/

 # Environment variables required by modules or else.
 ENV GC_EXCLUDE_SUBSTR "hsperfdata_root,hsperfdata_gotenberg"
--- a/build/Dockerfile.cloudrun
+++ b/build/Dockerfile.cloudrun
@@ -1,5 +1,3 @@
-# Note: ARG instructions do not create additional layers.
-# Instead, next layers will concatenate them.
 ARG DOCKER_REPOSITORY
 ARG GOTENBERG_VERSION

--- a/build/install-chromium.sh
+++ b/build/install-chromium.sh
@@ -1,15 +0,0 @@
-#!/bin/bash
-
-set -e
-
-ARCH=$(dpkg --print-architecture)
-
-if [[ "$ARCH" == "amd64" ]]; then
-  curl https://dl.google.com/linux/linux_signing_key.pub | apt-key add -
-  echo "deb http://dl.google.com/linux/chrome/deb/ stable main" | tee /etc/apt/sources.list.d/google-chrome.list
-  apt-get update -qq
-  DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends --allow-unauthenticated google-chrome-stable
-  mv /usr/bin/google-chrome-stable /usr/bin/chromium
-else
-  DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends chromium
-fi
--- a/build/pdftk.sh
+++ b/build/pdftk.sh
@@ -1,3 +0,0 @@
-#!/bin/bash
-
-exec java -jar /usr/bin/pdftk-all.jar "$@"
--- a/go.mod
+++ b/go.mod
@@ -5,36 +5,36 @@ go 1.20
 require (
 	github.com/alexliesenfeld/health v0.7.0
 	github.com/andybalholm/brotli v1.0.5 // indirect
-	github.com/chromedp/cdproto v0.0.0-20230524011726-8501c74e8228
+	github.com/chromedp/cdproto v0.0.0-20230716001748-3ed7c525ec8b
 	github.com/chromedp/chromedp v0.9.1
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.3.0
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-	github.com/hashicorp/go-retryablehttp v0.7.2
-	github.com/klauspost/compress v1.16.5 // indirect
+	github.com/hashicorp/go-retryablehttp v0.7.4
+	github.com/klauspost/compress v1.16.7 // indirect
 	github.com/klauspost/pgzip v1.2.6 // indirect
-	github.com/labstack/echo/v4 v4.10.2
+	github.com/labstack/echo/v4 v4.11.1
 	github.com/labstack/gommon v0.4.0
 	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/mholt/archiver/v3 v3.5.1
-	github.com/microcosm-cc/bluemonday v1.0.24
+	github.com/microcosm-cc/bluemonday v1.0.25
 	github.com/nwaples/rardecode v1.1.3 // indirect
 	github.com/pdfcpu/pdfcpu v0.4.1
-	github.com/pierrec/lz4/v4 v4.1.17 // indirect
-	github.com/prometheus/client_golang v1.15.1
+	github.com/pierrec/lz4/v4 v4.1.18 // indirect
+	github.com/prometheus/client_golang v1.16.0
 	github.com/russross/blackfriday/v2 v2.1.0
 	github.com/spf13/pflag v1.0.5
 	github.com/ulikunitz/xz v0.5.11 // indirect
 	go.uber.org/atomic v1.11.0 // indirect
 	go.uber.org/multierr v1.11.0
 	go.uber.org/zap v1.24.0
-	golang.org/x/crypto v0.9.0 // indirect
-	golang.org/x/image v0.7.0 // indirect
-	golang.org/x/net v0.10.0
-	golang.org/x/sync v0.2.0
-	golang.org/x/sys v0.8.0 // indirect
-	golang.org/x/term v0.8.0
-	golang.org/x/text v0.9.0
+	golang.org/x/crypto v0.11.0 // indirect
+	golang.org/x/image v0.9.0 // indirect
+	golang.org/x/net v0.12.0
+	golang.org/x/sync v0.3.0
+	golang.org/x/sys v0.10.0 // indirect
+	golang.org/x/term v0.10.0
+	golang.org/x/text v0.11.0
 )

 require (
@@ -59,11 +59,11 @@ require (
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_model v0.4.0 // indirect
 	github.com/prometheus/common v0.44.0 // indirect
-	github.com/prometheus/procfs v0.10.0 // indirect
+	github.com/prometheus/procfs v0.11.0 // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasttemplate v1.2.2 // indirect
 	github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
-	google.golang.org/protobuf v1.30.0 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
--- a/go.sum
+++ b/go.sum
@@ -11,8 +11,8 @@ github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6r
 github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/chromedp/cdproto v0.0.0-20230220211738-2b1ec77315c9/go.mod h1:GKljq0VrfU4D5yc+2qA6OVr8pmO/MBbPEWqWQ/oqGEs=
-github.com/chromedp/cdproto v0.0.0-20230524011726-8501c74e8228 h1:t5YUtCgmUJJ4H5mwQhst70ZxpaCK4SGDtFRPKKw+cYU=
-github.com/chromedp/cdproto v0.0.0-20230524011726-8501c74e8228/go.mod h1:GKljq0VrfU4D5yc+2qA6OVr8pmO/MBbPEWqWQ/oqGEs=
+github.com/chromedp/cdproto v0.0.0-20230716001748-3ed7c525ec8b h1:4RSQDLMb5m1XmyOgy7iQJmXuVsK24TaBoToW/FIFigA=
+github.com/chromedp/cdproto v0.0.0-20230716001748-3ed7c525ec8b/go.mod h1:GKljq0VrfU4D5yc+2qA6OVr8pmO/MBbPEWqWQ/oqGEs=
 github.com/chromedp/chromedp v0.9.1 h1:CC7cC5p1BeLiiS2gfNNPwp3OaUxtRMBjfiw3E3k6dFA=
 github.com/chromedp/chromedp v0.9.1/go.mod h1:DUgZWRvYoEfgi66CgZ/9Yv+psgi+Sksy5DTScENWjaQ=
 github.com/chromedp/sysutil v1.0.0 h1:+ZxhTpfpZlmchB58ih/LBHX52ky7w2VhQVKQMucy3Ic=
@@ -48,8 +48,8 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n
 github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
 github.com/hashicorp/go-hclog v0.9.2 h1:CG6TE5H9/JXsFWJCfoIVpKFIkFe6ysEuHirp4DxCsHI=
 github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ=
-github.com/hashicorp/go-retryablehttp v0.7.2 h1:AcYqCvkpalPnPF2pn0KamgwamS42TqUDDYFRKq/RAd0=
-github.com/hashicorp/go-retryablehttp v0.7.2/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8=
+github.com/hashicorp/go-retryablehttp v0.7.4 h1:ZQgVdpTdAL7WpMIwLzCfbalOcSUdkDZnpUv3/+BxzFA=
+github.com/hashicorp/go-retryablehttp v0.7.4/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8=
 github.com/hhrutter/lzw v1.0.0 h1:laL89Llp86W3rRs83LvKbwYRx6INE8gDn0XNb1oXtm0=
 github.com/hhrutter/lzw v1.0.0/go.mod h1:2HC6DJSn/n6iAZfgM3Pg+cP1KxeWc3ezG8bBqW5+WEo=
 github.com/hhrutter/tiff v1.0.0 h1:T8/QVXiABO6Er7XCoExh4XPGyMO+X1ynf0V8kHui3t4=
@@ -58,8 +58,8 @@ github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8Hm
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/klauspost/compress v1.4.1/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
 github.com/klauspost/compress v1.11.4/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs=
-github.com/klauspost/compress v1.16.5 h1:IFV2oUNUzZaz+XyusxpLzpzS8Pt5rh0Z16For/djlyI=
-github.com/klauspost/compress v1.16.5/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
+github.com/klauspost/compress v1.16.7 h1:2mk3MPGNzKyxErAw8YaohYh69+pa4sIQSC0fPGCFR9I=
+github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
 github.com/klauspost/cpuid v1.2.0/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek=
 github.com/klauspost/pgzip v1.2.5/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
 github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
@@ -67,8 +67,8 @@ github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQ
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/labstack/echo/v4 v4.10.2 h1:n1jAhnq/elIFTHr1EYpiYtyKgx4RW9ccVgkqByZaN2M=
-github.com/labstack/echo/v4 v4.10.2/go.mod h1:OEyqf2//K1DFdE57vw2DRgWY0M7s65IVQO2FzvI4J5k=
+github.com/labstack/echo/v4 v4.11.1 h1:dEpLU2FLg4UVmvCGPuk/APjlH6GDpbEPti61srUUUs4=
+github.com/labstack/echo/v4 v4.11.1/go.mod h1:YuYRTSM3CHs2ybfrL8Px48bO6BAnYIN4l8wSTMP6BDQ=
 github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8=
 github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM=
 github.com/ledongthuc/pdf v0.0.0-20220302134840-0c2507a12d80 h1:6Yzfa6GP0rIo/kULo2bwGEkFvCePZ3qHDDTC3/J9Swo=
@@ -88,8 +88,8 @@ github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zk
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
 github.com/mholt/archiver/v3 v3.5.1 h1:rDjOBX9JSF5BvoJGvjqK479aL70qh9DIpZCl+k7Clwo=
 github.com/mholt/archiver/v3 v3.5.1/go.mod h1:e3dqJ7H78uzsRSEACH1joayhuSyhnonssnDhppzS1L4=
-github.com/microcosm-cc/bluemonday v1.0.24 h1:NGQoPtwGVcbGkKfvyYk1yRqknzBuoMiUrO6R7uFTPlw=
-github.com/microcosm-cc/bluemonday v1.0.24/go.mod h1:ArQySAMps0790cHSkdPEJ7bGkF2VePWH773hsJNSHf8=
+github.com/microcosm-cc/bluemonday v1.0.25 h1:4NEwSfiJ+Wva0VxN5B8OwMicaJvD8r9tlJWm9rtloEg=
+github.com/microcosm-cc/bluemonday v1.0.25/go.mod h1:ZIOjCQp1OrzBBPIJmfX4qDYFuhU02nx4bn030ixfHLE=
 github.com/nwaples/rardecode v1.1.0/go.mod h1:5DzqNKiOdpKKBH87u8VlvAnPZMXcGRhxWkRpHbbfGS0=
 github.com/nwaples/rardecode v1.1.3 h1:cWCaZwfM5H7nAD6PyEdcVnczzV8i/JtotnyW/dD9lEc=
 github.com/nwaples/rardecode v1.1.3/go.mod h1:5DzqNKiOdpKKBH87u8VlvAnPZMXcGRhxWkRpHbbfGS0=
@@ -98,20 +98,20 @@ github.com/orisano/pixelmatch v0.0.0-20220722002657-fb0b55479cde/go.mod h1:nZgzb
 github.com/pdfcpu/pdfcpu v0.4.1 h1:oKgcST93zXdq1vE+B8dQBlE8S7WqsBVgkLxg82M3Fgk=
 github.com/pdfcpu/pdfcpu v0.4.1/go.mod h1:MojCBFW2uljNs3CBmyTDeFAvu7vI1LrJhWNMCjY3kg4=
 github.com/pierrec/lz4/v4 v4.1.2/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
-github.com/pierrec/lz4/v4 v4.1.17 h1:kV4Ip+/hUBC+8T6+2EgburRtkE9ef4nbY3f4dFhGjMc=
-github.com/pierrec/lz4/v4 v4.1.17/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
+github.com/pierrec/lz4/v4 v4.1.18 h1:xaKrnTkyoqfh1YItXl56+6KJNVYWlEEPuAQW9xsplYQ=
+github.com/pierrec/lz4/v4 v4.1.18/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/prometheus/client_golang v1.15.1 h1:8tXpTmJbyH5lydzFPoxSIJ0J46jdh3tylbvM1xCv0LI=
-github.com/prometheus/client_golang v1.15.1/go.mod h1:e9yaBhRPU2pPNsZwE+JdQl0KEt1N9XgF6zxWmaC0xOk=
+github.com/prometheus/client_golang v1.16.0 h1:yk/hx9hDbrGHovbci4BY+pRMfSuuat626eFsHb7tmT8=
+github.com/prometheus/client_golang v1.16.0/go.mod h1:Zsulrv/L9oM40tJ7T815tM89lFEugiJ9HzIqaAx4LKc=
 github.com/prometheus/client_model v0.4.0 h1:5lQXD3cAg1OXBf4Wq03gTrXHeaV0TQvGfUooCfx1yqY=
 github.com/prometheus/client_model v0.4.0/go.mod h1:oMQmHW1/JoDwqLtg57MGgP/Fb1CJEYF2imWWhWtMkYU=
 github.com/prometheus/common v0.44.0 h1:+5BrQJwiBB9xsMygAB3TNvpQKOwlkc25LbISbrdOOfY=
 github.com/prometheus/common v0.44.0/go.mod h1:ofAIvZbQ1e/nugmZGz4/qCb9Ap1VoSTIO7x0VV9VvuY=
-github.com/prometheus/procfs v0.10.0 h1:UkG7GPYkO4UZyLnyXjaWYcgOSONqwdBqFUT95ugmt6I=
-github.com/prometheus/procfs v0.10.0/go.mod h1:nwNm2aOCAYw8uTR/9bWRREkZFxAUcWzPHWJq+XBB/FM=
+github.com/prometheus/procfs v0.11.0 h1:5EAgkfkMl659uZPbe9AS2N68a7Cc1TJbPEuGzFuRbyk=
+github.com/prometheus/procfs v0.11.0/go.mod h1:nwNm2aOCAYw8uTR/9bWRREkZFxAUcWzPHWJq+XBB/FM=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
 github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
@@ -151,24 +151,24 @@ go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
 go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.9.0 h1:LF6fAI+IutBocDJ2OT0Q1g8plpYljMZ4+lty+dsqw3g=
-golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0=
-golang.org/x/image v0.7.0 h1:gzS29xtG1J5ybQlv0PuyfE3nmc6R4qB73m6LUUmvFuw=
-golang.org/x/image v0.7.0/go.mod h1:nd/q4ef1AKKYl/4kft7g+6UyGbdiqWqTP1ZAbRoV7Rg=
+golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA=
+golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio=
+golang.org/x/image v0.9.0 h1:QrzfX26snvCM20hIhBwuHI/ThTg18b/+kcKdXHvnR+g=
+golang.org/x/image v0.9.0/go.mod h1:jtrku+n79PfroUbvDdeUWMAI+heR786BofxrbiSF+J0=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
 golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
-golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
-golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
+golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
+golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
 golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.2.0 h1:PUR+T4wwASmuSTYdKjYHI5TD22Wy5ogLU5qZCOLxBrI=
-golang.org/x/sync v0.2.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E=
+golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201207223542-d4d67f95c62d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -181,19 +181,19 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU=
-golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
+golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
-golang.org/x/term v0.8.0 h1:n5xxQn2i3PC0yLAbjTpNT85q/Kgzcr2gIoX9OrJUols=
-golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
+golang.org/x/term v0.10.0 h1:3R7pNqamzBraeqj/Tj8qt1aQ2HpmlC+Cx/qL/7hn4/c=
+golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
-golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
-golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
+golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
@@ -202,8 +202,8 @@ golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
-google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
-google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
+google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
--- a/pkg/gotenberg/logging.go
+++ b/pkg/gotenberg/logging.go
@@ -2,8 +2,8 @@ package gotenberg

 import "go.uber.org/zap"

-// LoggerProvider is a module interface which exposes a method for creating a
-// zap.Logger for other modules.
+// LoggerProvider is an interface for a module that supplies a method for
+// creating a zap.Logger instance for use by other modules.
 //
 //	func (m *YourModule) Provision(ctx *gotenberg.Context) error {
 //		provider, _ := ctx.Module(new(gotenberg.LoggerProvider))
--- a/pkg/modules/logging/logging.go
+++ b/pkg/modules/logging/logging.go
@@ -32,8 +32,9 @@ const (

 // Logging is a module which implements the gotenberg.LoggerProvider interface.
 type Logging struct {
-	level  string
-	format string
+	level        string
+	format       string
+	fieldsPrefix string
 }

 // Descriptor returns a Logging's module descriptor.
@@ -42,8 +43,9 @@ func (Logging) Descriptor() gotenberg.ModuleDescriptor {
 		ID: "logging",
 		FlagSet: func() *flag.FlagSet {
 			fs := flag.NewFlagSet("logging", flag.ExitOnError)
-			fs.String("log-level", infoLoggingLevel, fmt.Sprintf("Set the log level - %s, %s, %s, or %s", errorLoggingLevel, warnLoggingLevel, infoLoggingLevel, debugLoggingLevel))
-			fs.String("log-format", autoLoggingFormat, fmt.Sprintf("Set log format - %s, %s, or %s", autoLoggingFormat, jsonLoggingFormat, textLoggingFormat))
+			fs.String("log-level", infoLoggingLevel, fmt.Sprintf("Choose the level of logging detail. Options include %s, %s, %s, or %s", errorLoggingLevel, warnLoggingLevel, infoLoggingLevel, debugLoggingLevel))
+			fs.String("log-format", autoLoggingFormat, fmt.Sprintf("Specify the format of logging. Options include %s, %s, or %s", autoLoggingFormat, jsonLoggingFormat, textLoggingFormat))
+			fs.String("log-fields-prefix", "", "Prepend a specified prefix to each field in the logs")

 			return fs
 		}(),
@@ -57,6 +59,7 @@ func (log *Logging) Provision(ctx *gotenberg.Context) error {

 	log.level = flags.MustString("log-level")
 	log.format = flags.MustString("log-format")
+	log.fieldsPrefix = flags.MustString("log-fields-prefix")

 	return nil
 }
@@ -101,29 +104,64 @@ func (log Logging) Logger(mod gotenberg.Module) (*zap.Logger, error) {
 			return nil, fmt.Errorf("get log encoder: %w", err)
 		}

-		core := zapcore.NewCore(encoder, os.Stderr, lvl)
-		logger = zap.New(core)
-
-		// nolint
-		defer logger.Sync()
+		logger = zap.New(customCore{
+			Core:         zapcore.NewCore(encoder, os.Stderr, lvl),
+			fieldsPrefix: log.fieldsPrefix,
+		})
 	}

 	return logger.Named(mod.Descriptor().ID), nil
 }

-func newLogLevel(level string) (zapcore.Level, error) {
-	switch level {
-	case errorLoggingLevel:
-		return zap.ErrorLevel, nil
-	case warnLoggingLevel:
-		return zap.WarnLevel, nil
-	case infoLoggingLevel:
-		return zap.InfoLevel, nil
-	case debugLoggingLevel:
-		return zap.DebugLevel, nil
-	default:
-		return -2, fmt.Errorf("%s is not a recognized log level", level)
+// See https://github.com/gotenberg/gotenberg/issues/659.
+type customCore struct {
+	zapcore.Core
+	fieldsPrefix string
+}
+
+func (c customCore) With(fields []zapcore.Field) zapcore.Core {
+	if c.fieldsPrefix != "" {
+		for i := range fields {
+			fields[i].Key = c.fieldsPrefix + "_" + fields[i].Key
+		}
 	}
+
+	return customCore{
+		Core:         c.Core.With(fields),
+		fieldsPrefix: c.fieldsPrefix,
+	}
+}
+
+func (c customCore) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry {
+	// This is a copy from the zapcore.ioCore implementation. Indeed, by doing
+	// so, we are able to prefix the fields given to the logger methods like
+	// Debug, Info, Warn, Error, etc.
+	if c.Enabled(ent.Level) {
+		return ce.AddCore(ent, c)
+	}
+
+	return ce
+}
+
+func (c customCore) Write(entry zapcore.Entry, fields []zapcore.Field) error {
+	if c.fieldsPrefix != "" {
+		for i := range fields {
+			fields[i].Key = c.fieldsPrefix + "_" + fields[i].Key
+		}
+	}
+
+	return c.Core.Write(entry, fields)
+}
+
+func newLogLevel(level string) (zapcore.Level, error) {
+	lvl := zapcore.InvalidLevel
+
+	err := lvl.UnmarshalText([]byte(level))
+	if err != nil {
+		return lvl, fmt.Errorf("%q is not a recognized log level: %w", level, err)
+	}
+
+	return lvl, nil
 }

 func newLogEncoder(format string) (zapcore.Encoder, error) {
@@ -158,6 +196,7 @@ func newLogEncoder(format string) (zapcore.Encoder, error) {
 	}
 }

+// Singleton so that we instantiate our logger only once.
 var logger *zap.Logger = nil

 // Interface guards.
@@ -166,4 +205,5 @@ var (
 	_ gotenberg.Provisioner    = (*Logging)(nil)
 	_ gotenberg.Validator      = (*Logging)(nil)
 	_ gotenberg.LoggerProvider = (*Logging)(nil)
+	_ zapcore.Core             = (*customCore)(nil)
 )
--- a/pkg/modules/logging/logging_test.go
+++ b/pkg/modules/logging/logging_test.go
@@ -1,24 +1,18 @@
 package logging

 import (
+	"fmt"
 	"reflect"
 	"testing"

 	"github.com/gotenberg/gotenberg/v7/pkg/gotenberg"
+	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
+	"go.uber.org/zap/zaptest/observer"
 )

-type ProtoModule struct {
-	descriptor func() gotenberg.ModuleDescriptor
-}
-
-func (mod ProtoModule) Descriptor() gotenberg.ModuleDescriptor {
-	return mod.descriptor()
-}
-
 func TestLogging_Descriptor(t *testing.T) {
 	descriptor := Logging{}.Descriptor()
-
 	actual := reflect.TypeOf(descriptor.New())
 	expect := reflect.TypeOf(new(Logging))

@@ -28,155 +22,302 @@ func TestLogging_Descriptor(t *testing.T) {
 }

 func TestLogging_Provision(t *testing.T) {
-	logging := new(Logging)
-	fs := logging.Descriptor().FlagSet
+	for _, tc := range []struct {
+		scenario           string
+		level              string
+		format             string
+		fieldsPrefix       string
+		expectLevel        string
+		expectFormat       string
+		expectFieldsPrefix string
+	}{
+		{
+			scenario:           "default values",
+			expectLevel:        infoLoggingLevel,
+			expectFormat:       autoLoggingFormat,
+			expectFieldsPrefix: "",
+		},
+		{
+			scenario:           "explicit values",
+			level:              "debug",
+			format:             "json",
+			fieldsPrefix:       "gotenberg",
+			expectLevel:        debugLoggingLevel,
+			expectFormat:       jsonLoggingFormat,
+			expectFieldsPrefix: "gotenberg",
+		},
+		{
+			scenario:           "wrong values", // no validation at this point.
+			level:              "foo",
+			format:             "foo",
+			expectLevel:        "foo",
+			expectFormat:       "foo",
+			expectFieldsPrefix: "",
+		},
+	} {
+		var flags []string

-	err := fs.Parse([]string{""})
-	if err != nil {
-		t.Fatalf("expected no error but got: %v", err)
-	}
+		if tc.level != "" {
+			flags = append(flags, "--log-level", tc.level)
+		}

-	ctx := gotenberg.NewContext(gotenberg.ParsedFlags{FlagSet: fs}, nil)
+		if tc.format != "" {
+			flags = append(flags, "--log-format", tc.format)
+		}

-	err = logging.Provision(ctx)
-	if err != nil {
-		t.Errorf("expected no error but got: %v", err)
+		if tc.fieldsPrefix != "" {
+			flags = append(flags, "--log-fields-prefix", tc.fieldsPrefix)
+		}
+
+		logging := new(Logging)
+		fs := logging.Descriptor().FlagSet
+
+		err := fs.Parse(flags)
+		if err != nil {
+			t.Fatalf("%s: expected no error but got: %v", tc.scenario, err)
+		}
+
+		ctx := gotenberg.NewContext(gotenberg.ParsedFlags{FlagSet: fs}, nil)
+
+		err = logging.Provision(ctx)
+		if err != nil {
+			t.Fatalf("%s: expected no error but got: %v", tc.scenario, err)
+		}
+
+		if logging.level != tc.expectLevel {
+			t.Errorf("%s: expected '%s' but got '%s'", tc.scenario, tc.expectLevel, logging.level)
+		}
+
+		if logging.format != tc.expectFormat {
+			t.Errorf("%s: expected '%s' but got '%s'", tc.scenario, tc.expectFormat, logging.format)
+		}
+
+		if logging.fieldsPrefix != tc.expectFieldsPrefix {
+			t.Errorf("%s: expected '%s' but got '%s'", tc.scenario, tc.expectFieldsPrefix, logging.fieldsPrefix)
+		}
 	}
 }

 func TestLogging_Validate(t *testing.T) {
-	for i, tc := range []struct {
-		level, format string
-		expectErr     bool
+	for _, tc := range []struct {
+		scenario  string
+		level     string
+		format    string
+		expectErr bool
 	}{
 		{
+			scenario:  "invalid level",
 			level:     "foo",
 			expectErr: true,
 		},
 		{
+			scenario:  "invalid format",
 			level:     debugLoggingLevel,
 			format:    "foo",
 			expectErr: true,
 		},
 		{
-			level:  debugLoggingLevel,
-			format: autoLoggingFormat,
+			scenario: "valid level and format",
+			level:    debugLoggingLevel,
+			format:   autoLoggingFormat,
 		},
 	} {
-		mod := new(Logging)
-		mod.level = tc.level
-		mod.format = tc.format
+		logging := new(Logging)
+		logging.level = tc.level
+		logging.format = tc.format

-		err := mod.Validate()
+		err := logging.Validate()

 		if tc.expectErr && err == nil {
-			t.Errorf("test %d: expected error but got: %v", i, err)
+			t.Errorf("%s: expected error but got: %v", tc.scenario, err)
 		}

 		if !tc.expectErr && err != nil {
-			t.Errorf("test %d: expected no error but got: %v", i, err)
+			t.Errorf("%s: expected no error but got: %v", tc.scenario, err)
 		}
 	}
 }

 func TestLogging_Logger(t *testing.T) {
-	for i, tc := range []struct {
-		level, format string
-		expectErr     bool
+	for _, tc := range []struct {
+		scenario     string
+		level        string
+		format       string
+		fieldsPrefix string
+		expectErr    bool
 	}{
 		{
+			scenario:  "invalid level",
 			level:     "foo",
 			expectErr: true,
 		},
 		{
+			scenario:  "invalid format",
 			level:     debugLoggingLevel,
 			format:    "foo",
 			expectErr: true,
 		},
 		{
-			level:  debugLoggingLevel,
-			format: autoLoggingFormat,
+			scenario: "valid level and format",
+			level:    debugLoggingLevel,
+			format:   autoLoggingFormat,
 		},
 	} {
-		mod := new(Logging)
-		mod.level = tc.level
-		mod.format = tc.format
+		logging := new(Logging)
+		logging.level = tc.level
+		logging.format = tc.format
+		logging.fieldsPrefix = tc.fieldsPrefix

-		_, err := mod.Logger(ProtoModule{
-			descriptor: func() gotenberg.ModuleDescriptor {
-				return gotenberg.ModuleDescriptor{ID: "foo", New: nil}
+		_, err := logging.Logger(gotenberg.ModuleMock{
+			DescriptorMock: func() gotenberg.ModuleDescriptor {
+				return gotenberg.ModuleDescriptor{ID: "mock", New: nil}
 			},
 		})

 		if tc.expectErr && err == nil {
-			t.Errorf("test %d: expected error but got: %v", i, err)
+			t.Errorf("%s: expected error but got: %v", tc.scenario, err)
 		}

 		if !tc.expectErr && err != nil {
-			t.Errorf("test %d: expected no error but got: %v", i, err)
+			t.Errorf("%s: expected no error but got: %v", tc.scenario, err)
 		}
 	}
 }

-func TestNewLogLevel(t *testing.T) {
-	for i, tc := range []struct {
+func TestCustomCore(t *testing.T) {
+	for _, tc := range []struct {
+		scenario     string
+		level        zapcore.Level
+		fieldsPrefix string
+		expectEntry  bool
+	}{
+		{
+			scenario:     "level enabled",
+			level:        zapcore.DebugLevel,
+			fieldsPrefix: "gotenberg",
+			expectEntry:  true,
+		},
+		{
+			scenario:    "no fields prefix",
+			level:       zapcore.DebugLevel,
+			expectEntry: true,
+		},
+		{
+			scenario: "level disabled",
+			level:    zapcore.ErrorLevel,
+		},
+	} {
+		core, obsvr := observer.New(tc.level)
+		lgr := zap.New(customCore{
+			Core:         core,
+			fieldsPrefix: tc.fieldsPrefix,
+		}).With(zap.String("a_field", "a value"))
+
+		lgr.Debug("a debug message", zap.String("another_field", "another value"))
+
+		entries := obsvr.TakeAll()
+
+		if tc.expectEntry && len(entries) == 0 {
+			t.Fatalf("%s: expected an entry", tc.scenario)
+		}
+
+		if !tc.expectEntry && len(entries) != 0 {
+			t.Fatalf("%s: expected no entry", tc.scenario)
+		}
+
+		var prefix string
+		if tc.fieldsPrefix != "" {
+			prefix = tc.fieldsPrefix + "_"
+		}
+
+		for _, entry := range entries {
+			fields := entry.Context
+
+			if len(fields) != 2 {
+				t.Fatalf("expected 2 fields but got %d", len(fields))
+			}
+
+			if fields[0].Key != fmt.Sprintf("%sa_field", prefix) {
+				t.Errorf("expected 'gotenberg_a_field' but got '%s'", fields[0].Key)
+			}
+
+			if fields[1].Key != fmt.Sprintf("%sanother_field", prefix) {
+				t.Errorf("expected 'gotenberg_another_field' but got '%s'", fields[1].Key)
+			}
+		}
+	}
+}
+
+func Test_newLogLevel(t *testing.T) {
+	for _, tc := range []struct {
+		scenario       string
 		level          string
 		expectZapLevel zapcore.Level
 		expectErr      bool
 	}{
 		{
+			scenario:       "error level",
 			level:          errorLoggingLevel,
 			expectZapLevel: zapcore.ErrorLevel,
 		},
 		{
+			scenario:       "warning level",
 			level:          warnLoggingLevel,
 			expectZapLevel: zapcore.WarnLevel,
 		},
 		{
+			scenario:       "info level",
 			level:          infoLoggingLevel,
 			expectZapLevel: zapcore.InfoLevel,
 		},
 		{
+			scenario:       "debug level",
 			level:          debugLoggingLevel,
 			expectZapLevel: zapcore.DebugLevel,
 		},
 		{
+			scenario:       "invalid level",
 			level:          "foo",
-			expectZapLevel: -2,
+			expectZapLevel: zapcore.InvalidLevel,
 			expectErr:      true,
 		},
 	} {
 		actual, err := newLogLevel(tc.level)

 		if tc.expectErr && err == nil {
-			t.Errorf("test %d: expected error but got: %v", i, err)
+			t.Errorf("%s: expected error but got: %v", tc.scenario, err)
 		}

 		if !tc.expectErr && err != nil {
-			t.Errorf("test %d: expected no error but got: %v", i, err)
+			t.Errorf("%s: expected no error but got: %v", tc.scenario, err)
 		}

 		if tc.expectZapLevel != actual {
-			t.Errorf("test %d: expected %d level but got %d", i, tc.expectZapLevel, actual)
+			t.Errorf("%s: expected %d level but got %d", tc.scenario, tc.expectZapLevel, actual)
 		}
 	}
 }

-func TestNewLogEncoder(t *testing.T) {
-	for i, tc := range []struct {
+func Test_newLogEncoder(t *testing.T) {
+	for _, tc := range []struct {
+		scenario  string
 		format    string
 		expectErr bool
 	}{
 		{
-			format: autoLoggingFormat,
+			scenario: "auto format",
+			format:   autoLoggingFormat,
 		},
 		{
-			format: textLoggingFormat,
+			scenario: "text format",
+			format:   textLoggingFormat,
 		},
 		{
-			format: jsonLoggingFormat,
+			scenario: "json format",
+			format:   jsonLoggingFormat,
 		},
 		{
+			scenario:  "invalid format",
 			format:    "foo",
 			expectErr: true,
 		},
@@ -184,16 +325,11 @@ func TestNewLogEncoder(t *testing.T) {
 		_, err := newLogEncoder(tc.format)

 		if tc.expectErr && err == nil {
-			t.Errorf("test %d: expected error but got: %v", i, err)
+			t.Errorf("%s: expected error but got: %v", tc.scenario, err)
 		}

 		if !tc.expectErr && err != nil {
-			t.Errorf("test %d: expected no error but got: %v", i, err)
+			t.Errorf("%s: expected no error but got: %v", tc.scenario, err)
 		}
 	}
 }
-
-// Interface guards.
-var (
-	_ gotenberg.Module = (*ProtoModule)(nil)
-)
--- a/test/Dockerfile
+++ b/test/Dockerfile
@@ -11,12 +11,6 @@ FROM $DOCKER_REPOSITORY/gotenberg:$GOTENBERG_VERSION

 USER root

-COPY --from=golang /usr/local/go /usr/local/go
-COPY ./test/docker-entrypoint.sh /usr/bin/docker-entrypoint.sh
-COPY ./test/golint.sh /usr/bin/golint
-COPY ./test/gotest.sh /usr/bin/gotest
-COPY ./test/gotodos.sh /usr/bin/gotodos
-
 ENV GOPATH /go
 ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
 ENV CGO_ENABLED 1
@@ -39,6 +33,12 @@ RUN apt-get update -qq &&\
    sed -i 's#/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin#/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/go/bin:/usr/local/go/bin#g' /etc/sudoers &&\
    curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin $GOLANGCI_LINT_VERSION

+COPY --from=golang /usr/local/go /usr/local/go
+COPY ./test/docker-entrypoint.sh /usr/bin/docker-entrypoint.sh
+COPY ./test/golint.sh /usr/bin/golint
+COPY ./test/gotest.sh /usr/bin/gotest
+COPY ./test/gotodos.sh /usr/bin/gotodos
+
 # Pristine working directory.
 WORKDIR /tests
Author	SHA1	Message	Date
Julien Neuhart	d94e614a54	chore: update Go dependencies	2023-07-19 22:03:45 +02:00
Julien Neuhart	9f459867bf	feat(logging): add a new flag for preprending a prefix to each field in the logs (close #659 )	2023-07-19 22:03:09 +02:00
Julien Neuhart	f5ce319c24	feat: improve Dockerfiles for a better DX	2023-07-19 09:50:43 +02:00
Julien Neuhart	6b9c02d42a	chore: add a security policy (close #661 )	2023-07-18 14:46:23 +02:00