zappi/celery-exporter repository overview

⁠docker-celery-exporter

Docker image for danihodovic/celery-exporter⁠, a Prometheus exporter for Celery metrics.

⁠Motivations

⁠How does this differ from upstream?

The current Docker image doesn't support ARM and we needed one that does. And the review to add support⁠ took longer than we could wait.

⁠Usage

docker run --name celery-exporter zappi/celery-exporter:latest

For more detailed usage documentation see upstream⁠.

⁠Updating

Below are detailed instructions to guide contributors through the process to update the image to use a new version:

1. Open the .github/workflows/test.yml file in your editor and locate the following section:

   env:
     VERSION: 0.x.0
   

   Copy
2. Update the VERSION field to the desired version:

   env:
     VERSION: 0.y.0
   

   Copy
3. Save the file and commit your changes with a meaningful commit message.
4. Push your branch to GitHub and submit a PR:
   • Your pull request will trigger the CI/CD pipeline, which will validate the updated version.
   • Ensure the pipeline completes successfully before merging.

⁠Releasing

To cut a new release, follow these steps:

1. Ensure your local main branch is up to date:

   git checkout main
   git fetch origin main
   

   Copy
2. Create a signed tag for the new release replacing <x.y.z> with the version you’re releasing:

   git tag -s <x.y.z> -m "Version <x.y.z>"
   

   Copy
3. Push the newly created tag to the remote repository:

   git push origin <x.y.z>
   

   Copy