Skip to content

Commit

Permalink
[v0.41] Format with prettier
Browse files Browse the repository at this point in the history
Consistent formatting improves readability and makes it easier for tools to transform the source.

The general human understanding of Markdown has some ambiguities so it's possible this PR will break some documentation presentation because the formatter follows the CommonMark specification.
Elminating this ambiguity provides more consistent behavior and makes it easier for future readers to understand your Markdown.

Consistent formatting is also necessary to provide meaningful diffs in future automated PRs.
If you would like to benefit from automated improvements made by the Docs Platform team, you must adopt `prettier` in your local development and enforce it in CI.

If you would like help running `prettier` in CI, reach out in the [#docs-platform Slack channel](https://raintank-corp.slack.com/archives/C07R2REUULS).

Created-By: reverse-changes
Repository: grafana/agent
Website-Pull-Request: grafana/website#24071
  • Loading branch information
jdbaldry committed Feb 18, 2025
1 parent f0df06c commit 6eba548
Show file tree
Hide file tree
Showing 356 changed files with 11,239 additions and 10,908 deletions.
63 changes: 31 additions & 32 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
aliases:
- /docs/grafana-cloud/agent/
- /docs/grafana-cloud/monitor-infrastructure/agent/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/
- /docs/grafana-cloud/send-data/agent/
- /docs/grafana-cloud/agent/
- /docs/grafana-cloud/monitor-infrastructure/agent/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/
- /docs/grafana-cloud/send-data/agent/
canonical: https://grafana.com/docs/agent/latest/
title: Grafana Agent
description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
weight: 350
cascade:
AGENT_RELEASE: v0.43.4
AGENT_RELEASE: v0.41.1
OTEL_VERSION: v0.96.0
refs:
variants:
Expand Down Expand Up @@ -57,9 +57,9 @@ For information on other variants of Grafana Agent, refer to [Introduction to Gr

Grafana Agent can collect, transform, and send data to:

* The [Prometheus][] ecosystem
* The [OpenTelemetry][] ecosystem
* The Grafana open source ecosystem ([Loki][], [Grafana][], [Tempo][], [Mimir][], [Pyroscope][])
- The [Prometheus][] ecosystem
- The [OpenTelemetry][] ecosystem
- The Grafana open source ecosystem ([Loki][], [Grafana][], [Tempo][], [Mimir][], [Pyroscope][])

[Terraform]: https://terraform.io
[Prometheus]: https://prometheus.io
Expand All @@ -72,48 +72,48 @@ Grafana Agent can collect, transform, and send data to:

## Why use Grafana Agent?

* **Vendor-neutral**: Fully compatible with the Prometheus, OpenTelemetry, and
- **Vendor-neutral**: Fully compatible with the Prometheus, OpenTelemetry, and
Grafana open source ecosystems.
* **Every signal**: Collect telemetry data for metrics, logs, traces, and
- **Every signal**: Collect telemetry data for metrics, logs, traces, and
continuous profiles.
* **Scalable**: Deploy on any number of machines to collect millions of active
- **Scalable**: Deploy on any number of machines to collect millions of active
series and terabytes of logs.
* **Battle-tested**: Grafana Agent extends the existing battle-tested code from
- **Battle-tested**: Grafana Agent extends the existing battle-tested code from
the Prometheus and OpenTelemetry Collector projects.
* **Powerful**: Write programmable pipelines with ease, and debug them using a
- **Powerful**: Write programmable pipelines with ease, and debug them using a
[built-in UI](ref:ui).
* **Batteries included**: Integrate with systems like MySQL, Kubernetes, and
- **Batteries included**: Integrate with systems like MySQL, Kubernetes, and
Apache to get telemetry that's immediately useful.

## Getting started

* Choose a [variant](ref:variants) of Grafana Agent to run.
* Refer to the documentation for the variant to use:
* [Static mode](ref:static-mode)
* [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator)
* [Flow mode](ref:flow-mode)
- Choose a [variant](ref:variants) of Grafana Agent to run.
- Refer to the documentation for the variant to use:
- [Static mode](ref:static-mode)
- [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator)
- [Flow mode](ref:flow-mode)

## Supported platforms

* Linux
- Linux

* Minimum version: kernel 2.6.32 or later
* Architectures: AMD64, ARM64
- Minimum version: kernel 2.6.32 or later
- Architectures: AMD64, ARM64

* Windows
- Windows

* Minimum version: Windows Server 2016 or later, or Windows 10 or later.
* Architectures: AMD64
- Minimum version: Windows Server 2016 or later, or Windows 10 or later.
- Architectures: AMD64

* macOS
- macOS

* Minimum version: macOS 10.13 or later
* Architectures: AMD64 (Intel), ARM64 (Apple Silicon)
- Minimum version: macOS 10.13 or later
- Architectures: AMD64 (Intel), ARM64 (Apple Silicon)

* FreeBSD
- FreeBSD

* Minimum version: FreeBSD 10 or later
* Architectures: AMD64
- Minimum version: FreeBSD 10 or later
- Architectures: AMD64

## Release cadence

Expand All @@ -131,4 +131,3 @@ published outside of the release cadence may not include these dependency
updates.

Patch and security releases may be created at any time.

60 changes: 29 additions & 31 deletions docs/sources/about.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
aliases:
- ./about-agent/
- /docs/grafana-cloud/agent/about/
- /docs/grafana-cloud/monitor-infrastructure/agent/about/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/about/
- /docs/grafana-cloud/send-data/agent/about/
- ./about-agent/
- /docs/grafana-cloud/agent/about/
- /docs/grafana-cloud/monitor-infrastructure/agent/about/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/about/
- /docs/grafana-cloud/send-data/agent/about/
canonical: https://grafana.com/docs/agent/latest/about/
description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
menuTitle: Introduction
Expand Down Expand Up @@ -78,19 +78,18 @@ Grafana Agent is available in three different variants:
- [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator): The Kubernetes operator for Static mode.
- [Flow mode](ref:flow-mode): The new, component-based Grafana Agent.


[Pyroscope]: https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/go_pull
[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 |
| ------- | --------- |
| Static mode | Stable |
| Static mode Kubernetes operator | Beta |
| Flow mode | Stable |
| Project | Stability |
| ------------------------------- | --------- |
| Static mode | Stable |
| Static mode Kubernetes operator | Beta |
| Flow mode | Stable |

## Choose which variant of Grafana Agent to run

Expand All @@ -103,26 +102,26 @@ Each variant of Grafana Agent provides a different level of functionality. The f

#### Core telemetry

| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
|--------------|--------------------------|---------------------------|------------------------|-------------------------|-----------------------|
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
| ------------ | ---------------------------------------------- | ------------------------- | ---------------------- | ----------------------- | --------------------- |
| **Metrics** | [Prometheus](ref:prometheus), [OTel](ref:otel) | Prometheus | Prometheus | OTel | Prometheus |
| **Logs** | [Loki](ref:loki), [OTel](ref:otel) | Loki | Loki | OTel | No |
| **Traces** | [OTel](ref:otel) | OTel | OTel | OTel | No |
| **Profiles** | [Pyroscope][] | No | No | Planned | No |
| **Logs** | [Loki](ref:loki), [OTel](ref:otel) | Loki | Loki | OTel | No |
| **Traces** | [OTel](ref: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](ref:clustering) | No | No | No | No |
| **Prometheus rules** | [Yes](ref:rules) | No | No | No | No |
| **Native Vault support** | [Yes](ref:vault) | No | No | No | No |
| **Clustering** | [Yes](ref:clustering) | No | No | No | No |
| **Prometheus rules** | [Yes](ref:rules) | No | No | No | No |
| **Native Vault support** | [Yes](ref: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 |
Expand All @@ -135,9 +134,9 @@ Static mode is the most mature variant of Grafana Agent.

You should run Static mode when:

* **Maturity**: You need to use the most mature version of Grafana Agent.
- **Maturity**: You need to use the most mature version of Grafana Agent.

* **Grafana Cloud integrations**: You need to use Grafana Agent with Grafana Cloud integrations.
- **Grafana Cloud integrations**: You need to use Grafana Agent with Grafana Cloud integrations.

### Static mode Kubernetes operator

Expand All @@ -153,7 +152,7 @@ allowing static mode to support resources from Prometheus Operator, such as Serv

You should run the Static mode Kubernetes operator when:

* **Prometheus Operator compatibility**: You need to be able to consume
- **Prometheus Operator compatibility**: You need to be able to consume
ServiceMonitors, PodMonitors, and Probes from the Prometheus Operator project
for collecting Prometheus metrics.

Expand All @@ -166,20 +165,19 @@ improved debugging, and ability to adapt to the needs of power users by adopting

You should run Flow mode when:

* You need functionality unique to Flow mode:
- You need functionality unique to Flow mode:

* **Improved debugging**: You need to more easily debug configuration issues using a UI.
- **Improved debugging**: You need to more easily debug configuration issues using a UI.

* **Full OpenTelemetry support**: Support for collecting OpenTelemetry metrics, logs, and traces.
- **Full OpenTelemetry support**: Support for collecting OpenTelemetry metrics, logs, and traces.

* **PrometheusRule support**: Support for the PrometheusRule resource from the Prometheus Operator project for configuring Grafana Mimir.
- **PrometheusRule support**: Support for the PrometheusRule resource from the Prometheus Operator project for configuring Grafana Mimir.

* **Ecosystem transformation**: You need to be able to convert Prometheus and Loki pipelines to and from OpenTelmetry Collector pipelines.
- **Ecosystem transformation**: You need to be able to convert Prometheus and Loki pipelines to and from OpenTelmetry Collector pipelines.

* **Grafana Pyroscope support**: Support for collecting profiles for Grafana Pyroscope.
- **Grafana Pyroscope support**: Support for collecting profiles for Grafana Pyroscope.

### BoringCrypto

[BoringCrypto](https://pkg.go.dev/crypto/internal/boring) is an **EXPERIMENTAL** feature for building Grafana Agent
binaries and images with BoringCrypto enabled. Builds and Docker images for Linux arm64/amd64 are made available.

31 changes: 15 additions & 16 deletions docs/sources/data-collection.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
aliases:
- ./data-collection/
- /docs/grafana-cloud/agent/data-collection/
- /docs/grafana-cloud/monitor-infrastructure/agent/data-collection/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/data-collection/
- /docs/grafana-cloud/send-data/agent/data-collection/
- ./data-collection/
- /docs/grafana-cloud/agent/data-collection/
- /docs/grafana-cloud/monitor-infrastructure/agent/data-collection/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/data-collection/
- /docs/grafana-cloud/send-data/agent/data-collection/
canonical: https://grafana.com/docs/agent/latest/data-collection/
description: Grafana Agent data collection
menuTitle: Data collection
Expand Down Expand Up @@ -40,20 +40,19 @@ Statistics help us better understand how Grafana Agent is used. This helps us pr

The usage information includes the following details:

* A randomly generated, anonymous unique ID (UUID).
* Timestamp of when the UID was first generated.
* Timestamp of when the report was created (by default, every four hours).
* Version of running Grafana Agent.
* Operating system Grafana Agent is running on.
* System architecture Grafana Agent is running on.
* List of enabled feature flags ([Static](ref:static) mode only).
* List of enabled integrations ([Static](ref:static) mode only).
* List of enabled [components](ref:components) ([Flow](ref:flow) mode only).
* Method used to deploy Grafana Agent, for example Docker, Helm, RPM, or Operator.
- A randomly generated, anonymous unique ID (UUID).
- Timestamp of when the UID was first generated.
- Timestamp of when the report was created (by default, every four hours).
- Version of running Grafana Agent.
- Operating system Grafana Agent is running on.
- System architecture Grafana Agent is running on.
- List of enabled feature flags ([Static](ref:static) mode only).
- List of enabled integrations ([Static](ref:static) mode only).
- List of enabled [components](ref:components) ([Flow](ref:flow) mode only).
- Method used to deploy Grafana Agent, for example Docker, Helm, RPM, or Operator.

This list may change over time. All newly reported data is documented in the CHANGELOG.

## Opt-out of data collection

You can use the `-disable-reporting` [command line flag](ref:command-line-flag) to disable the reporting and opt-out of the data collection.

37 changes: 18 additions & 19 deletions docs/sources/flow/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/
- /docs/grafana-cloud/send-data/agent/flow/
- /docs/grafana-cloud/agent/flow/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/
- /docs/grafana-cloud/send-data/agent/flow/
canonical: https://grafana.com/docs/agent/latest/flow/
description: Grafana Agent Flow is a component-based revision of Grafana Agent with
description:
Grafana Agent Flow is a component-based revision of Grafana Agent with
a focus on ease-of-use, debuggability, and adaptability
title: Flow mode
weight: 400
Expand Down Expand Up @@ -50,17 +51,17 @@ debuggability, and ability to adapt to the needs of power users.

Components allow for reusability, composability, and focus on a single task.

* **Reusability** allows for the output of components to be reused as the input for multiple other components.
* **Composability** allows for components to be chained together to form a pipeline.
* **Single task** means the scope of a component is limited to one narrow task and thus has fewer side effects.
- **Reusability** allows for the output of components to be reused as the input for multiple other components.
- **Composability** allows for components to be chained together to form a pipeline.
- **Single task** means the scope of a component is limited to one narrow task and thus has fewer side effects.

## Features

* Write declarative configurations with a Terraform-inspired configuration
- Write declarative configurations with a Terraform-inspired configuration
language.
* Declare components to configure parts of a pipeline.
* Use expressions to bind components together to build a programmable pipeline.
* Includes a UI for debugging the state of a pipeline.
- Declare components to configure parts of a pipeline.
- Use expressions to bind components together to build a programmable pipeline.
- Includes a UI for debugging the state of a pipeline.

{{< param "PRODUCT_NAME" >}} is a [distribution][] of the OpenTelemetry
Collector.
Expand Down Expand Up @@ -109,7 +110,6 @@ prometheus.remote_write "default" {
}
```


## {{% param "PRODUCT_NAME" %}} configuration generator

The {{< param "PRODUCT_NAME" >}} [configuration generator](https://grafana.github.io/agent-configurator/) helps you get a head start on creating flow code.
Expand All @@ -120,11 +120,10 @@ This feature is experimental, and it doesn't support all River components.

## Next steps

* [Install](ref:install) {{< param "PRODUCT_NAME" >}}.
* Learn about the core [Concepts](ref:concepts) of {{< param "PRODUCT_NAME" >}}.
* Follow the [Tutorials](ref:tutorials) for hands-on learning of {{< param "PRODUCT_NAME" >}}.
* Consult the [Tasks](ref:tasks) instructions to accomplish common objectives with {{< param "PRODUCT_NAME" >}}.
* Check out the [Reference](ref:reference) documentation to find specific information you might be looking for.
- [Install](ref:install) {{< param "PRODUCT_NAME" >}}.
- Learn about the core [Concepts](ref:concepts) of {{< param "PRODUCT_NAME" >}}.
- Follow the [Tutorials](ref:tutorials) for hands-on learning of {{< param "PRODUCT_NAME" >}}.
- Consult the [Tasks](ref:tasks) instructions to accomplish common objectives with {{< param "PRODUCT_NAME" >}}.
- Check out the [Reference](ref:reference) documentation to find specific information you might be looking for.

[distribution]: https://opentelemetry.io/ecosystem/distributions/

10 changes: 5 additions & 5 deletions docs/sources/flow/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
aliases:
- ../concepts/
- /docs/grafana-cloud/agent/flow/concepts/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/
- /docs/grafana-cloud/send-data/agent/flow/concepts/
- ../concepts/
- /docs/grafana-cloud/agent/flow/concepts/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/
- /docs/grafana-cloud/send-data/agent/flow/concepts/
canonical: https://grafana.com/docs/agent/latest/flow/concepts/
description: Learn about the Grafana Agent Flow concepts
title: Concepts
Expand Down
Loading

0 comments on commit 6eba548

Please sign in to comment.