Install Grafana Agent Flow on Grafana Labs

Run Grafana Agent Flow in a Docker container

Wed, 29 Jan 2025 11:00:55 +0000

Run Grafana Agent Flow in a Docker container

Grafana Agent Flow is available as a Docker container image on the following platforms:

Linux containers for AMD64 and ARM64.
Windows containers for AMD64.

Before you begin

Install Docker on your computer.
Create and save a Grafana Agent Flow River configuration file on your computer, for example:
Alloy
```
logging {
  level  = "info"
  format = "logfmt"
}
```

Run a Linux Docker container

To run Grafana Agent Flow as a Linux Docker container, run the following command in a terminal window:

docker run \
  -e AGENT_MODE=flow \
  -v <CONFIG_FILE_PATH>:/etc/agent/config.river \
  -p 12345:12345 \
  grafana/agent:latest \
    run --server.http.listen-addr=0.0.0.0:12345 /etc/agent/config.river

Replace the following:

<CONFIG_FILE_PATH>: The path of the configuration file on your host system.

You can modify the last line to change the arguments passed to the Grafana Agent Flow binary. Refer to the documentation for run for more information about the options available to the run command.

Note
Make sure you pass --server.http.listen-addr=0.0.0.0:12345 as an argument as shown in the example above. If you don’t pass this argument, the debugging UI won’t be available outside of the Docker container.

Run a Windows Docker container

To run Grafana Agent Flow as a Windows Docker container, run the following command in a terminal window:

docker run \
  -e AGENT_MODE=flow \
  -v <CONFIG_FILE_PATH>:C:\etc\grafana-agent\config.river \
  -p 12345:12345 \
  grafana/agent:latest-windows \
    run --server.http.listen-addr=0.0.0.0:12345 C:\etc\grafana-agent\config.river

Replace the following:

<CONFIG_FILE_PATH>: The path of the configuration file on your host system.

You can modify the last line to change the arguments passed to the Grafana Agent Flow binary. Refer to the documentation for run for more information about the options available to the run command.

Note
Make sure you pass --server.http.listen-addr=0.0.0.0:12345 as an argument as shown in the example above. If you don’t pass this argument, the debugging UI won’t be available outside of the Docker container.

Verify

To verify that Grafana Agent Flow is running successfully, navigate to http://localhost:12345 and make sure the Grafana Agent Flow UI loads without error.

Deploy Grafana Agent Flow on Kubernetes

Wed, 29 Jan 2025 11:00:55 +0000

Deploy Grafana Agent Flow on Kubernetes

You can use a Helm chart to deploy Grafana Agent Flow on Kubernetes.

Note
These instructions show you how to install using a generic Helm chart for Grafana Agent Flow. You can deploy Grafana Agent either in static mode or flow mode. The Helm chart deploys Grafana Agent Flow by default.

Before you begin

Install Helm on your computer.
Configure a Kubernetes cluster that you can use for Grafana Agent Flow.
Configure your local Kubernetes context to point to the cluster.

Deploy

To deploy Grafana Agent on Kubernetes using Helm, run the following commands in a terminal window:

Add the Grafana Helm chart repository:

helm repo add grafana https://grafana.github.io/helm-charts

Update the Grafana Helm chart repository:
shell
```
helm repo update
```
Create a namespace for Grafana Agent Flow:
shell
```
kubectl create namespace <NAMESPACE>
```
Replace the following:
- <NAMESPACE>: The namespace to use for your Grafana Agent Flow installation, such as agent.
Install Grafana Agent:
shell
```
helm install --namespace <NAMESPACE> <RELEASE_NAME> grafana/grafana-agent
```
Replace the following:
- <NAMESPACE>: The namespace created in the previous step.
- <RELEASE_NAME>: The name to use for your Grafana Agent installation, such as grafana-agent-flow.
Verify that the Grafana Agent Flow pods are running:
shell
```
kubectl get pods --namespace <NAMESPACE>
```
Replace the following:
- <NAMESPACE>: The namespace used in the previous step.

You have successfully deployed Grafana Agent Flow on Kubernetes, using default Helm settings. To configure Grafana Agent Flow, see the Configure Grafana Agent Flow on Kubernetes guide.

Next steps

Configure Grafana Agent Flow on Kubernetes
Refer to the Grafana Agent Flow Helm chart documentation on Artifact Hub for more information about Helm chart.

Install Grafana Agent Flow on Linux

Wed, 29 Jan 2025 11:00:55 +0000

Install or uninstall Grafana Agent Flow on Linux

You can install Grafana Agent Flow as a systemd service on Linux.

