Skip to content

Commit

Permalink
Update topics to change references from Agent to Alloy (#80)
Browse files Browse the repository at this point in the history 
* First pass to clean up grafana- prefix

* Pass number two to clean up grafana prefix

* Next pass at cleaning up grafana- prefixes

* Removed extra closing shortcode syntax

* Additional tidy work on the links headings etc

* Fix up links and headings

* Update and regenerate versioned files

* Update PRODUCT variables to simplify

* Update refs to .river files to .alloy

* Regenerate versioned docs
  • Loading branch information
@clayton-cornell
clayton-cornell authored Mar 26, 2024
1 parent 69d88db commit 01e4c95
Show file tree
Hide file tree
Showing 87 changed files with 464 additions and 623 deletions.
42 changes: 23 additions & 19 deletions docs/sources/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,38 @@ weight: 350
cascade:
ALLOY_RELEASE: v1.0.0
OTEL_VERSION: v0.87.0
PRODUCT_NAME: Grafana Alloy
PRODUCT_ROOT_NAME: Alloy
FULL_PRODUCT_NAME: Grafana Alloy
PRODUCT_NAME: Alloy
_build:
list: false
noindex: true
---

# {{% param "PRODUCT_NAME" %}}

{{< param "PRODUCT_NAME" >}} is a vendor-neutral distribution of the [OpenTelemetry][] (OTel) Collector.
{{< param "PRODUCT_ROOT_NAME" >}} uniquely combines the very best OSS observability signals in the community.
It offers native pipelines for OTel, [Prometheus][], Pyroscope, Loki, and many other metrics, logs, traces, and profile tools.
In additon, you can also use {{< param "PRODUCT_ROOT_NAME" >}} pipelines to do other tasks such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_ROOT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
You can use {{< param "PRODUCT_ROOT_NAME" >}} as an alternative to either of these solutions or combined into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_ROOT_NAME" >}} anywhere within your IT infrastructure and you can pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor.
{{< param "PRODUCT_ROOT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both.
{{< param "FULL_PRODUCT_NAME" >}} is a vendor-neutral distribution of the [OpenTelemetry][] (OTel) Collector.
{{< param "PRODUCT_NAME" >}} uniquely combines the very best OSS observability signals in the community.
It offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In additon, you can also use {{< param "PRODUCT_NAME" >}} pipelines to do other tasks such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
You can use {{< param "PRODUCT_NAME" >}} as an alternative to either of these solutions or combined into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and you can pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor.
{{< param "PRODUCT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both.

## What can {{% param "PRODUCT_ROOT_NAME" %}} do?
## What can {{% param "PRODUCT_NAME" %}} do?

{{< param "PRODUCT_ROOT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments.
{{< param "PRODUCT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments.
Some of these features include:

* **Custom components:** You can use {{< param "PRODUCT_ROOT_NAME" >}} to create and share custom components.
* **Custom components:** You can use {{< param "PRODUCT_NAME" >}} to create and share custom components.
Custom components combine a pipeline of existing components into a single, easy-to-understand component that is just a few lines long.
You can use pre-built custom components from the community, ones packaged by Grafana, or create your own.
* **GitOps compatibility:** {{< param "PRODUCT_ROOT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source.
* **Clustering support:** {{< param "PRODUCT_ROOT_NAME" >}} has native clustering support.
* **GitOps compatibility:** {{< param "PRODUCT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source.
* **Clustering support:** {{< param "PRODUCT_NAME" >}} has native clustering support.
Clustering helps distribute the workload and ensures you have high availability.
You can quickly create horizontally scalable deployments with minimal resource and operational overhead.
* **Security:** {{< param "PRODUCT_ROOT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vaults or Kubernetes clusters to retrieve secrets.
* **Debugging utilities:** {{< param "PRODUCT_ROOT_NAME" >}} provides troubleshooting support and an embedded [user interface][UI] to help you identify and resolve configuration problems.
* **Security:** {{< param "PRODUCT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vaults or Kubernetes clusters to retrieve secrets.
* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides troubleshooting support and an embedded [user interface][UI] to help you identify and resolve configuration problems.

## Supported platforms

Expand All @@ -63,7 +63,7 @@ Some of these features include:

## Release cadence

A new minor release is planned every six weeks for {{< param "PRODUCT_ROOT_NAME" >}}.
A new minor release is planned every six weeks for {{< param "PRODUCT_NAME" >}}.

The release cadence is best-effort.
If necessary, releases may be performed outside of this cadence, or a scheduled release date can be moved forwards or backwards.
Expand All @@ -76,4 +76,8 @@ Patch and security releases may be created at any time.
[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/
[Prometheus]: https://prometheus.io
[Loki]: https://github.com/grafana/loki
[UI]: ./tasks/debug/#grafana-alloy-ui
[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/#alloy-ui
42 changes: 23 additions & 19 deletions docs/sources/_index.md.t
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,38 @@ weight: 350
cascade:
ALLOY_RELEASE: $ALLOY_VERSION
OTEL_VERSION: v0.87.0
PRODUCT_NAME: Grafana Alloy
PRODUCT_ROOT_NAME: Alloy
FULL_PRODUCT_NAME: Grafana Alloy
PRODUCT_NAME: Alloy
_build:
list: false
noindex: true
---

# {{% param "PRODUCT_NAME" %}}

{{< param "PRODUCT_NAME" >}} is a vendor-neutral distribution of the [OpenTelemetry][] (OTel) Collector.
{{< param "PRODUCT_ROOT_NAME" >}} uniquely combines the very best OSS observability signals in the community.
It offers native pipelines for OTel, [Prometheus][], Pyroscope, Loki, and many other metrics, logs, traces, and profile tools.
In additon, you can also use {{< param "PRODUCT_ROOT_NAME" >}} pipelines to do other tasks such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_ROOT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
You can use {{< param "PRODUCT_ROOT_NAME" >}} as an alternative to either of these solutions or combined into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_ROOT_NAME" >}} anywhere within your IT infrastructure and you can pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor.
{{< param "PRODUCT_ROOT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both.
{{< param "FULL_PRODUCT_NAME" >}} is a vendor-neutral distribution of the [OpenTelemetry][] (OTel) Collector.
{{< param "PRODUCT_NAME" >}} uniquely combines the very best OSS observability signals in the community.
It offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In additon, you can also use {{< param "PRODUCT_NAME" >}} pipelines to do other tasks such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
You can use {{< param "PRODUCT_NAME" >}} as an alternative to either of these solutions or combined into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and you can pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor.
{{< param "PRODUCT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both.

## What can {{% param "PRODUCT_ROOT_NAME" %}} do?
## What can {{% param "PRODUCT_NAME" %}} do?

{{< param "PRODUCT_ROOT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments.
{{< param "PRODUCT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments.
Some of these features include:

* **Custom components:** You can use {{< param "PRODUCT_ROOT_NAME" >}} to create and share custom components.
* **Custom components:** You can use {{< param "PRODUCT_NAME" >}} to create and share custom components.
Custom components combine a pipeline of existing components into a single, easy-to-understand component that is just a few lines long.
You can use pre-built custom components from the community, ones packaged by Grafana, or create your own.
* **GitOps compatibility:** {{< param "PRODUCT_ROOT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source.
* **Clustering support:** {{< param "PRODUCT_ROOT_NAME" >}} has native clustering support.
* **GitOps compatibility:** {{< param "PRODUCT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source.
* **Clustering support:** {{< param "PRODUCT_NAME" >}} has native clustering support.
Clustering helps distribute the workload and ensures you have high availability.
You can quickly create horizontally scalable deployments with minimal resource and operational overhead.
* **Security:** {{< param "PRODUCT_ROOT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vaults or Kubernetes clusters to retrieve secrets.
* **Debugging utilities:** {{< param "PRODUCT_ROOT_NAME" >}} provides troubleshooting support and an embedded [user interface][UI] to help you identify and resolve configuration problems.
* **Security:** {{< param "PRODUCT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vaults or Kubernetes clusters to retrieve secrets.
* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides troubleshooting support and an embedded [user interface][UI] to help you identify and resolve configuration problems.

## Supported platforms

Expand All @@ -63,7 +63,7 @@ Some of these features include:

## Release cadence

A new minor release is planned every six weeks for {{< param "PRODUCT_ROOT_NAME" >}}.
A new minor release is planned every six weeks for {{< param "PRODUCT_NAME" >}}.

The release cadence is best-effort.
If necessary, releases may be performed outside of this cadence, or a scheduled release date can be moved forwards or backwards.
Expand All @@ -76,4 +76,8 @@ Patch and security releases may be created at any time.
[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/
[Prometheus]: https://prometheus.io
[Loki]: https://github.com/grafana/loki
[UI]: ./tasks/debug/#grafana-alloy-ui
[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/#alloy-ui
16 changes: 3 additions & 13 deletions docs/sources/about.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
canonical: https://grafana.com/docs/alloy/latest/about/
description: Grafana Alloy is a flexible, performant, vendor-neutral, telemetry collector
description: Alloy is a flexible, performant, vendor-neutral, telemetry collector
menuTitle: Introduction
title: Introduction to Grafana Alloy
title: Introduction to Alloy
weight: 10
_build:
list: false
Expand All @@ -13,7 +13,7 @@ noindex: true

{{< param "PRODUCT_NAME" >}} 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.

{{< param "PRODUCT_NAME" >}} is a _component-based_ revision of {{< param "PRODUCT_ROOT_NAME" >}} with a focus on ease-of-use,
{{< param "PRODUCT_NAME" >}} is a _component-based_ revision of {{< param "PRODUCT_NAME" >}} with a focus on ease-of-use,
debuggability, and ability to adapt to the needs of power users.

Components allow for reusability, composability, and focus on a single task.
Expand Down Expand Up @@ -63,16 +63,6 @@ prometheus.remote_write "default" {
}
```

<!--
## Stability
| Project | Stability |
| ------- | --------- |
| Static mode | Stable |
| Static mode Kubernetes operator | Beta |
| Flow mode | Stable |
-->

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

The {{< param "PRODUCT_NAME" >}} [configuration generator][] helps you get a head start on creating {{< param "PRODUCT_NAME" >}} configurations.
Expand Down
10 changes: 5 additions & 5 deletions docs/sources/concepts/clustering.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ weight: 500

# Clustering

Clustering enables a fleet of {{< param "PRODUCT_ROOT_NAME" >}}s to work together for workload distribution and high availability.
Clustering enables a fleet of {{< param "PRODUCT_NAME" >}}s to work together for workload distribution and high availability.
It helps create horizontally scalable deployments with minimal resource and operational overhead.

To achieve this, {{< param "PRODUCT_NAME" >}} makes use of an eventually consistent model that assumes all participating
{{< param "PRODUCT_ROOT_NAME" >}}s are interchangeable and converge on using the same configuration file.
{{< param "PRODUCT_NAME" >}}s are interchangeable and converge on using the same configuration file.

The behavior of a standalone, non-clustered {{< param "PRODUCT_ROOT_NAME" >}} is the same as if it were a single-node cluster.
The behavior of a standalone, non-clustered {{< param "PRODUCT_NAME" >}} is the same as if it were a single-node cluster.

You configure clustering by passing `cluster` command-line flags to the [run][] command.

Expand All @@ -24,7 +24,7 @@ You configure clustering by passing `cluster` command-line flags to the [run][]

Target auto-distribution is the most basic use case of clustering.
It allows scraping components running on all peers to distribute the scrape load between themselves.
Target auto-distribution requires that all {{< param "PRODUCT_ROOT_NAME" >}} in the same cluster can reach the same service discovery APIs and scrape the same targets.
Target auto-distribution requires that all {{< param "PRODUCT_NAME" >}} in the same cluster can reach the same service discovery APIs and scrape the same targets.

You must explicitly enable target auto-distribution on components by defining a `clustering` block.

Expand All @@ -41,7 +41,7 @@ prometheus.scrape "default" {
A cluster state change is detected when a new node joins or an existing node leaves.
All participating components locally recalculate target ownership and re-balance the number of targets they’re scraping without explicitly communicating ownership over the network.

Target auto-distribution allows you to dynamically scale the number of {{< param "PRODUCT_ROOT_NAME" >}}s to distribute workload during peaks.
Target auto-distribution allows you to dynamically scale the number of {{< param "PRODUCT_NAME" >}}s to distribute workload during peaks.
It also provides resiliency because targets are automatically picked up by one of the node peers if a node leaves.

{{< param "PRODUCT_NAME" >}} uses a local consistent hashing algorithm to distribute targets, meaning that, on average, only ~1/N of the targets are redistributed.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/concepts/config-language/files.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 100

# Files

River files are plain text files with the `.river` file extension.
River files are plain text files with the `.alloy` file extension.
You can refer to each River file as a "configuration file" or a "River configuration."

River files must be UTF-8 encoded and can contain Unicode characters.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/concepts/config-language/syntax.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The `ATTRIBUTE_VALUE` can be either a constant value of a valid River [type][] (

### Blocks

You use _Blocks_ to configure the {{< param "PRODUCT_ROOT_NAME" >}}'s behavior as well as {{< param "PRODUCT_NAME" >}} components by grouping any number of attributes or nested blocks using curly braces.
You use _Blocks_ to configure the {{< param "PRODUCT_NAME" >}}'s behavior as well as {{< param "PRODUCT_NAME" >}} components by grouping any number of attributes or nested blocks using curly braces.
Blocks have a _name_, an optional _label_ and a body that contains any number of arguments and nested unlabeled blocks.

Some blocks can be defined more than once.
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/concepts/modules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ declare "log_filter" {
}
```

You can save this module to a file called `helpers.river` and import it:
You can save this module to a file called `helpers.alloy` and import it:

```river
// Import our helpers.river module, exposing its custom components as
// Import our helpers.alloy module, exposing its custom components as
// helpers.COMPONENT_NAME.
import.file "helpers" {
filename = "helpers.river"
filename = "helpers.alloy"
}
loki.source.file "self" {
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/data-collection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ _build:
noindex: true
---

# {{% param "PRODUCT_NAME" %}} Data collection
# {{% param "FULL_PRODUCT_NAME" %}} Data collection

By default, {{< param "PRODUCT_NAME" >}} sends anonymous but uniquely identifiable usage information from your {{< param "PRODUCT_NAME" >}} instance to Grafana Labs.
By default, {{< param "FULL_PRODUCT_NAME" >}} sends anonymous but uniquely identifiable usage information from your {{< param "PRODUCT_NAME" >}} instance to Grafana Labs.
These statistics are sent to `stats.grafana.org`.

Statistics help us better understand how {{< param "PRODUCT_NAME" >}} is used. This helps us prioritize features and documentation.
Expand Down
Loading

0 comments on commit 01e4c95

Please sign in to comment.