-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: Add comprehensive production operations guides #2703
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
paraggupta10
wants to merge
5
commits into
prometheus:main
Choose a base branch
from
paraggupta10:feature/production-operations-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9deb4e4
docs: add comprehensive production operations guides
ed18ba4
fix: correct links to actual markdown files
820209d
fix: add missing sort_rank to frontmatter
c55f56d
refactor: address maintainer feedback on mixins and examples
8f2f7a2
fix: correct index.md to only contain frontmatter
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,51 @@ | ||
--- | ||
title: Operating | ||
title: Operating Prometheus in Production | ||
sort_rank: 5 | ||
nav_icon: settings | ||
--- | ||
|
||
# Operating Prometheus in Production | ||
|
||
This section provides comprehensive guidance for deploying, monitoring, and maintaining Prometheus in production environments. These guides are designed for SRE, DevOps, and platform engineering teams who need to run Prometheus reliably at scale. | ||
|
||
## Production Deployment | ||
|
||
Running Prometheus in production requires careful planning around scalability, reliability, and operational concerns: | ||
|
||
* [Production Deployment Guide](production-deployment.md) - Comprehensive guide for production-ready Prometheus deployments including hardware sizing, high availability setup, and configuration best practices | ||
* [Performance Tuning](performance-tuning/) - Optimization techniques for large-scale deployments, memory management, and query performance | ||
* [Storage Management](storage-management/) - Long-term storage strategies, retention policies, and data lifecycle management | ||
|
||
## Monitoring and Maintenance | ||
|
||
Effective operation requires monitoring your monitoring infrastructure: | ||
|
||
* [Monitoring Prometheus](monitoring-prometheus.md) - How to monitor your Prometheus instances, essential metrics, and alerting on infrastructure health | ||
* [Troubleshooting Guide](troubleshooting/) - Common issues, diagnostic techniques, and resolution strategies for production problems | ||
* [Backup and Recovery](backup-recovery/) - Data protection strategies, disaster recovery procedures, and backup validation | ||
|
||
## Security and Compliance | ||
|
||
Securing monitoring infrastructure is critical for production deployments: | ||
|
||
* [Security Best Practices](security.md) - Authentication, authorization, network security, and data protection | ||
* [Compliance Considerations](compliance/) - Meeting regulatory requirements, audit trails, and data governance | ||
|
||
## Operational Integration | ||
|
||
Prometheus doesn't operate in isolation - integration with your operational ecosystem is key: | ||
|
||
* [Alert Management](alert-management/) - Alert routing, escalation policies, and integration with incident management systems | ||
* [Capacity Planning](capacity-planning/) - Growth planning, resource forecasting, and scaling strategies | ||
* [Multi-tenancy](multi-tenancy/) - Patterns for shared Prometheus infrastructure, isolation, and resource allocation | ||
|
||
## Migration and Upgrades | ||
|
||
Managing changes to production monitoring infrastructure: | ||
|
||
* [Upgrade Strategies](upgrade-strategies/) - Safe upgrade procedures, rollback plans, and compatibility considerations | ||
* [Migration Guide](migration-guide/) - Moving from other monitoring systems, data migration, and transition planning | ||
|
||
--- | ||
|
||
**Note**: These guides assume you have a basic understanding of Prometheus concepts. If you're new to Prometheus, start with the [Introduction](/docs/introduction/) section. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This Markdown file does not actually become a documentation page, the top-level index.md files only serve to create the top-level docs nav sections on prometheus.io via their frontmatter fields. Have you actually tried building the site to see the result?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this clarification! - I can see now that other sections (practices/, visualization/, etc.) only have frontmatter in their index.md files. I've corrected operating/index.md to follow the same pattern, containing only the frontmatter needed to create the nav section.
I clearly needed to better understand the documentation build system.