Install

To install Grafana Agent Flow on Linux, run the following commands in a terminal window.

Import the GPG key and add the Grafana package repository.

sudo mkdir -p /etc/apt/keyrings/
wget -q -O - https://apt.grafana.com/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/grafana.gpg > /dev/null
echo "deb [signed-by=/etc/apt/keyrings/grafana.gpg] https://apt.grafana.com stable main" | sudo tee /etc/apt/sources.list.d/grafana.list

wget -q -O gpg.key https://rpm.grafana.com/gpg.key
sudo rpm --import gpg.key
echo -e '[grafana]\nname=grafana\nbaseurl=https://rpm.grafana.com\nrepo_gpgcheck=1\nenabled=1\ngpgcheck=1\ngpgkey=https://rpm.grafana.com/gpg.key\nsslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt' | sudo tee /etc/yum.repos.d/grafana.repo

wget -q -O gpg.key https://rpm.grafana.com/gpg.key
sudo rpm --import gpg.key
sudo zypper addrepo https://rpm.grafana.com grafana

Update the repositories.
Debian-Ubuntu
sudo apt-get update
RHEL-Fedora
yum update
SUSE-openSUSE
sudo zypper update
Install Grafana Agent Flow.
Debian-Ubuntu
sudo apt-get install grafana-agent-flow
RHEL-Fedora
sudo dnf install grafana-agent-flow
SUSE-openSUSE
sudo zypper install grafana-agent-flow

Uninstall

To uninstall Grafana Agent Flow on Linux, run the following commands in a terminal window.

Stop the systemd service for Grafana Agent Flow.
All-distros
```
sudo systemctl stop grafana-agent-flow
```
Uninstall Grafana Agent Flow.
Debian-Ubuntu
sudo apt-get remove grafana-agent-flow
RHEL-Fedora
sudo dnf remove grafana-agent-flow
SUSE-openSUSE
sudo zypper remove grafana-agent-flow
Optional: Remove the Grafana repository.
Debian-Ubuntu
sudo rm -i /etc/apt/sources.list.d/grafana.list
RHEL-Fedora
sudo rm -i /etc/yum.repos.d/rpm.grafana.repo
SUSE-openSUSE
sudo zypper removerepo grafana

Next steps

Install Grafana Agent Flow on macOS

Wed, 29 Jan 2025 11:00:55 +0000

Install Grafana Agent Flow on macOS

You can install Grafana Agent Flow on macOS with Homebrew .

Note
The default prefix for Homebrew on Intel is /usr/local. The default prefix for Homebrew on Apple Silicon is /opt/Homebrew. To verify the default prefix for Homebrew on your computer, open a terminal window and type brew --prefix.

Before you begin

Install Homebrew on your computer.

Install

To install Grafana Agent Flow on macOS, run the following commands in a terminal window.

Add the Grafana Homebrew tap:
shell
```
brew tap grafana/grafana
```
Install Grafana Agent Flow:
shell
```
brew install grafana-agent-flow
```

Upgrade

To upgrade Grafana Agent Flow on macOS, run the following commands in a terminal window.

Upgrade Grafana Agent Flow:
shell
```
brew upgrade grafana-agent-flow
```

Restart Grafana Agent Flow:

brew services restart grafana-agent-flow

Uninstall

To uninstall Grafana Agent Flow on macOS, run the following command in a terminal window:

brew uninstall grafana-agent-flow

Next steps

Install Grafana Agent Flow on Windows

Wed, 29 Jan 2025 11:00:55 +0000

Install Grafana Agent Flow on Windows

You can install Grafana Agent Flow on Windows as a standard graphical install, or as a silent install.

Standard graphical install

To do a standard graphical install of Grafana Agent Flow on Windows, perform the following steps.

Navigate to the latest release on GitHub.
Scroll down to the Assets section.
Download the file called grafana-agent-flow-installer.exe.zip.
Unzip the downloaded file.
Double-click on grafana-agent-installer.exe to install Grafana Agent Flow.

Grafana Agent Flow is installed into the default directory C:\Program Files\Grafana Agent Flow.

Silent install

To do a silent install of Grafana Agent Flow on Windows, perform the following steps.

Navigate to the latest release on GitHub.
Scroll down to the Assets section.
Download the file called grafana-agent-flow-installer.exe.zip.
Unzip the downloaded file.
Run the following command in PowerShell or Command Prompt:
cmd
```
<PATH_TO_INSTALLER> /S
```
Replace the following:
- <PATH_TO_INSTALLER>: The path where the unzipped installer executable is located.

Silent install options

