Skip to content
This repository was archived by the owner on Jul 28, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@ means that reliability of alerts are tied to the reliability of the remote syste
and alerts will be delayed at least by the time it takes for samples to reach
the remote system.

## Roadmap

- [x] Prometheus metrics
- [x] A second clustering mode to solve sharding monitoring availability problems.
- [x] Support for integrations (embedded exporters/automatic scrape configs)
- [x] Promtail for Loki logs
- [x] Tempo traces
- [ ] `carbon-relay-ng` for Graphite metrics.
- [ ] All-in-one installation script (metrics, logs, and traces)

## Getting Started

When using Kubernetes this [link](https://grafana.com/docs/grafana-cloud/quickstart/agent-k8s) offers the best guide.
Expand Down Expand Up @@ -105,4 +95,8 @@ If you have any questions or feedback regarding the Grafana Agent:
[Discussions page](https://github.com/grafana/agent/discussions).
* [File an issue](https://github.com/grafana/agent/issues/new) for bugs, issues
and feature suggestions.

## Contributing

Any contributions are welcome and details can be found [in our developers guide](./cmd/agent/DEVELOPERS.md).

11 changes: 11 additions & 0 deletions cmd/agent/DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
This document provides relevant instructions for maintainers of the Grafana
Agent.

## Branching Strategy

The Grafana Agent's branching strategy is to have main always releasable.
This allows us to better control the release cadence and ensure that the project has regular releases.

For any small change, those can be made with a direct PR.

For any large change, we ask that you create an issue to discuss it on. Then we can create a `dev` branch
for this larger change. This allows us to keep main releasable until we are ready to merge the dev branch to
main.

## Master Branch Rename

The `master` branch was renamed to `main` on 17 Feb 2021. If you have already
Expand Down
12 changes: 3 additions & 9 deletions tools/release-note.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This is release `${RELEASE_TAG}` of the Grafana Agent.

### Upgrading
Read the [migration guide](https://github.com/grafana/agent/blob/${RELEASE_TAG}/docs/migration-guide.md) for specific instructions on upgrading from older versions.
Read the [migration guide](https://github.com/grafana/agent/blob/${RELEASE_TAG}/docs/upgrade-guide/_index.md) for specific instructions on upgrading from older versions.

### Notable changes:
:warning: **ADD RELEASE NOTES HERE** :warning:
Expand All @@ -10,15 +10,9 @@ Read the [migration guide](https://github.com/grafana/agent/blob/${RELEASE_TAG}/
### Installation:
Grafana Agent is currently distributed in plain binary form, Docker container images, a Windows installer, and a Kubernetes install script. Choose whichever fits your use-case best.

#### Kubernetes Install Script
#### Kubernetes

The following scripts will download and install two Kubernetes manifests for the Agent. The first manifest collects metrics, the second collects logs, and the final collects traces. You will be prompted for input for each manifest. The script requires curl and envsubst (GNU gettext).

```
NAMESPACE="default" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/${RELEASE_TAG}/production/kubernetes/install.sh)" | kubectl apply -f -
NAMESPACE="default" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/${RELEASE_TAG}/production/kubernetes/install-loki.sh)" | kubectl apply -f -
NAMESPACE="default" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/${RELEASE_TAG}/production/kubernetes/install-traces.sh)" | kubectl apply -f -
```
Install directions [here.](https://grafana.com/docs/grafana-cloud/quickstart/agent-k8s/)

#### Docker container:

Expand Down