This directory contains documentation for Grafana Agent. It is split into the following parts:
sources/: Source of user-facing documentation. This directory is hosted on grafana.com/docs/agent, and we recommend viewing it there instead of the markdown on GitHub.developer/: Documentation for contributors and maintainers.rfcs/: RFCs for proposals relating to Grafana Agent.generator/: Code for generating some parts of the documentation.
Run make docs. This launches a preview of the website with the current grafana docs at http://localhost:3002/docs/agent/latest/ which will refresh automatically when changes are made to content in the sources directory.
Make sure Docker is running.
First, inside the docs/ folder run make check-cloudwatch-integration to verify that the cloudwatch docs needs updating.
If the check fails, then the doc supported services list should be updated. For that, run make generate-cloudwatch-integration to get the updated list, which should replace the old one in the docs.
Some sections of Grafana Agent Flow reference documentation are automatically generated. To update them, run make generate-docs.
The following is a list of community-led projects for working with Grafana Agent. These projects are not maintained or supported by Grafana Labs.
A publicly available release of a Grafana Agent Helm chart is maintained here. Contributions and improvements are welcomed. Full details on rolling out and supported options can be found in the readme.
This does not require the Grafana Agent Operator to rollout / deploy.
The grafana-agent-k8s charmed operator runs with Juju the Grafana Agent on Kubernetes. The Grafana Agent charmed operator is designed to work with the Logs, Metrics and Alerts observability stack.