/CONFIG=<path> Path to the configuration file. Default: $INSTDIR\config.river
/DISABLEREPORTING=<yes|no> Disable data collection. Default: no
/DISABLEPROFILING=<yes|no> Disable profiling endpoint. Default: no
/ENVIRONMENT="KEY=VALUE\0KEY2=VALUE2" Define environment variables for Windows Service. Default: ``

Service Configuration

Grafana Agent Flow uses the Windows Registry HKLM\Software\Grafana\Grafana Agent Flow for service configuration.

Arguments (Type REG_MULTI_SZ) Each value represents a binary argument for grafana-agent-flow binary.
Environment (Type REG_MULTI_SZ) Each value represents a environment value KEY=VALUE for grafana-agent-flow binary.

Uninstall

You can uninstall Grafana Agent Flow with Windows Remove Programs or C:\Program Files\Grafana Agent\uninstaller.exe. Uninstalling Grafana Agent Flow stops the service and removes it from disk. This includes any configuration files in the installation directory.

Grafana Agent Flow can also be silently uninstalled by running uninstall.exe /S as Administrator.

Next steps

Install Grafana Agent Flow with Ansible

Wed, 29 Jan 2025 11:00:55 +0000

Install or uninstall Grafana Agent Flow using Ansible

You can use Ansible to install and manage Grafana Agent Flow on Linux hosts.

Before you begin

These steps assume you already have a working Ansible setup and a pre-existing inventory.
You can add the tasks below to any new or existing role.

Steps

To add Grafana Agent Flow to a host:

Create a file named grafana-agent.yml and add the following:

- name: Install Grafana Agent Flow
  hosts: all
  become: true
  tasks:
    - name: Install Grafana Agent Flow
      ansible.builtin.include_role:
        name: grafana.grafana.grafana_agent
      vars:
        grafana_agent_mode: flow
        # Destination file name
        grafana_agent_config_filename: config.river
        # Local file to copy
        grafana_agent_provisioned_config_file:  "<path-to-config-file-on-localhost>"
        grafana_agent_flags_extra:
          server.http.listen-addr: '0.0.0.0:12345'

Replace the following:

<path-to-config-file-on-localhost>: The path to the River configuration file on the Ansible Controller (Localhost).

Run the Ansible playbook. Open a terminal window and run the following command from the Ansible playbook directory.
shell
```
ansible-playbook grafana-agent.yml
```

Validate

To verify that the Grafana Agent Flow service on the target machine is active and running, open a terminal window and run the following command:

$ sudo systemctl status grafana-agent.service

If the service is active and running, the output should look similar to this:

grafana-agent.service - Grafana Agent
  Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled)
  Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago
Main PID: 3176 (agent-linux-amd)
  Tasks: 8 (limit: 515)
  Memory: 92.5M
    CPU: 380ms
  CGroup: /system.slice/grafana-agent.service
    └─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml

Next steps

Configure Grafana Agent Flow

Install Grafana Agent Flow with Chef

Wed, 29 Jan 2025 11:00:55 +0000

Install Grafana Agent Flow with Chef

You can use Chef to install and manage Grafana Agent Flow.

Before you begin

These steps assume you already have a working Chef setup.
You can add the following resources to any new or existing recipe.
These tasks install Grafana Agent Flow from the package repositories. The tasks target Linux systems from the following families:
- Debian (including Ubuntu)
- RedHat Enterprise Linux
- Amazon Linux
- Fedora

Steps

To add Grafana Agent Flow to a host:

Add the following resources to your Chef recipe to add the Grafana package repositories to your system:

if platform_family?('debian', 'rhel', 'amazon', 'fedora')
  if platform_family?('debian')
    remote_file '/etc/apt/keyrings/grafana.gpg' do
      source 'https://apt.grafana.com/gpg.key'
      mode '0644'
      action :create
      end

    file '/etc/apt/sources.list.d/grafana.list' do
      content "deb [signed-by=/etc/apt/keyrings/grafana.gpg] https://apt.grafana.com/ stable main"
      mode '0644'
      notifies :update, 'apt_update[update apt cache]', :immediately
    end

    apt_update 'update apt cache' do
      action :nothing
    end
  elsif platform_family?('rhel', 'amazon', 'fedora')
    yum_repository 'grafana' do
      description 'grafana'
      baseurl 'https://rpm.grafana.com/oss/rpm'
      gpgcheck true
      gpgkey 'https://rpm.grafana.com/gpg.key'
      enabled true
      action :create
      notifies :run, 'execute[add-rhel-key]', :immediately
    end

    execute 'add-rhel-key' do
      command "rpm --import https://rpm.grafana.com/gpg.key"
      action :nothing
    end
  end
