Skip to content

Commit

Permalink
Merge branch 'main' into fix-windows-uninstall
Browse files Browse the repository at this point in the history
  • Loading branch information
tpaschalis authored Apr 17, 2024
2 parents d49e828 + 41c2df1 commit b864b82
Show file tree
Hide file tree
Showing 53 changed files with 968 additions and 153 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Documentation feedback
description: Give feedback on the Grafana Alloy documentation.
title: "Docs feedback: "
labels: ["type/docs"]
body:
- type: input
id: url
attributes:
label: URL
description: The URL of the page you're providing feedback on.
placeholder: https://grafana.com/docs/alloy/latest/
validations:
required: true
- type: textarea
id: feedback
attributes:
label: Feedback
description: What feedback do you have?
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/helm-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ jobs:
# The tag name in grafana/helm-charts is <package>-<version>, while the
# tag name for grafana/alloy is helm-chart/<version>.
- name: Make github release
uses: softprops/action-gh-release@v1
uses: softprops/action-gh-release@v2
with:
name: ${{ steps.parse-chart.outputs.packagename }}
repository: grafana/helm-charts
Expand Down
22 changes: 20 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,32 @@ This document contains a historical list of changes between releases. Only
changes that impact end-user behavior are listed; changes to documentation or
internal API changes are not present.

Unreleased
----------
Main (unreleased)
-----------------

### Enhancements

- Update `prometheus.exporter.kafka` with the following functionalities (@wildum):
* GSSAPI config
* enable/disable PA_FX_FAST
* set a TLS server name
* show the offset/lag for all consumer group or only the connected ones
* set the minimum number of topics to monitor
* enable/disable auto-creation of requested topics if they don't already exist
* regex to exclude topics / groups
* added metric kafka_broker_info

- In `prometheus.exporter.kafka`, the interpolation table used to compute estimated lag metrics is now pruned
on `metadata_refresh_interval` instead of `prune_interval_seconds`. (@wildum)

### Bugfixes

- Fixed issue with defaults for Beyla component not being applied correctly. (marctc)

- Fix an issue on Windows where uninstalling Alloy did not remove it from the
Add/Remove programs list. (@rfratto)


v1.0.0 (2024-04-09)
-------------------

Expand Down
37 changes: 18 additions & 19 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ cards:
- title: Migrate to Alloy
href: ./tasks/migrate/
description: Learn how to migrate to Alloy from Grafana Agent Operator, Prometheus, Promtail, Grafana Agent Static, or Grafana Agent Flow.
- title: Collect OpenTelemetry data
href: ./tasks/collect-opentelemetry-data/
description: You can configure Alloy to collect OpenTelemetry-compatible data and forward it to any OpenTelemetry-compatible endpoint. Learn how to configure OpenTelemetry data delivery, configure batching, and receive OpenTelemetry data over OTLP.
- title: Collect and forward Prometheus metrics
href: ./tasks/collect-prometheus-metrics/
description: You can configure Alloy to collect Prometheus metrics and forward them to any Prometheus-compatible database. Learn how to configure metrics delivery and collect metrics from Kubernetes Pods.
- title: Concepts
href: ./concepts/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
Expand All @@ -45,37 +51,30 @@ cards:

# Overview

