[docs] Add troubleshooting and best practices guide for Prometheus receiver #44925
+333
−0
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
Added a comprehensive configuration example demonstrating how to use the Prometheus receiver in a production pipeline with processors (batch, resource) and exporters (otlp, prometheusremotewrite). This example helps users understand how to integrate the receiver into a complete observability setup.
…dant config - Changed scrape_interval from 15s to 5s so batch processor is effective - Added YAML comment explaining metric_relabel_configs filtering - Removed redundant service.name from resource processor (already set by receiver) - Removed external_labels from prometheusremotewrite to keep config simple - Updated description to reflect changes
…tices guide This commit adds a new 'Troubleshooting and Best Practices' section to the Prometheus receiver README, providing users with: - Common issues and solutions (metrics not appearing, high CPU usage, memory issues) - Best practices for production deployments (multi-replica setups, performance optimization) - Monitoring and security considerations - Debugging tips and techniques The guide addresses real-world operational challenges and provides actionable solutions based on production experience. This will help users: - Quickly diagnose and resolve common issues - Optimize receiver performance in high-volume environments - Implement secure and scalable configurations - Monitor receiver health effectively This documentation fills a gap in the current README and will significantly improve the user experience for teams deploying the Prometheus receiver in production environments.
geekysatbir
requested review from
a team,
ArthurSens and
dashpole
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR adds a comprehensive "Troubleshooting and Best Practices" section to the Prometheus receiver README. The new section addresses common operational challenges and provides actionable guidance for production deployments.
What's Included
Common Issues and Solutions
Best Practices for Production
Monitoring and Security
Debugging Tips
Motivation
The Prometheus receiver README currently lacks guidance for troubleshooting common issues and implementing production best practices. This documentation gap makes it challenging for users to:
This guide fills that gap by providing comprehensive, production-tested guidance based on real-world operational experience.
Testing
Related Issues
This addresses the need for better operational documentation mentioned in various community discussions and support channels.
Checklist