Ensure documentation for observability systems provides comprehensive information including all required permissions, complete configuration options, and clear warnings about operational impacts. Monitoring and metrics systems often have significant performance and security implications that users must understand to operate them safely.
Ensure documentation for observability systems provides comprehensive information including all required permissions, complete configuration options, and clear warnings about operational impacts. Monitoring and metrics systems often have significant performance and security implications that users must understand to operate them safely.
Key requirements:
Example of good documentation:
# Promoting all resource attributes to labels, except the ignored ones.
# 'ignore_resource_attributes' can be used to promote all resource attributes if set to an empty list:
#
# otlp:
# ignore_resource_attributes: []
#
# Be aware that changes in attributes received by the OTLP endpoint may result in time series churn and lead to high memory usage by the Prometheus server.
This approach prevents operational issues, security gaps, and user confusion in production monitoring systems.
Enter the URL of a public GitHub repository