Skip to content

Commit

Permalink
Reorg tabels, add note to operator
Browse files Browse the repository at this point in the history
  • Loading branch information
@clayton-cornell
clayton-cornell committed Nov 15, 2023
1 parent ff2418d commit b8ee19f
Showing 1 changed file with 48 additions and 33 deletions.
81 changes: 48 additions & 33 deletions docs/sources/about.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,30 @@ Grafana Agent is available in three different variants:
{{% docs/reference %}}
[Static mode]: "/docs/agent/ -> /docs/agent/<AGENT VERSION>/static"
[Static mode]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static"

[Static mode Kubernetes operator]: "/docs/agent/ -> /docs/agent/<AGENT VERSION>/operator"
[Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator"

[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"
[Pyroscope]: "/docs/agent/ -> /docs/pyroscope/latest/configure-client/grafana-agent/go_pull.md"
[Pyroscope]: "/docs/grafana-cloud/ -> /docs/pyroscope/latest/configure-client/grafana-agent/go_pull.md"
[clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
[clustering]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering/_index.md"
[rules]: "/docs/agent/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md"
[rules]: "/docs/grafana-cloud/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md"
[vault]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault.md"
[vault]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/remote.vault.md"
{{% /docs/reference %}}

[helm chart]: https://grafana.com/docs/grafana-cloud/monitor-infrastructure/kubernetes-monitoring/configuration/config-k8s-helmchart
[sla]: https://grafana.com/legal/grafana-cloud-sla
[observability]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/setup#send-telemetry

## Stability

| Project | Stability |
Expand All @@ -55,6 +62,37 @@ Grafana Agent is available in three different variants:
> **NOTE**: You don't have to pick just one variant; it's possible to
> mix-and-match installations of Grafana Agent.
### Compare variants

Each variant of Grafana Agent provides a different level of functionality. The following tables compare Grafana Agent Flow mode with Static mode, Operator, OpenTelemetry, and Prometheus.

#### Core telemetry

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

#### **OSS features**

| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
|--------------------------|-------------------------|---------------------------|------------------------|-------------------------|-----------------------|
| **Kubernetes native** | [Yes][helm chart] | No | Yes | Yes | No |
| **Clustering** | [Yes][clustering] | No | No | No | No |
| **Prometheus rules** | [Yes][rules] | No | No | No | No |
| **Native Vault support** | [Yes][vault] | No | No | No | No |

#### Grafana Cloud solutions

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

### Static mode

[Static mode][] is the original variant of Grafana Agent, introduced on March 3, 2020.
Expand All @@ -68,6 +106,11 @@ You should run Static mode when:

### Static mode Kubernetes operator

{{% admonition type="note" %}}
Grafana Agent version 0.37 and newer provides Prometheus Operator compatibility in Flow mode.
You should use Grafana Agent Flow mode for all new Grafana Agent deployments.
{{% /admonition %}}

The [Static mode Kubernetes operator][] is a variant of Grafana Agent introduced on June 17, 2021. It's currently in beta.

The Static mode Kubernetes operator provides compatibility with Prometheus Operator,
Expand Down Expand Up @@ -100,34 +143,6 @@ 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

[BoringCrypto](https://pkg.go.dev/crypto/internal/boring) is an **EXPERIMENTAL** feature for building Grafana Agent
Expand Down

0 comments on commit b8ee19f

Please sign in to comment.