Feature/docker compose setup #1101
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add docker-compose.yml with nginx-exporter, nginx, app, prometheus, and grafana services - Add docker-compose.test.yml for minimal testing setup - Configure NGINX with stub_status endpoint on port 8081 - Add sample web application with custom HTML content - Configure Prometheus to scrape nginx-exporter metrics - Add Grafana with pre-configured datasources and dashboards - Set up proper networking and service dependencies - Use examples/docker-compose/ directory structure for all configuration files
- Add comprehensive Docker Compose documentation in examples/docker-compose/README.md - Include architecture overview, quick start guide, and service descriptions - Add testing instructions and troubleshooting section - Update main README.md to reference Docker Compose example - Focus quick start on nginx-exporter only for existing NGINX setups - Provide separate instructions for complete monitoring stack - Add configuration file references and usage examples
- Add test-docker-compose-ci.yml workflow to test Docker Compose setup - Test 'docker-compose up -d nginx-exporter' command functionality - Verify nginx-exporter container starts correctly and serves metrics - Test full monitoring stack integration (nginx, prometheus, grafana) - Validate service connectivity and metrics collection - Include proper error handling and cleanup procedures - Add detailed logging for troubleshooting failures - Follow project CI conventions and use consistent action versions
|
Hi @benjisho! Welcome to the project! 🎉 Thanks for opening this pull request! |
nginx-bot
bot
added
the
community
github-actions
bot
added
enhancement
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
benjisho
force-pushed
the
feature/docker-compose-setup
branch
from
839269d to
e745269
Compare
- Fix comment indentation in prometheus.yml - Fix empty values in docker-compose volumes sections - All pre-commit hooks now pass
|
I have hereby read the F5 CLA and agree to its terms |
sjberman
reviewed
Jul 30, 2025
Comment on lines
+147
to
+148
| # Wait a moment for metrics to be updated | ||
| sleep 3 |
There was a problem hiding this comment.
Instead of using a blind sleep, can we poll the endpoint instead? That way we at least get feedback over the waiting period, and we can use a longer interval that exits early on success.
| @@ -0,0 +1,93 @@ | |||
| services: | |||
There was a problem hiding this comment.
Is this file just a dupe of the other one? What's its purpose?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR adds a comprehensive Docker Compose setup for the NGINX Prometheus Exporter to make it easier for users to get started with monitoring their NGINX instances.
Use case: Users often want to quickly test the NGINX Prometheus Exporter or set up a complete monitoring stack without manually configuring each component. This Docker Compose setup provides both options:
docker-compose up -d nginx-exporter) - For users with existing NGINX infrastructure who just want to add the exporterdocker-compose up -d) - For demonstration, testing, and learning purposesChanges include:
examples/docker-compose/README.mdwith architecture overview, quick start guide, and troubleshootingThe setup is organized in the
examples/docker-compose/directory following the project's structure conventions and provides a complete monitoring pipeline from NGINX → nginx-exporter → Prometheus → Grafana.Checklist
Before creating a PR, run through this checklist and mark each as complete.