Add OpenTelemetry VCS attributes (#32904)

2024-11-18 09:41:09 +01:00
parent 1c6f53e70f
commit bcf5d30e01
4 changed files with 167 additions and 152 deletions
--- a/.github/workflows/build-container-image.yml
+++ b/.github/workflows/build-container-image.yml
@@ -92,6 +92,7 @@ jobs:
          build-args: |
            MASTODON_VERSION_PRERELEASE=${{ inputs.version_prerelease }}
            MASTODON_VERSION_METADATA=${{ inputs.version_metadata }}
+            SOURCE_COMMIT=${{ github.sha }}
          platforms: ${{ inputs.platforms }}
          provenance: false
          builder: ${{ steps.buildx.outputs.name || steps.buildx-native.outputs.name }}
--- a/307
+++ b/307
@@ -29,6 +29,8 @@ FROM docker.io/ruby:${RUBY_VERSION}-slim-${DEBIAN_VERSION} AS ruby
 ARG MASTODON_VERSION_PRERELEASE=""
 # Append build metadata or fork information to version.rb [--build-arg MASTODON_VERSION_METADATA="pr-123456"]
 ARG MASTODON_VERSION_METADATA=""
+# Will be available as Mastodon::Version.source_commit
+ARG SOURCE_COMMIT=""

 # Allow Ruby on Rails to serve static files
 # See: https://docs.joinmastodon.org/admin/config/#rails_serve_static_files
@@ -45,30 +47,31 @@ ARG GID="991"

 # Apply Mastodon build options based on options above
 ENV \
-# Apply Mastodon version information
+  # Apply Mastodon version information
  MASTODON_VERSION_PRERELEASE="${MASTODON_VERSION_PRERELEASE}" \
  MASTODON_VERSION_METADATA="${MASTODON_VERSION_METADATA}" \
-# Apply Mastodon static files and YJIT options
+  SOURCE_COMMIT="${SOURCE_COMMIT}" \
+  # Apply Mastodon static files and YJIT options
  RAILS_SERVE_STATIC_FILES=${RAILS_SERVE_STATIC_FILES} \
  RUBY_YJIT_ENABLE=${RUBY_YJIT_ENABLE} \
-# Apply timezone
+  # Apply timezone
  TZ=${TZ}

 ENV \
-# Configure the IP to bind Mastodon to when serving traffic
+  # Configure the IP to bind Mastodon to when serving traffic
  BIND="0.0.0.0" \
-# Use production settings for Yarn, Node and related nodejs based tools
+  # Use production settings for Yarn, Node and related nodejs based tools
  NODE_ENV="production" \
-# Use production settings for Ruby on Rails
+  # Use production settings for Ruby on Rails
  RAILS_ENV="production" \
-# Add Ruby and Mastodon installation to the PATH
+  # Add Ruby and Mastodon installation to the PATH
  DEBIAN_FRONTEND="noninteractive" \
  PATH="${PATH}:/opt/ruby/bin:/opt/mastodon/bin" \
-# Optimize jemalloc 5.x performance
+  # Optimize jemalloc 5.x performance
  MALLOC_CONF="narenas:2,background_thread:true,thp:never,dirty_decay_ms:1000,muzzy_decay_ms:0" \
-# Enable libvips, should not be changed
+  # Enable libvips, should not be changed
  MASTODON_USE_LIBVIPS=true \
-# Sidekiq will touch tmp/sidekiq_process_has_started_and_will_begin_processing_jobs to indicate it is ready. This can be used for a readiness check in Kubernetes
+  # Sidekiq will touch tmp/sidekiq_process_has_started_and_will_begin_processing_jobs to indicate it is ready. This can be used for a readiness check in Kubernetes
  MASTODON_SIDEKIQ_READY_FILENAME=sidekiq_process_has_started_and_will_begin_processing_jobs

 # Set default shell used for running commands
@@ -79,14 +82,14 @@ ARG TARGETPLATFORM
 RUN echo "Target platform is $TARGETPLATFORM"

 RUN \
-# Remove automatic apt cache Docker cleanup scripts
+  # Remove automatic apt cache Docker cleanup scripts
  rm -f /etc/apt/apt.conf.d/docker-clean; \
-# Sets timezone
+  # Sets timezone
  echo "${TZ}" > /etc/localtime; \
-# Creates mastodon user/group and sets home directory
+  # Creates mastodon user/group and sets home directory
  groupadd -g "${GID}" mastodon; \
  useradd -l -u "${UID}" -g "${GID}" -m -d /opt/mastodon mastodon; \
-# Creates /mastodon symlink to /opt/mastodon
+  # Creates /mastodon symlink to /opt/mastodon
  ln -s /opt/mastodon /mastodon;

 # Set /opt/mastodon as working directory
@@ -94,28 +97,28 @@ WORKDIR /opt/mastodon

 # hadolint ignore=DL3008,DL3005
 RUN \
-# Mount Apt cache and lib directories from Docker buildx caches
--mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
--mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
-# Apt update & upgrade to check for security updates to Debian image
+  # Mount Apt cache and lib directories from Docker buildx caches
+  --mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
+  --mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
+  # Apt update & upgrade to check for security updates to Debian image
  apt-get update; \
  apt-get dist-upgrade -yq; \
-# Install jemalloc, curl and other necessary components
+  # Install jemalloc, curl and other necessary components
  apt-get install -y --no-install-recommends \
-    curl \
-    file \
-    libjemalloc2 \
-    patchelf \
-    procps \
-    tini \
-    tzdata \
-    wget \
+  curl \
+  file \
+  libjemalloc2 \
+  patchelf \
+  procps \
+  tini \
+  tzdata \
+  wget \
  ; \
-# Patch Ruby to use jemalloc
+  # Patch Ruby to use jemalloc
  patchelf --add-needed libjemalloc.so.2 /usr/local/bin/ruby; \
-# Discard patchelf after use
+  # Discard patchelf after use
  apt-get purge -y \
-    patchelf \
+  patchelf \
  ;

 # Create temporary build layer from base image
@@ -132,56 +135,56 @@ ARG TARGETPLATFORM

 # hadolint ignore=DL3008
 RUN \
-# Mount Apt cache and lib directories from Docker buildx caches
--mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
--mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
-# Install build tools and bundler dependencies from APT
+  # Mount Apt cache and lib directories from Docker buildx caches
+  --mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
+  --mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
+  # Install build tools and bundler dependencies from APT
  apt-get install -y --no-install-recommends \
-    autoconf \
-    automake \
-    build-essential \
-    cmake \
-    git \
-    libgdbm-dev \
-    libglib2.0-dev \
-    libgmp-dev \
-    libicu-dev \
-    libidn-dev \
-    libpq-dev \
-    libssl-dev \
-    libtool \
-    meson \
-    nasm \
-    pkg-config \
-    shared-mime-info \
-    xz-utils \
-	# libvips components
-    libcgif-dev \
-    libexif-dev \
-    libexpat1-dev \
-    libgirepository1.0-dev \
-    libheif-dev \
-    libimagequant-dev \
-    libjpeg62-turbo-dev \
-    liblcms2-dev \
-    liborc-dev \
-    libspng-dev \
-    libtiff-dev \
-    libwebp-dev \
+  autoconf \
+  automake \
+  build-essential \
+  cmake \
+  git \
+  libgdbm-dev \
+  libglib2.0-dev \
+  libgmp-dev \
+  libicu-dev \
+  libidn-dev \
+  libpq-dev \
+  libssl-dev \
+  libtool \
+  meson \
+  nasm \
+  pkg-config \
+  shared-mime-info \
+  xz-utils \
+  # libvips components
+  libcgif-dev \
+  libexif-dev \
+  libexpat1-dev \
+  libgirepository1.0-dev \
+  libheif-dev \
+  libimagequant-dev \
+  libjpeg62-turbo-dev \
+  liblcms2-dev \
+  liborc-dev \
+  libspng-dev \
+  libtiff-dev \
+  libwebp-dev \
  # ffmpeg components
-    libdav1d-dev \
-    liblzma-dev \
-    libmp3lame-dev \
-    libopus-dev \
-    libsnappy-dev \
-    libvorbis-dev \
-    libvpx-dev \
-    libx264-dev \
-    libx265-dev \
+  libdav1d-dev \
+  liblzma-dev \
+  libmp3lame-dev \
+  libopus-dev \
+  libsnappy-dev \
+  libvorbis-dev \
+  libvpx-dev \
+  libx264-dev \
+  libx265-dev \
  ;

 RUN \
-# Configure Corepack
+  # Configure Corepack
  rm /usr/local/bin/yarn*; \
  corepack enable; \
  corepack prepare --activate;
@@ -228,28 +231,28 @@ WORKDIR /usr/local/ffmpeg/src/ffmpeg-${FFMPEG_VERSION}
 # Configure and compile ffmpeg
 RUN \
  ./configure \
-    --prefix=/usr/local/ffmpeg \
-    --toolchain=hardened \
-    --disable-debug \
-    --disable-devices \
-    --disable-doc \
-    --disable-ffplay \
-    --disable-network \
-    --disable-static \
-    --enable-ffmpeg \
-    --enable-ffprobe \
-    --enable-gpl \
-    --enable-libdav1d \
-    --enable-libmp3lame \
-    --enable-libopus \
-    --enable-libsnappy \
-    --enable-libvorbis \
-    --enable-libvpx \
-    --enable-libwebp \
-    --enable-libx264 \
-    --enable-libx265 \
-    --enable-shared \
-    --enable-version3 \
+  --prefix=/usr/local/ffmpeg \
+  --toolchain=hardened \
+  --disable-debug \
+  --disable-devices \
+  --disable-doc \
+  --disable-ffplay \
+  --disable-network \
+  --disable-static \
+  --enable-ffmpeg \
+  --enable-ffprobe \
+  --enable-gpl \
+  --enable-libdav1d \
+  --enable-libmp3lame \
+  --enable-libopus \
+  --enable-libsnappy \
+  --enable-libvorbis \
+  --enable-libvpx \
+  --enable-libwebp \
+  --enable-libx264 \
+  --enable-libx265 \
+  --enable-shared \
+  --enable-version3 \
  ; \
  make -j$(nproc); \
  make install;
@@ -263,17 +266,17 @@ ARG TARGETPLATFORM
 COPY Gemfile* /opt/mastodon/

 RUN \
-# Mount Ruby Gem caches
--mount=type=cache,id=gem-cache-${TARGETPLATFORM},target=/usr/local/bundle/cache/,sharing=locked \
-# Configure bundle to prevent changes to Gemfile and Gemfile.lock
+  # Mount Ruby Gem caches
+  --mount=type=cache,id=gem-cache-${TARGETPLATFORM},target=/usr/local/bundle/cache/,sharing=locked \
+  # Configure bundle to prevent changes to Gemfile and Gemfile.lock
  bundle config set --global frozen "true"; \
-# Configure bundle to not cache downloaded Gems
+  # Configure bundle to not cache downloaded Gems
  bundle config set --global cache_all "false"; \
-# Configure bundle to only process production Gems
+  # Configure bundle to only process production Gems
  bundle config set --local without "development test"; \
-# Configure bundle to not warn about root user
+  # Configure bundle to not warn about root user
  bundle config set silence_root_warning "true"; \
-# Download and install required Gems
+  # Download and install required Gems
  bundle install -j"$(nproc)";

 # Create temporary node specific build layer from build layer
@@ -288,9 +291,9 @@ COPY .yarn /opt/mastodon/.yarn

 # hadolint ignore=DL3008
 RUN \
--mount=type=cache,id=corepack-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/corepack,sharing=locked \
--mount=type=cache,id=yarn-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/yarn,sharing=locked \
-# Install Node packages
+  --mount=type=cache,id=corepack-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/corepack,sharing=locked \
+  --mount=type=cache,id=yarn-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/yarn,sharing=locked \
+  # Install Node packages
  yarn workspaces focus --production @mastodon/mastodon;

 # Create temporary assets build layer from build layer
@@ -311,10 +314,10 @@ ARG TARGETPLATFORM

 RUN \
  ldconfig; \
-# Use Ruby on Rails to create Mastodon assets
+  # Use Ruby on Rails to create Mastodon assets
  SECRET_KEY_BASE_DUMMY=1 \
  bundle exec rails assets:precompile; \
-# Cleanup temporary files
+  # Cleanup temporary files
  rm -fr /opt/mastodon/tmp;

 # Prep final Mastodon Ruby layer
@@ -324,49 +327,49 @@ ARG TARGETPLATFORM

 # hadolint ignore=DL3008
 RUN \
-# Mount Apt cache and lib directories from Docker buildx caches
--mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
--mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
-# Mount Corepack and Yarn caches from Docker buildx caches
--mount=type=cache,id=corepack-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/corepack,sharing=locked \
--mount=type=cache,id=yarn-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/yarn,sharing=locked \
-# Apt update install non-dev versions of necessary components
+  # Mount Apt cache and lib directories from Docker buildx caches
+  --mount=type=cache,id=apt-cache-${TARGETPLATFORM},target=/var/cache/apt,sharing=locked \
+  --mount=type=cache,id=apt-lib-${TARGETPLATFORM},target=/var/lib/apt,sharing=locked \
+  # Mount Corepack and Yarn caches from Docker buildx caches
+  --mount=type=cache,id=corepack-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/corepack,sharing=locked \
+  --mount=type=cache,id=yarn-cache-${TARGETPLATFORM},target=/usr/local/share/.cache/yarn,sharing=locked \
+  # Apt update install non-dev versions of necessary components
  apt-get install -y --no-install-recommends \
-    libexpat1 \
-    libglib2.0-0 \
-    libicu72 \
-    libidn12 \
-    libpq5 \
-    libreadline8 \
-    libssl3 \
-    libyaml-0-2 \
+  libexpat1 \
+  libglib2.0-0 \
+  libicu72 \
+  libidn12 \
+  libpq5 \
+  libreadline8 \
+  libssl3 \
+  libyaml-0-2 \
  # libvips components
-    libcgif0 \
-    libexif12 \
-    libheif1 \
-    libimagequant0 \
-    libjpeg62-turbo \
-    liblcms2-2 \
-    liborc-0.4-0 \
-    libspng0 \
-    libtiff6 \
-    libwebp7 \
-    libwebpdemux2 \
-    libwebpmux3 \
+  libcgif0 \
+  libexif12 \
+  libheif1 \
+  libimagequant0 \
+  libjpeg62-turbo \
+  liblcms2-2 \
+  liborc-0.4-0 \
+  libspng0 \
+  libtiff6 \
+  libwebp7 \
+  libwebpdemux2 \
+  libwebpmux3 \
  # ffmpeg components
-    libdav1d6 \
-    libmp3lame0 \
-    libopencore-amrnb0 \
-    libopencore-amrwb0 \
-    libopus0 \
-    libsnappy1v5 \
-    libtheora0 \
-    libvorbis0a \
-    libvorbisenc2 \
-    libvorbisfile3 \
-    libvpx7 \
-    libx264-164 \
-    libx265-199 \
+  libdav1d6 \
+  libmp3lame0 \
+  libopencore-amrnb0 \
+  libopencore-amrwb0 \
+  libopus0 \
+  libsnappy1v5 \
+  libtheora0 \
+  libvorbis0a \
+  libvorbisenc2 \
+  libvorbisfile3 \
+  libvpx7 \
+  libx264-164 \
+  libx265-199 \
  ;

 # Copy Mastodon sources into final layer
@@ -386,7 +389,7 @@ COPY --from=ffmpeg /usr/local/ffmpeg/lib /usr/local/lib

 RUN \
  ldconfig; \
-# Smoketest media processors
+  # Smoketest media processors
  vips -v; \
  ffmpeg -version; \
  ffprobe -version;
@@ -396,10 +399,10 @@ RUN \
  bundle exec bootsnap precompile --gemfile app/ lib/;

 RUN \
-# Pre-create and chown system volume to Mastodon user
+  # Pre-create and chown system volume to Mastodon user
  mkdir -p /opt/mastodon/public/system; \
  chown mastodon:mastodon /opt/mastodon/public/system; \
-# Set Mastodon user as owner of tmp folder
+  # Set Mastodon user as owner of tmp folder
  chown -R mastodon:mastodon /opt/mastodon/tmp;

 # Set the running user for resulting container
--- a/config/initializers/opentelemetry.rb
+++ b/config/initializers/opentelemetry.rb
@@ -65,6 +65,13 @@ if ENV.keys.any? { |name| name.match?(/OTEL_.*_ENDPOINT/) }
                        "#{prefix}#{separator}#{$PROGRAM_NAME.split('/').last}"
                      end
    c.service_version = Mastodon::Version.to_s
+
+    if Mastodon::Version.source_commit.present?
+      c.resource = OpenTelemetry::SDK::Resources::Resource.create(
+        'vcs.repository.ref.revision' => Mastodon::Version.source_commit,
+        'vcs.repository.url.full' => Mastodon::Version.source_base_url
+      )
+    end
  end
 end

--- a/lib/mastodon/version.rb
+++ b/lib/mastodon/version.rb
@@ -70,6 +70,10 @@ module Mastodon
      end
    end

+    def source_commit
+      ENV.fetch('SOURCE_COMMIT', nil)
+    end
+
    def user_agent
      @user_agent ||= "Mastodon/#{Version} (#{HTTP::Request::USER_AGENT}; +http#{Rails.configuration.x.use_https ? 's' : ''}://#{Rails.configuration.x.web_domain}/)"
    end