sentry-vroom

packaged by Chainguard

Chainguard Container for sentry-vroom

Sentry's profiling service, which stores, retrieves and aggregates profiles

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/sentry-vroom:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's sentry-vroom image is comparable to the upstream vroom image that self-hosted Sentry runs (ghcr.io/getsentry/vroom), with the following differences:

• It runs the same vroom binary as the vroom user (UID 1000) from /var/vroom, so existing bucket mounts and environment variables work unchanged. The binary is at /usr/bin/vroom.
• Like other Chainguard Containers, it has a minimal design with no shell or package manager, and it has few to zero CVEs.

Getting Started

vroom reads profiles from the bucket named by SENTRY_BUCKET_PROFILES and listens on PORT (8085 by default). The following command starts vroom with a local file bucket (self-hosted Sentry uses an S3 bucket on SeaweedFS instead):

docker run -d --name vroom -p 8085:8085 \
  -v vroom-profiles:/var/vroom/sentry-profiles \
  -e SENTRY_BUCKET_PROFILES=file:///var/vroom/sentry-profiles \
  cgr.dev/ORGANIZATION/sentry-vroom:latest

Confirm that vroom is serving requests:

curl -s -o /dev/null -w '%{http_code}\n' http://localhost:8085/health

200

Sentry then retrieves profiles from vroom with requests such as GET /organizations/<org>/projects/<project>/profiles/<profile-id>, which return the stored profile converted to the Speedscope format.

Configuration

To use this image in self-hosted Sentry, set VROOM_IMAGE in your .env file to cgr.dev/ORGANIZATION/sentry-vroom:latest. Self-hosted Sentry already sets SENTRY_BUCKET_PROFILES to an S3 bucket on SeaweedFS (s3://profiles?region=us-east-1&endpoint=seaweedfs:8333&use_path_style=true&disable_https=true). vroom 26.10.0 cannot read the bucket with that value: requests fail with HTTP 500 unless the endpoint carries its scheme. Override it in self-hosted's docker-compose.override.yml with SENTRY_BUCKET_PROFILES: "s3://profiles?region=us-east-1&endpoint=http://seaweedfs:8333&use_path_style=true". For an S3 bucket, provide credentials with AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. Other settings, such as SENTRY_KAFKA_BROKERS_OCCURRENCES and SENTRY_DSN, are read from environment variables as in the upstream image.

The image includes vroom healthcheck and vroom drain subcommands for container health checks and graceful shutdown. Neither needs a shell.

Documentation and Resources

• vroom on GitHub
• Self-hosted Sentry documentation
• Profiling in Sentry

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.