Skip to content

Commit

Permalink
Update product name and doc structure (#9)
Browse files Browse the repository at this point in the history
* Delete operator doc tree

* Delete static doc tree

* Move concepts up one level

* Move get-started up one level

* Move reference up one level

* Move tasks up one level

* Move tutorials up one level

* Move release notes up one level

* Merge index files

* Delete flow doc root

* Draft fix to index topic generation

* Tweak makefile and variable file for make docs

* Add temp product variables

* Fix up links in root level topics

* Update tutorials with new prod name and structure

* Update reference paths in tasks

* Update clustering topic

* Make root topic alias match child tpic aliases

* Updtae links in cli topics

* Update metadata in compatibility topic

* Update links in config blocks

* Update links in stdlib

* Update links in get stated run

* Update get started install topics

* Update links and remove old aliases

* Update concepts links

* Update some of the shared content links

* Update some of the canonical URLs

* Clean up shared linking

* Clean up links and metadata in shared topics

* Update links in discovery components

* Update links and metadata on loki components

* Update links amd metadata

* Clean up last relrefs

* Fix a typo

* Update the Makefile

* FIx links in dev docs

* Revert some changes to fix conflicts

* Revert changes in Makefile to fix conflicts

* Regenerate index topic

* Remove old files for operator and static

* Update build tests
  • Loading branch information
clayton-cornell authored Mar 1, 2024
1 parent 813d60b commit cffb19d
Show file tree
Hide file tree
Showing 429 changed files with 6,289 additions and 21,843 deletions.
4 changes: 2 additions & 2 deletions docs/developer/writing-flow-component-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ If documenting a beta component, include the following after the header, but
before the description of the component:

```markdown
{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT VERSION>" >}}
{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
```

If documenting an experimental component, include the following instead:

```markdown
{{< docs/shared lookup="flow/stability/experimental.md" source="agent" version="<AGENT VERSION>" >}}
{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
```

### Usage
Expand Down
108 changes: 39 additions & 69 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,53 @@
---
aliases:
- /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
canonical: https://grafana.com/docs/alloy/latest/
title: Grafana Alloy
description: Grafana Alloy is a flexible, performant, vendor-neutral, telemetry collector
weight: 350
cascade:
AGENT_RELEASE: v0.40.0
ALLOY_RELEASE: $ALLOY_VERSION
OTEL_VERSION: v0.87.0
PRODUCT_NAME: Grafana Alloy
PRODUCT_ROOT_NAME: Alloy
---

# Grafana Agent
# {{% param "PRODUCT_NAME" %}}

Grafana Agent is a vendor-neutral, batteries-included telemetry collector with
configuration inspired by [Terraform][]. It is designed to be flexible,
performant, and compatible with multiple ecosystems such as Prometheus and
OpenTelemetry.
{{< param "PRODUCT_NAME" >}} is a vendor-neutral, batteries-included telemetry collector with configuration inspired by [Terraform][].
It is designed to be flexible, performant, and compatible with multiple ecosystems such as Prometheus and OpenTelemetry.

Grafana Agent is based around **components**. Components are wired together to
form programmable observability **pipelines** for telemetry collection,
processing, and delivery.
{{< param "PRODUCT_NAME" >}} is based around **components**. Components are wired together to form programmable observability **pipelines** for telemetry collection, processing, and delivery.

{{< admonition type="note" >}}
This page focuses mainly on [Flow mode](https://grafana.com/docs/agent/<AGENT_VERSION>/flow/), the Terraform-inspired variant of Grafana Agent.

For information on other variants of Grafana Agent, refer to [Introduction to Grafana Agent]({{< relref "./about.md" >}}).
{{< /admonition >}}

Grafana Agent can collect, transform, and send data to:
{{< param "PRODUCT_NAME" >}} can collect, transform, and send data to:

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

[Terraform]: https://terraform.io
[Prometheus]: https://prometheus.io
[OpenTelemetry]: https://opentelemetry.io
[Loki]: https://github.com/grafana/loki
[Grafana]: https://github.com/grafana/grafana
[Tempo]: https://github.com/grafana/tempo
[Mimir]: https://github.com/grafana/mimir
[Pyroscope]: https://github.com/grafana/pyroscope
## Why use {{< param "PRODUCT_NAME" >}}?

## Why use Grafana Agent?

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

<!--
## Getting started
* Choose a [variant][variants] of Grafana Agent to run.
* Choose a [variant][variants] of {{< param "PRODUCT_NAME" >}} to run.
* Refer to the documentation for the variant to use:
* [Static mode][]
* [Static mode Kubernetes operator][]
* [Flow mode][]
[variants]: ./about/
[Static mode]: https://grafana.com/docs/agent/static/
[Static mode Kubernetes operator]: https://grafana.com/docs/agent/operator/
[Flow mode]: https://grafana.com/docs/agent/flow/
-->

## Supported platforms

* Linux
Expand All @@ -92,29 +72,19 @@ Grafana Agent can collect, transform, and send data to:

## Release cadence

A new minor release is planned every six weeks for the entire Grafana Agent
project, including Static mode, the Static mode Kubernetes operator, and Flow
mode.
A new minor release is planned every six weeks for the entire {{< param "PRODUCT_NAME" >}}.

The release cadence is best-effort: releases may be moved forwards or backwards
if needed. The planned release dates for future minor releases do not change if
one minor release is moved.
The release cadence is best-effort: releases may be moved forwards or backwards if needed.
The planned release dates for future minor releases do not change if one minor release is moved.

Patch and security releases may be created at any time.

{{% docs/reference %}}
[variants]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/about"
[variants]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/about"

[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"

[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
[UI]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
{{% /docs/reference %}}
[Terraform]: https://terraform.io
[Prometheus]: https://prometheus.io
[OpenTelemetry]: https://opentelemetry.io
[Loki]: https://github.com/grafana/loki
[Grafana]: https://github.com/grafana/grafana
[Tempo]: https://github.com/grafana/tempo
[Mimir]: https://github.com/grafana/mimir
[Pyroscope]: https://github.com/grafana/pyroscope
[UI]: ./tasks/debug/#grafana-alloy-ui
108 changes: 39 additions & 69 deletions docs/sources/_index.md.t
Original file line number Diff line number Diff line change
@@ -1,73 +1,53 @@
---
aliases:
- /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
canonical: https://grafana.com/docs/alloy/latest/
title: Grafana Alloy
description: Grafana Alloy is a flexible, performant, vendor-neutral, telemetry collector
weight: 350
cascade:
AGENT_RELEASE: $AGENT_VERSION
ALLOY_RELEASE: $ALLOY_VERSION
OTEL_VERSION: v0.87.0
PRODUCT_NAME: Grafana Alloy
PRODUCT_ROOT_NAME: Alloy
---

# Grafana Agent
# {{% param "PRODUCT_NAME" %}}

Grafana Agent is a vendor-neutral, batteries-included telemetry collector with
configuration inspired by [Terraform][]. It is designed to be flexible,
performant, and compatible with multiple ecosystems such as Prometheus and
OpenTelemetry.
{{< param "PRODUCT_NAME" >}} is a vendor-neutral, batteries-included telemetry collector with configuration inspired by [Terraform][].
It is designed to be flexible, performant, and compatible with multiple ecosystems such as Prometheus and OpenTelemetry.

Grafana Agent is based around **components**. Components are wired together to
form programmable observability **pipelines** for telemetry collection,
processing, and delivery.
{{< param "PRODUCT_NAME" >}} is based around **components**. Components are wired together to form programmable observability **pipelines** for telemetry collection, processing, and delivery.

{{< admonition type="note" >}}
This page focuses mainly on [Flow mode](https://grafana.com/docs/agent/<AGENT_VERSION>/flow/), the Terraform-inspired variant of Grafana Agent.

For information on other variants of Grafana Agent, refer to [Introduction to Grafana Agent]({{< relref "./about.md" >}}).
{{< /admonition >}}

Grafana Agent can collect, transform, and send data to:
{{< param "PRODUCT_NAME" >}} can collect, transform, and send data to:

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

[Terraform]: https://terraform.io
[Prometheus]: https://prometheus.io
[OpenTelemetry]: https://opentelemetry.io
[Loki]: https://github.com/grafana/loki
[Grafana]: https://github.com/grafana/grafana
[Tempo]: https://github.com/grafana/tempo
[Mimir]: https://github.com/grafana/mimir
[Pyroscope]: https://github.com/grafana/pyroscope
## Why use {{< param "PRODUCT_NAME" >}}?

## Why use Grafana Agent?

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

<!--
## Getting started

* Choose a [variant][variants] of Grafana Agent to run.
* Choose a [variant][variants] of {{< param "PRODUCT_NAME" >}} to run.
* Refer to the documentation for the variant to use:
* [Static mode][]
* [Static mode Kubernetes operator][]
* [Flow mode][]

[variants]: ./about/
[Static mode]: https://grafana.com/docs/agent/static/
[Static mode Kubernetes operator]: https://grafana.com/docs/agent/operator/
[Flow mode]: https://grafana.com/docs/agent/flow/

-->

## Supported platforms

* Linux
Expand All @@ -92,29 +72,19 @@ Grafana Agent can collect, transform, and send data to:

## Release cadence

A new minor release is planned every six weeks for the entire Grafana Agent
project, including Static mode, the Static mode Kubernetes operator, and Flow
mode.
A new minor release is planned every six weeks for the entire {{< param "PRODUCT_NAME" >}}.

The release cadence is best-effort: releases may be moved forwards or backwards
if needed. The planned release dates for future minor releases do not change if
one minor release is moved.
The release cadence is best-effort: releases may be moved forwards or backwards if needed.
The planned release dates for future minor releases do not change if one minor release is moved.

Patch and security releases may be created at any time.

{{% docs/reference %}}
[variants]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/about"
[variants]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/about"

[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"

[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
[UI]: "/docs/grafana-cloud/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#grafana-agent-flow-ui"
{{% /docs/reference %}}
[Terraform]: https://terraform.io
[Prometheus]: https://prometheus.io
[OpenTelemetry]: https://opentelemetry.io
[Loki]: https://github.com/grafana/loki
[Grafana]: https://github.com/grafana/grafana
[Tempo]: https://github.com/grafana/tempo
[Mimir]: https://github.com/grafana/mimir
[Pyroscope]: https://github.com/grafana/pyroscope
[UI]: ./tasks/debug/#grafana-alloy-ui
Loading

0 comments on commit cffb19d

Please sign in to comment.