{{< param "PRODUCT_NAME" >}} offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
{{< param "PRODUCT_NAME" >}} offers native pipelines for [OTel][], [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different 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 combine it into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and 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.

{{< admonition type="tip" >}}
{{< param "PRODUCT_NAME" >}} uses the same components, code, and concepts that were first introduced in Grafana Agent Flow.
{{< /admonition >}}

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

{{< 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_NAME" >}} to create and share custom components.
Custom components combine a pipeline of existing components into a single, easy-to-understand component that's 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_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_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vault servers or Kubernetes clusters to retrieve Kubernetes secrets.
* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides debugging tools such as an embedded [user interface][UI] to help you identify and resolve configuration problems.
Some of these features include custom components, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features.

## Explore

{{< card-grid key="cards" type="simple" >}}

[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/
[OTel]: https://opentelemetry.io/ecosystem/distributions/
[Prometheus]: https://prometheus.io/
[Pyroscope]: https://grafana.com/docs/pyroscope/
[Loki]: https://grafana.com/docs/loki/
[Grafana]: https://grafana.com/docs/grafana/
[Tempo]: https://grafana.com/docs/tempo/
[Mimir]: https://grafana.com/docs/mimir/
[Pyroscope]: https://grafana.com/docs/pyroscope/
[UI]: ./tasks/debug/#alloy-ui
[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/
[Introduction]: ./introduction/
37 changes: 18 additions & 19 deletions docs/sources/_index.md.t
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ cards:
- title: Migrate to Alloy
href: ./tasks/migrate/
description: Learn how to migrate to Alloy from Grafana Agent Operator, Prometheus, Promtail, Grafana Agent Static, or Grafana Agent Flow.
- title: Collect OpenTelemetry data
href: ./tasks/collect-opentelemetry-data/
description: You can configure Alloy to collect OpenTelemetry-compatible data and forward it to any OpenTelemetry-compatible endpoint. Learn how to configure OpenTelemetry data delivery, configure batching, and receive OpenTelemetry data over OTLP.
- title: Collect and forward Prometheus metrics
href: ./tasks/collect-prometheus-metrics/
description: You can configure Alloy to collect Prometheus metrics and forward them to any Prometheus-compatible database. Learn how to configure metrics delivery and collect metrics from Kubernetes Pods.
- title: Concepts
href: ./concepts/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
Expand All @@ -45,37 +51,30 @@ cards:

# Overview

{{< param "PRODUCT_NAME" >}} offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and Mimir.
{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail.
{{< param "PRODUCT_NAME" >}} offers native pipelines for [OTel][], [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools.
In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different 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 combine it into a hybrid system of multiple collectors and agents.
You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and 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.

{{< admonition type="tip" >}}
{{< param "PRODUCT_NAME" >}} uses the same components, code, and concepts that were first introduced in Grafana Agent Flow.
{{< /admonition >}}

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

{{< 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_NAME" >}} to create and share custom components.
Custom components combine a pipeline of existing components into a single, easy-to-understand component that's 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_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_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vault servers or Kubernetes clusters to retrieve Kubernetes secrets.
* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides debugging tools such as an embedded [user interface][UI] to help you identify and resolve configuration problems.
Some of these features include custom components, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features.

## Explore

{{< card-grid key="cards" type="simple" >}}

[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/
[OTel]: https://opentelemetry.io/ecosystem/distributions/
[Prometheus]: https://prometheus.io/
[Pyroscope]: https://grafana.com/docs/pyroscope/
[Loki]: https://grafana.com/docs/loki/
[Grafana]: https://grafana.com/docs/grafana/
[Tempo]: https://grafana.com/docs/tempo/
[Mimir]: https://grafana.com/docs/mimir/
[Pyroscope]: https://grafana.com/docs/pyroscope/
[UI]: ./tasks/debug/#alloy-ui
[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/
[Introduction]: ./introduction/
1 change: 1 addition & 0 deletions docs/sources/assets/alloy_icon_orange.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/sources/concepts/custom_components.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
canonical: https://grafana.com/docs/alloy/latest/concepts/custom-components/
canonical: https://grafana.com/docs/alloy/latest/concepts/custom_components/
description: Learn about custom components
title: Custom components
weight: 300
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/get-started/install/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
aliases:
- /docs/alloy/latest/tasks/get-started/install/
canonical: https://grafana.com/docs/alloy/latest/get-started/install/
description: Learn how to install Grafana Alloy
menuTitle: Install
Expand Down
31 changes: 19 additions & 12 deletions docs/sources/get-started/install/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ noindex: true

# Install or uninstall {{% param "FULL_PRODUCT_NAME" %}} using Ansible

You can use Ansible to install and manage {{< param "PRODUCT_NAME" >}} on Linux hosts.
You can use [Grafana Ansible Collection](https://github.com/grafana/grafana-ansible-collection) to install and manage {{< param "PRODUCT_NAME" >}} on Linux hosts.

## Before you begin

Expand All @@ -25,24 +25,31 @@ To add {{% param "PRODUCT_NAME" %}} to a host:
1. Create a file named `alloy.yml` and add the following:

```yaml
- name: Install Grafana Alloy
- name: Install Alloy
hosts: all
become: true

tasks:
- name: Install Grafana Alloy
- name: Install Alloy
ansible.builtin.include_role:
name: grafana.grafana.alloy
vars:
# Destination file name
grafana_alloy_config_filename: config.alloy
# Local file to copy
grafana_alloy_provisioned_config_file: "<path-to-config-file-on-localhost>"
grafana_alloy_flags_extra:
server.http.listen-addr: '0.0.0.0:12345'
config: |
prometheus.scrape "default" {
targets = [{"__address__" = "localhost:12345"}]
forward_to = [prometheus.remote_write.prom.receiver]
}
prometheus.remote_write "prom" {
endpoint {
url = "YOUR_PROMETHEUS_PUSH_ENDPOINT"
}
}
```
Replace the following:
- _`<path-to-config-file-on-localhost>`_: The path to the {{< param "PRODUCT_NAME" >}} configuration file on the Ansible Controller (Localhost).
The above snippet has a sample configuration to collect and send Alloy metrics to Prometheus
Replace the following:
- _`YOUR_PROMETHEUS_PUSH_ENDPOINT`_: With the Remote write endpoint of your Prometheus Instance.

1. Run the Ansible playbook. Open a terminal window and run the following command from the Ansible playbook directory.

Expand Down Expand Up @@ -76,5 +83,5 @@ Main PID: 3176 (alloy-linux-amd)

- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

[Ansible]: https://www.ansible.com/
[Grafana Ansible Collection]: https://github.com/grafana/grafana-ansible-collection
[Configure]: ../../../tasks/configure/configure-linux/
9 changes: 9 additions & 0 deletions docs/sources/get-started/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ weight: 300

You can install {{< param "PRODUCT_NAME" >}} as a systemd service on Linux.

## Before you begin

Some Debian-based cloud Virtual Machines don't have GPG installed by default.
To install GPG in your Linux Virtual Machine, run the following command in a terminal window.

```shell
sudo apt install gpg
```

## Install

To install {{< param "PRODUCT_NAME" >}} on Linux, run the following commands in a terminal window.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Refer to [alloy convert][] for more details on how `extra-args` work.
[data collection]: ../../../data-collection/
[components]: ../../concepts/components/
[component controller]: ../../../concepts/component_controller/
[UI]: ../../tasks/debug/#clustering-page
[UI]: ../../../tasks/debug/#clustering-page
2 changes: 1 addition & 1 deletion docs/sources/reference/cli/tools.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
canonical: https://grafana.com/docs/aalloyent/latest/reference/cli/tools/
canonical: https://grafana.com/docs/alloy/latest/reference/cli/tools/
description: Learn about the tools command
menuTitle: tools
title: The tools command
Expand Down
10 changes: 5 additions & 5 deletions docs/sources/reference/components/beyla.ebpf.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ beyla.ebpf "<LABEL>" {

`beyla.ebpf` supports the following arguments:

Name | Type | Description | Default | Required
-----------------|----------|-------------------------------------------------------------------------------------|---------|---------
`open_port` | `string` | The port of the running service for Beyla automatically instrumented with eBPF. | | no
`excutable_name` | `string` | The name of the executable to match for Beyla automatically instrumented with eBPF. | | no
Name | Type | Description | Default | Required
------------------|----------|-------------------------------------------------------------------------------------|---------|---------
`open_port` | `string` | The port of the running service for Beyla automatically instrumented with eBPF. | | no
`executable_name` | `string` | The name of the executable to match for Beyla automatically instrumented with eBPF. | | no

`open_port` accepts a comma-separated list of ports (for example, `80,443`), and port ranges (for example, `8000-8999`).
If the executable matches only one of the ports in the list, it is considered to match the selection criteria.

`excutable_name` accepts a regular expression to be matched against the full executable command line, including the directory where the executable resides on the file system.
`executable_name` accepts a regular expression to be matched against the full executable command line, including the directory where the executable resides on the file system.

## Blocks

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/loki.process.md
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ The following arguments are supported:
| ------------- | ------------- | ---------------------------------------------- | ---------------- | -------- |
| `replacement` | `string` | String to substitute the matched patterns with | `"**REDACTED**"` | no |
| `source` | `string` | Source of the data to parse. | `""` | no |
| `minLength` | `int` | Minimum length of digits to consider | `13` | no |
| `min_length` | `int` | Minimum length of digits to consider | `13` | no |


The `source` field defines the source of data to search. When `source` is
Expand Down
Loading

0 comments on commit b864b82

Please sign in to comment.