Skip to content

Commit

Permalink
Replace some usages of agent with alloy (#126)
Browse files Browse the repository at this point in the history
Signed-off-by: Paschalis Tsilias <[email protected]>
  • Loading branch information
tpaschalis authored Apr 5, 2024
1 parent 2eefc57 commit 8a9a157
Show file tree
Hide file tree
Showing 18 changed files with 36 additions and 39 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: Bug report
description: Create a report to help us improve Grafana Agent.
description: Create a report to help us improve Grafana Alloy.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for opening a bug report for Grafana Agent.
Thank you for opening a bug report for Grafana Alloy.
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/agent/discussions) or join the `#agent` channel on the [Grafana Slack](https://slack.grafana.com/).
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/alloy/discussions) or join the `#alloy` channel on the [Grafana Slack](https://slack.grafana.com/).
- type: textarea
attributes:
label: What's wrong?
Expand All @@ -27,7 +27,7 @@ body:
attributes:
label: Software version
description: Provide the version of the software you are using.
placeholder: e.g. Grafana Agent v0.33.0
placeholder: e.g. Grafana Alloy v1.0.0
- type: textarea
attributes:
label: Configuration
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
# recognize it.
blank_issues_enabled: true
contact_links:
- name: Grafana Agent community support
url: https://github.com/grafana/agent/discussions
about: If you need help or support, ask questions in Github Discussions.
- name: Grafana Agent Slack
- name: Grafana Alloy community support
url: https://github.com/grafana/alloy/discussions
about: If you need help or support, ask questions in GitHub Discussions.
- name: Grafana Alloy Slack
url: https://slack.grafana.com/
about: "Join the #agent slack channel to chat about Grafana Agent in real-time."
about: "Join the #alloy slack channel to chat about Grafana Alloy in real-time."
- name: Grafana Cloud or Grafana Enterprise
url: https://grafana.com/profile/org#support
about: Open a support ticket for help with Grafana Cloud or Grafana Enterprise.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: Feature request
description: Suggest an idea to be added to Grafana Agent.
description: Suggest an idea to be added to Grafana Alloy.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for opening a feature request for Grafana Agent.
Thank you for opening a feature request for Grafana Alloy.
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/agent/discussions) or join the `#agent` channel on the [Grafana Slack](https://slack.grafana.com/).
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/alloy/discussions) or join the `#alloy` channel on the [Grafana Slack](https://slack.grafana.com/).
- type: textarea
attributes:
label: Request
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ body:
- type: markdown
attributes:
value: |
Thank you for opening a proposal for Grafana Agent.
Thank you for opening a proposal for Grafana Alloy.
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/agent/discussions) or join the `#agent` channel on the [Grafana Slack](https://slack.grafana.com/).
Please do not use GitHub issues for support questions. If you need help or support, ask a question in [GitHub Discussions](https://github.com/grafana/alloy/discussions) or join the `#alloy` channel on the [Grafana Slack](https://slack.grafana.com/).
- type: textarea
attributes:
label: Background
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
CONTRIBUTORS GUIDE: https://github.com/grafana/agent/blob/main/docs/developer/contributing.md#updating-the-changelog
CONTRIBUTORS GUIDE: https://github.com/grafana/alloy/blob/main/docs/developer/contributing.md#updating-the-changelog
If this is your first PR or you have not contributed in a while, we recommend
taking the time to review the guide. It gives helpful instructions for
Expand All @@ -24,4 +24,4 @@ contributors around things like how to update the changelog.
- [ ] CHANGELOG.md updated
- [ ] Documentation added
- [ ] Tests updated
- [ ] Config converters updated
- [ ] Config converters updated
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,4 @@ v1.0.0 (2024-04-09)

- A built-in UI for visualizing and debugging pipelines.

[upgrade guide]: https://grafana.com/docs/agent/latest/upgrade-guide/
[contributors guide]: ./docs/developer/contributing.md#updating-the-changelog
2 changes: 1 addition & 1 deletion docs/developer/release/1-create-release-branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A single release branch is created for every major or minor release. That release
branch is then used for all Release Candidates, the Stable Release, and all
Patch Releases for that major pr minor version of the agent.
Patch Releases for that version of Alloy.

## Before you begin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Brackets | Description
The following example uses curly braces and square brackets to define an object and an array.

```alloy
obj = { app = "agent", namespace = "dev" }
obj = { app = "alloy", namespace = "dev" }
arr = [1, true, 7 * (1+1), 3]
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following example shows some references.

```alloy
local.file "target" {
filename = "/etc/agent/target"
filename = "/etc/alloy/target"
}
prometheus.scrape "default" {
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery.gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ In those cases, exported fields retain their last healthy values.

```alloy
discovery.gce "gce" {
project = "agent"
project = "alloy"
zone = "us-east1-a"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/loki.write.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ following two mechanisms:

The WAL is located inside a component-specific directory relative to the
storage path {{< param "PRODUCT_NAME" >}} is configured to use. See the
[`agent run` documentation][run] for how to change the storage path.
[`alloy run` documentation][run] for how to change the storage path.

The following arguments are supported:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ consider using `otelcol.processor.k8sattributes` instead.

------
The main use case for `otelcol.processor.discovery` is for users who migrate to {{< param "PRODUCT_NAME" >}}
from Static mode's `prom_sd_operation_type`/`prom_sd_pod_associations` [configuration options][Traces].
from Grafana Agent Static mode's `prom_sd_operation_type`/`prom_sd_pod_associations` [configuration options][Traces].

[Prometheus data model]: https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
[OTEL sem conv]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Replace the following:
### Collect custom metrics from an allowlisted set of databases

This example uses a `prometheus.exporter.postgres` component to collect custom metrics from a set of
specific databases, replacing default metrics with custom metrics derived from queries in `/etc/agent/custom-postgres-metrics.yaml`:
specific databases, replacing default metrics with custom metrics derived from queries in `/etc/alloy/custom-postgres-metrics.yaml`:

```alloy
prometheus.exporter.postgres "example" {
Expand All @@ -156,7 +156,7 @@ prometheus.exporter.postgres "example" {
}
disable_default_metrics = true
custom_queries_config_path = "/etc/agent/custom-postgres-metrics.yaml"
custom_queries_config_path = "/etc/alloy/custom-postgres-metrics.yaml"
}
prometheus.scrape "default" {
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/reference/components/prometheus.receive_http.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ In order to send metrics to the `prometheus.receive_http` component defined in t

```alloy
// Collects metrics of localhost:12345
prometheus.scrape "agent_self" {
prometheus.scrape "self" {
targets = [
{"__address__" = "localhost:12345", "job" = "agent"},
{"__address__" = "localhost:12345", "job" = "alloy"},
]
forward_to = [prometheus.remote_write.local.receiver]
}
Expand Down
8 changes: 3 additions & 5 deletions docs/sources/reference/components/prometheus.remote_write.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,6 @@ of data in the WAL; samples aren't removed until they are at least as old as
`min_keepalive_time`, and samples are forcibly removed if they are older than
`max_keepalive_time`.

[run]: {../../cli/run/

## Exported fields

The following fields are exported and can be referenced by other components:
Expand Down Expand Up @@ -496,7 +494,7 @@ To delete the corrupted WAL:
1. Find and delete the contents of the `wal` directory.

By default the `wal` directory is a subdirectory
of the `data-agent` directory located in the {{< param "PRODUCT_NAME" >}} working directory. The WAL data directory
of the `data-alloy` directory located in the {{< param "PRODUCT_NAME" >}} working directory. The WAL data directory
may be different than the default depending on the path specified by the [command line flag][run] `--storage-path`.

{{< admonition type="note" >}}
Expand All @@ -522,5 +520,5 @@ Refer to the linked documentation for more details.

[snappy]: https://en.wikipedia.org/wiki/Snappy_(compression)
[WAL block]: #wal-block
[Stop]: ../../../get-started/start-agent/
[run]: ../../../reference/cli/run/
[Stop]: ../../../get-started
[run]: ../../cli/run/
4 changes: 2 additions & 2 deletions docs/sources/reference/components/pyroscope.write.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ pyroscope.write "staging" {
pyroscope.scrape "default" {
targets = [
{"__address__" = "pyroscope:4100", "service_name"="pyroscope"},
{"__address__" = "agent:12345", "service_name"="agent"},
{"__address__" = "alloy:12345", "service_name"="alloy"},
]
forward_to = [pyroscope.write.staging.receiver]
}
Expand All @@ -164,4 +164,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 -->
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `initial_interval` argument specifies how long to wait before the first retr
If requests continue to fail, the time to wait before retrying increases by the factor specified by the `multiplier` argument, which must be greater than `1.0`.
The `max_interval` argument specifies the upper bound of how long to wait between retries.

The `randomization_factor` argument is useful for adding jitter between retrying agents.
The `randomization_factor` argument is useful for adding jitter between retrying Alloy instances.
If `randomization_factor` is greater than `0`, the wait time before retries is multiplied by a random factor in the range `[ I - randomization_factor * I, I + randomization_factor * I]`, where `I` is the current interval.

If a batch hasn't been sent successfully, it is discarded after the time specified by `max_elapsed_time` elapses.
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/tasks/configure/configure-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ Use this method if you prefer to write your {{< param "PRODUCT_NAME" >}} configu
}
```

1. Create a ConfigMap called `agent-config` from the above file:
1. Create a ConfigMap called `alloy-config` from the above file:

```shell
kubectl create configmap --namespace <NAMESPACE> agent-config "--from-file=config.alloy=./config.alloy"
kubectl create configmap --namespace <NAMESPACE> alloy-config "--from-file=config.alloy=./config.alloy"
```

Replace the following:
Expand All @@ -134,10 +134,10 @@ Use this method if you prefer to write your {{< param "PRODUCT_NAME" >}} configu
1. Modify Helm Chart's configuration in your `values.yaml` to use the existing ConfigMap:

```yaml
agent:
alloy:
configMap:
create: false
name: agent-config
name: alloy-config
key: config.alloy
```

Expand Down

0 comments on commit 8a9a157

Please sign in to comment.