Skip to content
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

Add a table to the flow description showing benefits and strengths of flow #5732

Merged
merged 13 commits into from
Nov 16, 2023
Merged
Changes from 4 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
61 changes: 47 additions & 14 deletions docs/sources/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,14 @@ weight: 100

# Introduction to Grafana Agent

Grafana Agent is a vendor-neutral, batteries-included telemetry collector. It
is designed to be flexible, performant, and compatible with multiple ecosystems
such as Prometheus and OpenTelemetry.
Grafana Agent is a flexible, high performance, vendor-neutral telemetry collector. It's fully compatible with the most popular
open source observability standards such as OpenTelemetry (OTel) and Prometheus.
clayton-cornell marked this conversation as resolved.
Show resolved Hide resolved

Grafana Agent is available in three different variants:

- [Static mode][]: The default, original variant of Grafana Agent.
- [Static mode Kubernetes operator][]: Variant which manages agents running in Static mode.
- [Flow mode][]: The newer, more flexible re-imagining variant of Grafana Agent.
- [Static mode][]: The original Grafana Agent.
- [Static mode Kubernetes operator][]: The Kubernetes operator for Static mode.
- [Flow mode][]: The new, component-based Grafana Agent.

{{% docs/reference %}}
[Static mode]: "/docs/agent/ -> /docs/agent/<AGENT VERSION>/static"
Expand All @@ -33,6 +32,15 @@ Grafana Agent is available in three different variants:

[Flow mode]: "/docs/agent/ -> /docs/agent/<AGENT VERSION>/flow"
[Flow mode]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT VERSION>/flow"

[Prometheus]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-prometheus-metrics.md"
[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-prometheus-metrics.md"

[OTel]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-opentelemetry-data.md"
[OTel]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/collect-opentelemetry-data.md"

[Loki]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-promtail.md"
[Loki]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/getting-started/migrating-from-promtail.md"
{{% /docs/reference %}}

## Stability
Expand All @@ -45,12 +53,12 @@ Grafana Agent is available in three different variants:

## Choose which variant of Grafana Agent to run

> **NOTE**: You do not have to pick just one variant; it is possible to
> **NOTE**: You don't have to pick just one variant; it's possible to
> mix-and-match installations of Grafana Agent.

### Static mode

[Static mode][] is the original variant of Grafana Agent, first introduced on
[Static mode][] is the original variant of Grafana Agent, introduced on
March 3, 2020. Static mode is the most mature variant of Grafana Agent.

You should run Static mode when:
Expand All @@ -76,14 +84,12 @@ You should run the Static mode Kubernetes operator when:

### Flow mode

[Flow mode][] is a stable variant of Grafana Agent first introduced on
[Flow mode][] is a stable variant of Grafana Agent, introduced on
September 29, 2022.

Flow mode was introduced as a re-imagining of Grafana Agent with a focus on
vendor neutrality, ease-of-use, improved debuggability, and ability to adapt to
the needs of power users by adopting a configuration-as-code model.

Flow mode is considered to be the future of the Grafana Agent project.
Grafana Agent Flow mode focuses on vendor neutrality, ease-of-use,
improved debuggability, and ability to adapt to the needs of power
users by adopting a configuration-as-code model.
clayton-cornell marked this conversation as resolved.
Show resolved Hide resolved

You should run Flow mode when:

Expand All @@ -104,6 +110,33 @@ You should run Flow mode when:
* **Grafana Pyroscope support**: Support for collecting profiles for Grafana
Pyroscope.

#### Core telemetry

| | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode |
| -- | -- | -- | -- | -- | -- |
| **Metrics** | Prometheus | Prometheus | Prometheus | OTel | [Prometheus][], [OTel][] |
| **Logs** | No | Loki | Loki | OTel | [Loki][], [OTel][] |
| **Traces** | No | OTel | OTel | OTel | [OTel][] |
| **Profiles** | No | No | No | No | Pyroscope |

#### **OSS features**

| | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode |
| -- | -- | -- | -- | -- | -- |
| **Kubernetes native** | No | No | Yes | Yes | Yes |
| **Clustering** | No | No | No| No | No |
| **Prometheus rules** | No | No | No | No | Yes |
| **Native Vault support** | No | No | No | No | Yes |

#### Grafana Cloud solutions

| | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode |
| -- | -- | -- | -- | -- | -- |
| **Official vendor support** | No | Yes | Yes | No | Yes |
| **Cloud integrations** | No | Yes | Some | No | Some |
| **Kubernetes monitoring** | Yes, custom | Yes, custom | Yes | No | Yes |
| **Application observability** | No | No | No | Yes | Yes |


### BoringCrypto

Expand Down