Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

misc: another pass of renaming Agent to Alloy #120

Merged
merged 1 commit into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/developer/release/10-update-otel.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Update Open Telemetry Contrib

Grafana Agent is listed as a distribution of the OpenTelemetry Collector. If there are any new OTel components that Grafana Agent needs to be associated with, then open a PR in [OpenTelemetry Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) and add the Agent to the list of distributions. [Example](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/653ab064bb797ed2b4ae599936a7b9cfdad18a29/receiver/kafkareceiver/README.md?plain=1#L7)
Grafana Alloy is listed as a distribution of the OpenTelemetry Collector. If there are any new OTel components that Grafana Alloy needs to be associated with, then open a PR in [OpenTelemetry Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) and add Alloy to the list of distributions. [Example](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/653ab064bb797ed2b4ae599936a7b9cfdad18a29/receiver/kafkareceiver/README.md?plain=1#L7)

## Steps

1. Determine if there are any new OTEL components by looking at the changelog.

2. Create a PR in OpenTelemetry Contrib.

3. Find those OTEL components in contrib and add Grafana Agent as a distribution.
3. Find those OTEL components in contrib and add Grafana Alloy as a distribution.

4. Tag Juraci ([jpkrohling](https://github.com/jpkrohling)) on the PR.
2 changes: 1 addition & 1 deletion docs/developer/release/7-test-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Validate the new version is working by running it.

1. Validate performance metrics are consistent with the prior version.

2. Validate Flow components are healthy.
2. Validate components are healthy.
6 changes: 3 additions & 3 deletions docs/developer/release/9-announce-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ You made it! This is the last step for any release.

## Steps

1. Announce the release in the Grafana Labs Community #agent channel.
1. Announce the release in the Grafana Labs Community `#alloy` channel.

- Example RCV message:

```
:grafana-agent: Grafana Agent RELEASE_VERSION is now available! :grafana-agent:
:alloy: Grafana Alloy RELEASE_VERSION is now available! :alloy:
Release: https://github.com/grafana/alloy/releases/tag/RELEASE_VERSION
Full changelog: https://github.com/grafana/alloy/blob/RELEASE_VERSION/CHANGELOG.md
We'll be publishing STABLE_RELEASE_VERSION on STABLE_RELEASE_DATE if we haven't heard about any major issues.
Expand All @@ -18,7 +18,7 @@ You made it! This is the last step for any release.
- Example Stable Release or Patch Release message:

```
:grafana-agent: Grafana Agent RELEASE_VERSION is now available! :grafana-agent:
:alloy: Grafana Alloy RELEASE_VERSION is now available! :alloy:
Release: https://github.com/grafana/alloy/releases/tag/RELEASE_VERSION
Full changelog: https://github.com/grafana/alloy/blob/RELEASE_VERSION/CHANGELOG.md
```
2 changes: 1 addition & 1 deletion docs/developer/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document describes the process of creating a release for the
`grafana/alloy` repo. A release includes release assets for everything inside
the repository, including Grafana Agent and Grafana Agent Operator.
the repository.

The processes described here are for v0.24.0 and above.

Expand Down
6 changes: 3 additions & 3 deletions docs/developer/release/concepts/version.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Version

Grafana Agent uses Semantic Versioning. The next version can be determined
Grafana Alloy uses Semantic Versioning. The next version can be determined
by looking at the current version and incrementing it.

## Version
Expand All @@ -11,12 +11,12 @@ To determine the `VERSION` for a Release Candidate, append `-rc.#` to the Semant

- Examples
- For example, `v0.31.0` is the Stable Release `VERSION` for the v0.31.0 release.
- For example, `v0.31.1` is the first Patch Release `VERSION` for the v0.31.0 release.
- For example, `v0.31.1` is the first Patch Release `VERSION` for the v0.31.0 release.
- For example, `v0.31.0-rc.0` is the first Release Candidate `VERSION` for the v0.31.0 release.

## Version Prefix

To determine the `VERSION PREFIX`, use only the major and minor version `vX.Y`.

- Examples
- `v0.31`
- `v0.31`
181 changes: 40 additions & 141 deletions docs/developer/updating-otel.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/developer/windows/certificate_store/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Guide to setting up a Windows Server for Certificate Testing

This guide is used to set up a Windows Server for Windows Store Certificate Testing. This guide assumes you have downloaded a Windows 2022 Server ISO and have installed the Windows Server onto a virtual machine. Certificate Templates can only be installed on Windows Server and it must enabled as an Enterprise Certificate Authority. This guide is NOT meant to be a guide on how to set up a Windows Server for production use, and is meant only for setting up an environment to test the Grafana Agent and certificate store.
This guide is used to set up a Windows Server for Windows Store Certificate Testing. This guide assumes you have downloaded a Windows 2022 Server ISO and have installed the Windows Server onto a virtual machine. Certificate Templates can only be installed on Windows Server and it must enabled as an Enterprise Certificate Authority. This guide is NOT meant to be a guide on how to set up a Windows Server for production use, and is meant only for setting up an environment to test the Grafana Alloy and certificate store.

## Prerequisites

* The install should be fresh with no server roles defined or installed.
* The install should be fresh with no server roles defined or installed.
* You should be logged in via an administrator account.

## Set up as domain controller
Expand Down Expand Up @@ -118,9 +118,9 @@ For this setup we are using a one-node Domain Controller set up as the Enterpris
4. Under `Export File Format` ensure that `Include all certificates in the certificate path if possible`.
5. Export it to a file.

## Setup Grafana Agent
## Setup Grafana Alloy

1. Open the Agent configuration file.
1. Open the Alloy configuration file.
2. Open `Certificate Templates Console`, right-click `Certstore Template` and find the Object identifier.
![](./images/object_identifier.png)

Expand All @@ -132,7 +132,7 @@ For this setup we are using a one-node Domain Controller set up as the Enterpris
6. Configuration should look like this.
![](./images/config.png)

7. Start Agent.
7. Start Alloy.

## Copy certificate to browser

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ For example:
````markdown
## Usage

```river
```alloy
pyroscope.scrape "LABEL" {
targets = TARGET_LIST
forward_to = RECEIVER_LIST
Expand Down Expand Up @@ -228,8 +228,8 @@ relevant to the arguments. If there is component behavior relevant to a
specific block, describe that component behavior in the documentation section
for that block instead.

It is acceptable to provide Flow configuration snippets for the arguments
if it aids documentation.
It is acceptable to provide configuration snippets for the arguments if it aids
documentation.

### Blocks

Expand Down Expand Up @@ -357,8 +357,8 @@ not provided, their Go-inherited defaults will not display in the component UI
page.
```

It is acceptable for block sections to provide Flow configuration snippets for
the block if it aids documentation.
It is acceptable for block sections to provide configuration snippets for the
block if it aids documentation.

### Exported fields

Expand Down Expand Up @@ -417,7 +417,7 @@ healthy.
### Debug information

The Debug information section describes debug information exposed in the
Grafana Agent Flow UI. The section starts with an `h2` header called Debug
Grafana Alloy UI. The section starts with an `h2` header called Debug
information.

If the component does not expose any debug information, the content of the
Expand Down Expand Up @@ -463,8 +463,8 @@ should always prefix the metrics table.
### Examples

The Examples section provides copy-and-paste Alloy pipelines which use the
Flow component. The section starts with an `h2` header called Examples. If
there is only one example, call the section Example instead.
component. The section starts with an `h2` header called Examples. If there is
only one example, call the section Example instead.

If there is more than one example, each example should have an `h3` header
containing a descriptive name. For example:
Expand All @@ -486,7 +486,7 @@ followed by the example in a code block. For example:
This example reads a JSON array of objects from an endpoint and uses them for
the set of scrape targets:

```river
```alloy
remote.http "targets" {
url = TARGETS_URL
}
Expand Down Expand Up @@ -516,7 +516,7 @@ written in all uppercase and underscore delimited, for example: `API_URL`.
Examples of the new component should avoid using placeholders and instead use
realistic example values. For example, if documenting a `prometheus.scrape` component, use:

```river
```grafana-alloy
remote.http "targets" {
url = "http://localhost:8080/targets"
}
Expand All @@ -543,7 +543,7 @@ source for the clarifying comment. Clarifying comments must only be used be
supplementary information to reenforce knowledge, and not as the primary source
of information.

Examples should be formatted using the [grafana-agent fmt](https://grafana.com/docs/agent/latest/flow/reference/cli/fmt/) command.
Examples should be formatted using the [alloy fmt](https://grafana.com/docs/alloy/latest/reference/cli/fmt/) command.

## Exceptions

Expand All @@ -569,6 +569,6 @@ doc page, but because it contains yaml config for the Collector, users might get
how this maps to Alloy and it is better not to link to it. In the future we could try to
move this information from [transformprocessor][] to the [OTTL Context][ottl context] doc.

[loki.source.podlogs]: ../sources/flow/reference/components/loki.source.podlogs.md
[otelcol.processor.transform]: ../sources/flow/reference/components/otelcol.processor.transform.md
[ottl context]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/contexts/README.md
[loki.source.podlogs]: ../sources/reference/components/loki.source.podlogs.md
[otelcol.processor.transform]: ../sources/reference/components/otelcol.processor.transform.md
[ottl context]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/contexts/README.md
34 changes: 18 additions & 16 deletions docs/developer/writing-docs.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# Writing documentation

This page is a collection of guidelines and best practices for writing
documentation for Grafana Agent.
documentation for Grafana Alloy.

## Flow Mode documentation organisation
## Documentation organisation

The Flow mode documentation is organized into the following sections:
The documentation is organized into the following sections:

### Get started
### Introduction

The best place to start for new users who are onboarding.

We showcase the features of the Agent and help users decide when to use Flow and
We showcase the features of Alloy and help users decide when to use it and
whether it's a good fit for them.

This section includes how to quickly install the agent and get hands-on
experience with a simple "hello world" configuration.
### Get started

This section includes how to quickly install Alloy and get hands-on experience
with a simple "hello world" configuration.

### Concepts

Expand All @@ -24,7 +26,7 @@ As defined in the [writer's toolkit][]:
> Provides an overview and background information. Answers the question “What is
> it?”.

It helps users to learn the concepts of the Agent used throughout the
It helps users to learn the concepts of Alloy used throughout the
documentation.

### Tutorials
Expand All @@ -46,7 +48,7 @@ As defined in the [writer's toolkit][]:
> Provides numbered steps that describe how to achieve an outcome. Answers the
> question “How do I?”.

However, in the Agent documentation we don't mandate the use of numbered steps.
However, in Alloy documentation we don't mandate the use of numbered steps.
We do expect that tasks allow users to achieve a specific outcome by following
the page step by step, but we don't require numbered steps because some tasks
branch out into multiple paths, and numbering the steps would look more
Expand All @@ -62,21 +64,21 @@ Instead, they should link to relevant Reference pages.

### Reference

The Reference section is a collection of pages that describe the Agent
components and their configuration options exhaustively. This is a more narrow
definition than the one found in the [writer's toolkit][].
The Reference section is a collection of pages that describe Alloy components
and their configuration options exhaustively. This is a more narrow definition
than the one found in the [writer's toolkit][].

We have a dedicated page with the best practices for writing Reference
docs: [writing flow components documentation][writing-flow-docs].
docs: [writing components documentation][writing-docs].

This is our most detailed documentation, and it should be used as a source of
truth. The contents of the Reference pages should not be repeated in other parts
of the documentation.

### Release notes

Release notes contain all the notable changes in the Agent. They are updated as
part of the release process.
Release notes notify users of changes in Alloy that require user action when
upgrading. They are updated as part of the release process.

[writer's toolkit]: https://grafana.com/docs/writers-toolkit/structure/topic-types/
[writing-flow-docs]: writing-flow-component-documentation.md
[writing-docs]: writing-component-documentation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# Create Prometheus Exporter Flow Components
# Create Prometheus Exporter Components

This guide will walk you through the process of creating a new Prometheus exporter Flow component and best practices for implementing it.

It is required that the exporter has an existing [Agent integration](../sources/static/configuration/integrations/_index.md) in order to wrap it as a Flow component. In the future, we will drop this requirement and Flow components will expose the logic of the exporter directly.

Use the following exporters as a reference:
- [process_exporter](../../component/prometheus/exporter/process/process.go) - [documentation](../sources/flow/reference/components/prometheus.exporter.process.md)
- [blackbox_exporter](../../component/prometheus/exporter/blackbox/blackbox.go) - [documentation](../sources/flow/reference/components/prometheus.exporter.blackbox.md)
- [node_exporter](../../component/prometheus/exporter/unix/unix.go) - [documentation](../sources/flow/reference/components/prometheus.exporter.unix.md)
This guide will walk you through the process of creating a new Prometheus exporter component and best practices for implementing it.

## Arguments (Configuration)

Expand All @@ -19,11 +12,11 @@ Use the following exporters as a reference:

The config would look like this using `matcher` block multiple times:

```river
```grafana-alloy
prometheus.exporter.process "example" {
track_children = false
matcher {
comm = ["grafana-agent"]
comm = ["alloy"]
}
matcher {
comm = ["firefox"]
Expand All @@ -35,7 +28,7 @@ prometheus.exporter.process "example" {

The config would look like this:

```river
```grafana-alloy
prometheus.exporter.blackbox "example" {
config_file = "blackbox_modules.yml"

Expand Down Expand Up @@ -70,8 +63,8 @@ prometheus.exporter.blackbox "example" {

## Registering the component

In order to make the component visible for Agent Flow, it needs to be added to [all.go](../../component/all/all.go) file.
In order to make the component visible to Alloy configurations, it needs to be added to [all.go](../../component/all/all.go) file.

## Documentation

Writing the documentation for the component is very important. Please, follow the [Writing documentation for Flow components](./writing-flow-component-documentation.md) and take a look at the existing documentation for other exporters.
Writing the documentation for the component is very important. Please, follow the [Writing documentation for components](./writing-component-documentation.md) and take a look at the existing documentation for other exporters.
2 changes: 1 addition & 1 deletion docs/sources/get-started/run/binary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
canonical: https://grafana.com/docs/alloy/latest/flow/get-started/run/binary/
canonical: https://grafana.com/docs/alloy/latest/get-started/run/binary/
description: Learn how to run Grafana Alloy as a standalone binary
menuTitle: Standalone
title: Run Grafana Alloy as a standalone binary
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery.kubelet.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ discovery.kubelet "LABEL" {

## Requirements

* The Kubelet must be reachable from the `grafana-agent` pod network.
* The Kubelet must be reachable from the `alloy` pod network.
* Follow the [Kubelet authorization][] documentation to configure authentication to the Kubelet API.

[Kubelet authorization]: https://kubernetes.io/docs/reference/access-authn-authz/kubelet-authn-authz/#kubelet-authorization
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery.relabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: discovery.relabel

# discovery.relabel

In Flow, targets are defined as sets of key-value pairs called _labels_.
In {{< param "PRODUCT_NAME" >}}, targets are defined as sets of key-value pairs called _labels_.

`discovery.relabel` rewrites the label set of the input targets by applying one or more relabeling rules.
If no rules are defined, then the input targets are exported as-is.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ to store read offsets, so that if a component or {{< param "PRODUCT_NAME" >}} re

The data path is inside the directory configured by the `--storage.path` [command line argument][cmd-args].

In the Static mode's [eventhandler integration][eventhandler-integration], a `cache_path` argument is used to configure a positions file.
In Flow mode, this argument is no longer necessary.
In Grafana Agent Static's [eventhandler integration][eventhandler-integration], a `cache_path` argument is used to configure a positions file.
In {{< param "PRODUCT_NAME" >}}, this argument is no longer necessary.

[cmd-args]: ../../cli/run/
[eventhandler-integration]: https://grafana.com/docs/agent/latest/static/configuration/integrations/integrations-next/eventhandler-config/
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/loki.source.podlogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ the Kubernetes API, tails logs from Kubernetes containers of Pods specified by
the discovered them.

`loki.source.podlogs` is similar to `loki.source.kubernetes`, but uses custom
resources rather than being fed targets from another Flow component.
resources rather than being fed targets from another component.

{{< admonition type="note" >}}
Unlike `loki.source.kubernetes`, it is not possible to distribute responsibility of collecting logs across multiple {{< param "PRODUCT_NAME" >}}s.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,4 @@ Connecting some components may not be sensible or components may require further
Refer to the linked documentation for more details.
{{< /admonition >}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
<!-- END GENERATED COMPATIBLE COMPONENTS -->
Loading
Loading