Install Grafana Agent in static mode on Grafana Labs

Run Grafana Agent in static mode in a Docker container

Wed, 11 Sep 2024 17:43:35 +0000

Run Grafana Agent in static mode in a Docker container

Grafana Agent 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 YAML configuration file on your computer.

Run a Linux Docker container

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

docker run \
  -v WAL_DATA_DIRECTORY:/etc/agent/data \
  -v CONFIG_FILE_PATH:/etc/agent/agent.yaml \
  grafana/agent:v0.43.4

Replace CONFIG_FILE_PATH with the configuration file path on your Linux host system.

Note
For the flags to work correctly, you must expose the paths on your Linux host to the Docker container through a bind mount.

Run a Windows Docker container

To run a Grafana Agent Docker container on Windows, run the following command in a Windows command prompt:

docker run ^
  -v WAL_DATA_DIRECTORY:C:\etc\grafana-agent\data ^
  -v CONFIG_FILE_PATH:C:\etc\grafana-agent ^
  grafana/agent:v0.43.4-windows

Replace the following:

CONFIG_FILE_PATH: The configuration file path on your Windows host system.
WAL_DATA_DIRECTORY: the directory used to store your metrics before sending them to Prometheus. Old WAL data is cleaned up every hour and is used for recovery if the process crashes.

Note
For the flags to work correctly, you must expose the paths on your Windows host to the Docker container through a bind mount.

Next steps

Deploy Grafana Agent in static mode on Kubernetes

Wed, 11 Sep 2024 17:43:35 +0000

Deploy Grafana Agent in static mode on Kubernetes

You can use the Helm chart for Grafana Agent to deploy Grafana Agent in static mode on Kubernetes.

Before you begin

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

Deploy

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

