Skip to content

Commit 6b29c44

Browse files
committed
[v0.43] Format with prettier
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
1 parent f0df06c commit 6b29c44

File tree

356 files changed

+11250
-10794
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

356 files changed

+11250
-10794
lines changed

docs/sources/_index.md

+30-31
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
aliases:
3-
- /docs/grafana-cloud/agent/
4-
- /docs/grafana-cloud/monitor-infrastructure/agent/
5-
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/
6-
- /docs/grafana-cloud/send-data/agent/
3+
- /docs/grafana-cloud/agent/
4+
- /docs/grafana-cloud/monitor-infrastructure/agent/
5+
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/
6+
- /docs/grafana-cloud/send-data/agent/
77
canonical: https://grafana.com/docs/agent/latest/
88
title: Grafana Agent
99
description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
@@ -57,9 +57,9 @@ For information on other variants of Grafana Agent, refer to [Introduction to Gr
5757

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

60-
* The [Prometheus][] ecosystem
61-
* The [OpenTelemetry][] ecosystem
62-
* The Grafana open source ecosystem ([Loki][], [Grafana][], [Tempo][], [Mimir][], [Pyroscope][])
60+
- The [Prometheus][] ecosystem
61+
- The [OpenTelemetry][] ecosystem
62+
- The Grafana open source ecosystem ([Loki][], [Grafana][], [Tempo][], [Mimir][], [Pyroscope][])
6363

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

7373
## Why use Grafana Agent?
7474

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

8888
## Getting started
8989

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

9696
## Supported platforms
9797

98-
* Linux
98+
- Linux
9999

100-
* Minimum version: kernel 2.6.32 or later
101-
* Architectures: AMD64, ARM64
100+
- Minimum version: kernel 2.6.32 or later
101+
- Architectures: AMD64, ARM64
102102

103-
* Windows
103+
- Windows
104104

105-
* Minimum version: Windows Server 2016 or later, or Windows 10 or later.
106-
* Architectures: AMD64
105+
- Minimum version: Windows Server 2016 or later, or Windows 10 or later.
106+
- Architectures: AMD64
107107

108-
* macOS
108+
- macOS
109109

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

113-
* FreeBSD
113+
- FreeBSD
114114

115-
* Minimum version: FreeBSD 10 or later
116-
* Architectures: AMD64
115+
- Minimum version: FreeBSD 10 or later
116+
- Architectures: AMD64
117117

118118
## Release cadence
119119

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

133133
Patch and security releases may be created at any time.
134-

docs/sources/about.md

+29-31
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
aliases:
3-
- ./about-agent/
4-
- /docs/grafana-cloud/agent/about/
5-
- /docs/grafana-cloud/monitor-infrastructure/agent/about/
6-
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/about/
7-
- /docs/grafana-cloud/send-data/agent/about/
3+
- ./about-agent/
4+
- /docs/grafana-cloud/agent/about/
5+
- /docs/grafana-cloud/monitor-infrastructure/agent/about/
6+
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/about/
7+
- /docs/grafana-cloud/send-data/agent/about/
88
canonical: https://grafana.com/docs/agent/latest/about/
99
description: Grafana Agent is a flexible, performant, vendor-neutral, telemetry collector
1010
menuTitle: Introduction
@@ -78,19 +78,18 @@ Grafana Agent is available in three different variants:
7878
- [Static mode Kubernetes operator](ref:static-mode-kubernetes-operator): The Kubernetes operator for Static mode.
7979
- [Flow mode](ref:flow-mode): The new, component-based Grafana Agent.
8080

81-
8281
[Pyroscope]: https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/go_pull
8382
[helm chart]: https://grafana.com/docs/grafana-cloud/monitor-infrastructure/kubernetes-monitoring/configuration/config-k8s-helmchart
8483
[sla]: https://grafana.com/legal/grafana-cloud-sla
8584
[observability]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/setup#send-telemetry
8685

8786
## Stability
8887

89-
| Project | Stability |
90-
| ------- | --------- |
91-
| Static mode | Stable |
92-
| Static mode Kubernetes operator | Beta |
93-
| Flow mode | Stable |
88+
| Project | Stability |
89+
| ------------------------------- | --------- |
90+
| Static mode | Stable |
91+
| Static mode Kubernetes operator | Beta |
92+
| Flow mode | Stable |
9493

9594
## Choose which variant of Grafana Agent to run
9695

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

104103
#### Core telemetry
105104

106-
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
107-
|--------------|--------------------------|---------------------------|------------------------|-------------------------|-----------------------|
105+
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
106+
| ------------ | ---------------------------------------------- | ------------------------- | ---------------------- | ----------------------- | --------------------- |
108107
| **Metrics** | [Prometheus](ref:prometheus), [OTel](ref:otel) | Prometheus | Prometheus | OTel | Prometheus |
109-
| **Logs** | [Loki](ref:loki), [OTel](ref:otel) | Loki | Loki | OTel | No |
110-
| **Traces** | [OTel](ref:otel) | OTel | OTel | OTel | No |
111-
| **Profiles** | [Pyroscope][] | No | No | Planned | No |
108+
| **Logs** | [Loki](ref:loki), [OTel](ref:otel) | Loki | Loki | OTel | No |
109+
| **Traces** | [OTel](ref:otel) | OTel | OTel | OTel | No |
110+
| **Profiles** | [Pyroscope][] | No | No | Planned | No |
112111

113112
#### **OSS features**
114113

115114
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
116-
|--------------------------|-------------------------|---------------------------|------------------------|-------------------------|-----------------------|
115+
| ------------------------ | ----------------------- | ------------------------- | ---------------------- | ----------------------- | --------------------- |
117116
| **Kubernetes native** | [Yes][helm chart] | No | Yes | Yes | No |
118-
| **Clustering** | [Yes](ref:clustering) | No | No | No | No |
119-
| **Prometheus rules** | [Yes](ref:rules) | No | No | No | No |
120-
| **Native Vault support** | [Yes](ref:vault) | No | No | No | No |
117+
| **Clustering** | [Yes](ref:clustering) | No | No | No | No |
118+
| **Prometheus rules** | [Yes](ref:rules) | No | No | No | No |
119+
| **Native Vault support** | [Yes](ref:vault) | No | No | No | No |
121120

122121
#### Grafana Cloud solutions
123122

124123
| | Grafana Agent Flow mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Prometheus Agent mode |
125-
|-------------------------------|-------------------------|---------------------------|------------------------|-------------------------|-----------------------|
124+
| ----------------------------- | ----------------------- | ------------------------- | ---------------------- | ----------------------- | --------------------- |
126125
| **Official vendor support** | [Yes][sla] | Yes | Yes | No | No |
127126
| **Cloud integrations** | Some | Yes | Some | No | No |
128127
| **Kubernetes monitoring** | [Yes][helm chart] | Yes, custom | Yes | No | Yes, custom |
@@ -135,9 +134,9 @@ Static mode is the most mature variant of Grafana Agent.
135134

136135
You should run Static mode when:
137136

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

140-
* **Grafana Cloud integrations**: You need to use Grafana Agent with Grafana Cloud integrations.
139+
- **Grafana Cloud integrations**: You need to use Grafana Agent with Grafana Cloud integrations.
141140

142141
### Static mode Kubernetes operator
143142

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

154153
You should run the Static mode Kubernetes operator when:
155154

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

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

167166
You should run Flow mode when:
168167

169-
* You need functionality unique to Flow mode:
168+
- You need functionality unique to Flow mode:
170169

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

173-
* **Full OpenTelemetry support**: Support for collecting OpenTelemetry metrics, logs, and traces.
172+
- **Full OpenTelemetry support**: Support for collecting OpenTelemetry metrics, logs, and traces.
174173

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

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

179-
* **Grafana Pyroscope support**: Support for collecting profiles for Grafana Pyroscope.
178+
- **Grafana Pyroscope support**: Support for collecting profiles for Grafana Pyroscope.
180179

181180
### BoringCrypto
182181

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

docs/sources/data-collection.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
aliases:
3-
- ./data-collection/
4-
- /docs/grafana-cloud/agent/data-collection/
5-
- /docs/grafana-cloud/monitor-infrastructure/agent/data-collection/
6-
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/data-collection/
7-
- /docs/grafana-cloud/send-data/agent/data-collection/
3+
- ./data-collection/
4+
- /docs/grafana-cloud/agent/data-collection/
5+
- /docs/grafana-cloud/monitor-infrastructure/agent/data-collection/
6+
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/data-collection/
7+
- /docs/grafana-cloud/send-data/agent/data-collection/
88
canonical: https://grafana.com/docs/agent/latest/data-collection/
99
description: Grafana Agent data collection
1010
menuTitle: Data collection
@@ -40,20 +40,19 @@ Statistics help us better understand how Grafana Agent is used. This helps us pr
4040

4141
The usage information includes the following details:
4242

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

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

5656
## Opt-out of data collection
5757

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

docs/sources/flow/_index.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
aliases:
3-
- /docs/grafana-cloud/agent/flow/
4-
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/
5-
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/
6-
- /docs/grafana-cloud/send-data/agent/flow/
3+
- /docs/grafana-cloud/agent/flow/
4+
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/
5+
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/
6+
- /docs/grafana-cloud/send-data/agent/flow/
77
canonical: https://grafana.com/docs/agent/latest/flow/
8-
description: Grafana Agent Flow is a component-based revision of Grafana Agent with
8+
description:
9+
Grafana Agent Flow is a component-based revision of Grafana Agent with
910
a focus on ease-of-use, debuggability, and adaptability
1011
title: Flow mode
1112
weight: 400
@@ -50,17 +51,17 @@ debuggability, and ability to adapt to the needs of power users.
5051

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

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

5758
## Features
5859

59-
* Write declarative configurations with a Terraform-inspired configuration
60+
- Write declarative configurations with a Terraform-inspired configuration
6061
language.
61-
* Declare components to configure parts of a pipeline.
62-
* Use expressions to bind components together to build a programmable pipeline.
63-
* Includes a UI for debugging the state of a pipeline.
62+
- Declare components to configure parts of a pipeline.
63+
- Use expressions to bind components together to build a programmable pipeline.
64+
- Includes a UI for debugging the state of a pipeline.
6465

6566
{{< param "PRODUCT_NAME" >}} is a [distribution][] of the OpenTelemetry
6667
Collector.
@@ -109,7 +110,6 @@ prometheus.remote_write "default" {
109110
}
110111
```
111112

112-
113113
## {{% param "PRODUCT_NAME" %}} configuration generator
114114

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

121121
## Next steps
122122

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

129129
[distribution]: https://opentelemetry.io/ecosystem/distributions/
130-

docs/sources/flow/concepts/_index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
aliases:
3-
- ../concepts/
4-
- /docs/grafana-cloud/agent/flow/concepts/
5-
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/
6-
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/
7-
- /docs/grafana-cloud/send-data/agent/flow/concepts/
3+
- ../concepts/
4+
- /docs/grafana-cloud/agent/flow/concepts/
5+
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/
6+
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/concepts/
7+
- /docs/grafana-cloud/send-data/agent/flow/concepts/
88
canonical: https://grafana.com/docs/agent/latest/flow/concepts/
99
description: Learn about the Grafana Agent Flow concepts
1010
title: Concepts

0 commit comments

Comments
 (0)