else
    fail "The #{node['platform_family']} platform is not supported."
end

Add the following resources to install and enable the grafana-agent-flow service:

package 'grafana-agent-flow' do
  action :install
  flush_cache [ :before ] if platform_family?('amazon', 'rhel', 'fedora')
  notifies :restart, 'service[grafana-agent-flow]', :delayed
end

service 'grafana-agent-flow' do
  service_name 'grafana-agent-flow'
  action [:enable, :start]
end

Configuration

The grafana-agent-flow package installs a default configuration file that doesn’t send telemetry anywhere.

The default configuration file location is /etc/grafana-agent-flow.river. You can replace this file with your own configuration or create a new configuration file for the service to use.

Next steps

Configure Grafana Agent Flow

Install Grafana Agent Flow with Puppet

Wed, 29 Jan 2025 11:00:55 +0000

Install Grafana Agent Flow with Puppet

You can use Puppet to install and manage Grafana Agent Flow.

Before you begin

These steps assume you already have a working Puppet setup.
You can add the following manifest to any new or existing module.
The manifest installs Grafana Agent Flow from the package repositories. It targets Linux systems from the following families:
- Debian (including Ubuntu)
- RedHat Enterprise Linux (including Fedora)

Steps

To add Grafana Agent Flow to a host:

Ensure that the following module dependencies are declared and installed:

{
"name": "puppetlabs/apt",
"version_requirement": ">= 4.1.0 <= 7.0.0"
},
{
"name": "puppetlabs/yumrepo_core",
"version_requirement": "<= 2.0.0"
}

Create a new Puppet manifest with the following class to add the Grafana package repositories, install the grafana-agent-flow package, and run the service:

class grafana_agent::grafana_agent_flow () {
  case $::os['family'] {
    'debian': {
      apt::source { 'grafana':
        location => 'https://apt.grafana.com/',
        release  => '',
        repos    => 'stable main',
        key      => {
          id     => 'B53AE77BADB630A683046005963FA27710458545',
          source => 'https://apt.grafana.com/gpg.key',
        },
      } -> package { 'grafana-agent-flow':
        require => Exec['apt_update'],
      } -> service { 'grafana-agent-flow':
        ensure    => running,
        name      => 'grafana-agent-flow',
        enable    => true,
        subscribe => Package['grafana-agent-flow'],
      }
    }
    'redhat': {
      yumrepo { 'grafana':
        ensure   => 'present',
        name     => 'grafana',
        descr    => 'grafana',
        baseurl  => 'https://packages.grafana.com/oss/rpm',
        gpgkey   => 'https://packages.grafana.com/gpg.key',
        enabled  => '1',
        gpgcheck => '1',
        target   => '/etc/yum.repo.d/grafana.repo',
      } -> package { 'grafana-agent-flow':
      } -> service { 'grafana-agent-flow':
        ensure    => running,
        name      => 'grafana-agent-flow',
        enable    => true,
        subscribe => Package['grafana-agent-flow'],
      }
    }
    default: {
      fail("Unsupported OS family: (${$::os['family']})")
    }
  }
}

To use this class in a module, add the following line to the module’s init.pp file:
ruby
```
include grafana_agent::grafana_agent_flow
```

Configuration

The grafana-agent-flow package installs a default configuration file that doesn’t send telemetry anywhere.

The default configuration file location is /etc/grafana-agent-flow.river. You can replace this file with your own configuration, or create a new configuration file for the service to use.

Next steps

Configure Grafana Agent Flow

Install Grafana Agent Flow as a standalone binary

Wed, 29 Jan 2025 11:00:55 +0000

Install Grafana Agent Flow as a standalone binary

Grafana Agent Flow is distributed as a standalone binary for the following operating systems and architectures:

Linux: AMD64, ARM64
Windows: AMD64
macOS: AMD64 (Intel), ARM64 (Apple Silicon)
FreeBSD: AMD64

Download Grafana Agent

To download Grafana Agent Flow as a standalone binary, perform the following steps.

Navigate to the current Grafana Agent release page.
Scroll down to the Assets section.
Download the grafana-agent zip file that matches your operating system and machine’s architecture.
Extract the package contents into a directory.
If you are installing Grafana Agent Flow on Linux, macOS, or FreeBSD, run the following command in a terminal:
shell
```
chmod +x <BINARY_PATH>
```
Replace the following:
- <BINARY_PATH>: The path to the extracted binary.

Next steps

Run Grafana Agent Flow