To deploy Grafana Agent in static mode 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
```
Install Grafana Agent in static mode:
shell
```
helm install <RELEASE_NAME> grafana/grafana-agent --set agent.mode=static
```
Replace the following:
- <RELEASE_NAME>: The name to use for your Grafana Agent installation, such as grafana-agent.
Warning
Always pass --set agent.mode=static in helm install or helm upgrade commands to ensure Grafana Agent gets installed in static mode. Alternatively, set agent.mode to static in your values.yaml file.

For more information on the Grafana Agent Helm chart, refer to the Helm chart documentation on Artifact Hub.

Install Grafana Agent in static mode on Linux

Wed, 11 Sep 2024 17:43:35 +0000

Install Grafana Agent in static mode on Linux

You can install Grafana Agent in static mode on Linux.

Install on Debian or Ubuntu

To install Grafana Agent in static mode on Debian or Ubuntu, 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

Update the repositories:
shell
```
sudo apt-get update
```
Install Grafana Agent:
shell
```
sudo apt-get install grafana-agent
```

Uninstall on Debian or Ubuntu

To uninstall Grafana Agent on Debian or Ubuntu, run the following commands in a terminal window.

Stop the systemd service for Grafana Agent:
shell
```
sudo systemctl stop grafana-agent
```
Uninstall Grafana Agent:
shell
```
sudo apt-get remove grafana-agent
```
Optional: Remove the Grafana repository:
shell
```
sudo rm -i /etc/apt/sources.list.d/grafana.list
```

Install on RHEL or Fedora

To install Grafana Agent in static mode on RHEL or Fedora, run the following commands in a terminal window.

Import the GPG key:

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

Create /etc/yum.repos.d/grafana.repo with the following content:

[grafana]
name=grafana
baseurl=https://rpm.grafana.com
repo_gpgcheck=1
enabled=1
gpgcheck=1
gpgkey=https://rpm.grafana.com/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt

Optional: Verify the Grafana repository configuration:
shell
```
cat /etc/yum.repos.d/grafana.repo
```
Install Grafana Agent:
shell
```
sudo dnf install grafana-agent
```

Uninstall on RHEL or Fedora

To uninstall Grafana Agent on RHEL or Fedora, run the following commands in a terminal window:

Stop the systemd service for Grafana Agent:
shell
```
sudo systemctl stop grafana-agent
```
Uninstall Grafana Agent:
shell
```
sudo dnf remove grafana-agent
```
Optional: Remove the Grafana repository:
shell
```
sudo rm -i /etc/yum.repos.d/rpm.grafana.repo
```

Install on SUSE or openSUSE

To install Grafana Agent in static mode on SUSE or openSUSE, run the following commands in a terminal window.

Import the GPG key and add the Grafana package repository:

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

Update the repositories:
shell
```
sudo zypper update
```
Install Grafana Agent:
shell
```
sudo zypper install grafana-agent
```

Uninstall on SUSE or openSUSE

To uninstall Grafana Agent on SUSE or openSUSE, run the following commands in a terminal:

Stop the systemd service for Grafana Agent:
shell
```
sudo systemctl stop grafana-agent
```
Uninstall Grafana Agent:
shell
```
sudo zypper remove grafana-agent
```
Optional: Remove the Grafana repository:
shell
```
sudo zypper removerepo grafana
```

Operation guide

The Grafana Agent is configured as a systemd service.

Start the Agent

To run Grafana Agent, run the following in a terminal:

sudo systemctl start grafana-agent

To check the status of Grafana Agent, run the following command in a terminal:

sudo systemctl status grafana-agent

Run Grafana Agent on startup

To automatically run Grafana Agent when the system starts, run the following command in a terminal:

sudo systemctl enable grafana-agent.service

Configuring Grafana Agent

To configure Grafana Agent when installed on Linux, perform the following steps:

Edit the default configuration file at /etc/grafana-agent.yaml.
Run the following command in a terminal to reload the configuration file:
shell
```
sudo systemctl reload grafana-agent
```

View Grafana Agent logs

Logs of Grafana Agent can be found by running the following command in a terminal:

sudo journalctl -u grafana-agent

Next steps

Install Grafana Agent in static mode on macOS

Wed, 11 Sep 2024 17:43:35 +0000

Install Grafana Agent in static mode on macOS

You can install Grafana Agent in static mode on macOS with Homebrew.

Before you begin

Install Homebrew on your computer.

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.

Install

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

Update Homebrew:
shell
```
brew update
```
Install Grafana Agent:
shell
```
brew install grafana-agent
```

Grafana Agent is installed by default at $(brew --prefix)/Cellar/grafana-agent/VERSION.

Upgrade

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

Upgrade Grafana Agent:
shell
```
brew upgrade grafana-agent
```
Restart Grafana Agent:
shell
```
brew services restart grafana-agent
```

Uninstall

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

brew uninstall grafana-agent

Configure

To create the Agent config.yml file, open a terminal and run the following command:
shell
```
touch $(brew --prefix)/etc/grafana-agent/config.yml
```
Edit $(brew --prefix)/etc/grafana-agent/config.yml and add the configuration blocks for your specific telemetry needs. Refer to Configure Grafana Agent for more information.

Note
To send your data to Grafana Cloud, set up Grafana Agent using the Grafana Cloud integration. Refer to how to install an integration and macOS integration.

Next steps

Install Grafana Agent in static mode on Windows

Wed, 11 Sep 2024 17:43:35 +0000

Install Grafana Agent in static mode on Windows

You can install Grafana Agent in static mode on Windows as a standard graphical install, or as a silent install.

Standard install

To do a standard graphical install of Grafana Agent 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-installer.exe.zip.
Unzip the downloaded file.
Double-click on grafana-agent-installer.exe to install Grafana Agent.

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

The following options are available:
- The windows_exporter integration can be enabled with all default windows_exporter options.
- The -config.expand-env command line flag can be enabled.

Silent install

To do a silent install of Grafana Agent 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-installer.exe.zip.
Unzip the downloaded file.
Run the following command in PowerShell or Command Prompt:
shell
```
PATH_TO_INSTALLER/grafana-agent-installer.exe /S
```
Replace PATH_TO_INSTALLER with the path where the unzipped installer executable is located.

Silent install with `remote_write`

If you are using remote_write you must enable Windows Exporter and set the global remote_write configuration.

Navigate to the latest release on GitHub.
Scroll down to the Assets section.
Download the file called grafana-agent-installer.exe.zip.
Unzip the downloaded file.
Run the following command in PowerShell or Command Prompt:
shell
```
PATH_TO_INSTALLER/grafana-agent-installer.exe /S /EnableExporter true /Username USERNAME /Password PASSWORD /Url "http://example.com"
```
Replace the following:
- PATH_TO_INSTALLER: The path where the unzipped installer executable is located.
- USERNAME: Your username
- PASSWORD: Your password
If you are using Powershell, make sure you use triple quotes """http://example.com""" around the URL parameter.

Silent install with `-config.expand_env`

You can enable -config.expand-env during a silent install.

Navigate to the latest release on GitHub.
Scroll down to the Assets section.
Download the file called grafana-agent-installer.exe.zip.
Unzip the downloaded file.
Run the following command in PowerShell or Command Prompt:
shell
```
PATH_TO_INSTALLER/grafana-agent-installer.exe /S /ExpandEnv true
```

Verify the installation

Make sure you can access http://localhost:12345/-/healthy and http://localhost:12345/agent/api/v1/metrics/targets.
Optional: You can adjust C:\Program Files\Grafana Agent\agent-config.yaml to meet your specific needs. After changing the configuration file, restart the Grafana Agent service to load changes to the configuration.

Existing configuration files are kept when re-installing or upgrading the Grafana Agent.

Security

A configuration file for Grafana Agent is provided by default at C:\Program Files\Grafana Agent. Depending on your configuration, you can modify the default permissions of the file or move it to another directory.

If you change the location of the configuration file, do the following step.

Update the Grafana Agent service to load the new path.
Run the following with Administrator privileges in PowerShell or Command Prompt:
shell
```
sc config "Grafana Agent" binpath= "INSTALLED_DIRECTORY\agent-windows-amd64.exe -config.file=\"PATH_TO_CONFIG\agent-config.yaml\""
```
Replace PATH_TO_CONFIG with the full path to your Grafana Agent configuratiuon file.

Uninstall Grafana Agent

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

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

Push Windows logs to Grafana Loki

Grafana Agent can use the embedded promtail to push Windows Event Logs to Grafana Loki. Example configuration below:

server:
  log_level: debug
logs:
  # Choose a directory to save the last read position of log files at.
  # This directory will be created if it doesn't already exist.
  positions_directory: "C:\\path\\to\\directory"
  configs:
    - name: windows
      # Loki endpoint to push logs to
      clients:
        - url: https://example.com
      scrape_configs:
      - job_name: windows
        windows_events:
          # Note the directory structure must already exist but the file will be created on demand
          bookmark_path: "C:\\path\\to\\bookmark\\directory\\bookmark.xml"
          use_incoming_timestamp: false
          eventlog_name: "Application"
          # Filter for logs
          xpath_query: '*'
          labels:
            job: windows

Refer to windows_events for additional configuration details.

Next steps

Install Grafana Agent in static mode as a standalone binary

Wed, 11 Sep 2024 17:43:35 +0000

Install Grafana Agent in static mode as a standalone binary

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

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

Note
ppc64le builds are considered secondary release targets and do not have the same level of support and testing as other platforms.

The binary executable will run Grafana Agent in standalone mode. If you want to run Grafana Agent as a service, refer to the installation instructions for:

Download Grafana Agent

To download the Grafana Agent 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 on Linux, macOS, or FreeBSD, run the following command in a terminal:
shell
```
chmod +x EXTRACTED_BINARY
```

Install Grafana Agent in static mode on Grafana Labs

Run Grafana Agent in static mode in a Docker container

Run Grafana Agent in static mode in a Docker container

Before you begin

Run a Linux Docker container

Run a Windows Docker container

Next steps

Deploy Grafana Agent in static mode on Kubernetes

Deploy Grafana Agent in static mode on Kubernetes

Before you begin

Deploy

Install Grafana Agent in static mode on Linux

Install Grafana Agent in static mode on Linux

Install on Debian or Ubuntu

Uninstall on Debian or Ubuntu

Install on RHEL or Fedora

Uninstall on RHEL or Fedora

Install on SUSE or openSUSE

Uninstall on SUSE or openSUSE

Operation guide

Start the Agent

Run Grafana Agent on startup

Configuring Grafana Agent

View Grafana Agent logs

Next steps

Install Grafana Agent in static mode on macOS

Install Grafana Agent in static mode on macOS

Before you begin

Install

Upgrade

Uninstall

Configure

Next steps

Install Grafana Agent in static mode on Windows

Install Grafana Agent in static mode on Windows

Standard install

Silent install

Silent install with remote_write

Silent install with -config.expand_env

Verify the installation

Security

Uninstall Grafana Agent

Push Windows logs to Grafana Loki

Next steps

Install Grafana Agent in static mode as a standalone binary

Install Grafana Agent in static mode as a standalone binary

Download Grafana Agent

Next steps

Silent install with `remote_write`

Silent install with `-config.expand_env`