Skip to content

Commit

Permalink
Update the Grafana Agent start topic (#5455) (#5457)
Browse files Browse the repository at this point in the history
* Small changes for clarification

* Add file to description

(cherry picked from commit 5f5fc05)

Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
grafanabot and clayton-cornell authored Oct 12, 2023
1 parent d61092a commit 98a011e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/sources/flow/setup/start-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ AGENT_MODE=flow BINARY_PATH run CONFIG_PATH

Replace the following:

* `BINARY_PATH`: The path and Grafana Agent binary filename.
* `CONFIG_PATH`: The path and Grafana Agent configuration filename.
* `BINARY_PATH`: The path to the Grafana Agent binary file.
* `CONFIG_PATH`: The path to the Grafana Agent configuration file.

### Start Grafana Agent on Windows

Expand All @@ -165,8 +165,8 @@ BINARY_PATH run CONFIG_PATH

Replace the following:

* `BINARY_PATH`: The path and Grafana Agent binary filename.
* `CONFIG_PATH`: The path and Grafana Agent configuration filename.
* `BINARY_PATH`: The path to the Grafana Agent binary file.
* `CONFIG_PATH`: The path to the Grafana Agent configuration file.

### Set up Grafana Agent as a Linux systemd service

Expand All @@ -184,7 +184,7 @@ These steps assume you have a default systemd and Grafana Agent configuration.

1. Create a service file in `/etc/systemd/system` called `grafana-agent-flow.service` with the following contents:

```shell
```systemd
[Unit]
Description=Vendor-neutral programmable observability pipelines.
Documentation=https://grafana.com/docs/agent/latest/flow/
Expand All @@ -196,7 +196,7 @@ These steps assume you have a default systemd and Grafana Agent configuration.
User=grafana-agent-flow
Environment=HOSTNAME=%H
EnvironmentFile=/etc/default/grafana-agent-flow
WorkingDirectory=WORKING_PATH
WorkingDirectory=WORKING_DIRECTORY
ExecStart=BINARY_PATH run $CUSTOM_ARGS --storage.path=WORKING_PATH $CONFIG_FILE
ExecReload=/usr/bin/env kill -HUP $MAINPID
TimeoutStopSec=20s
Expand All @@ -208,8 +208,8 @@ These steps assume you have a default systemd and Grafana Agent configuration.

Replace the following:

* `BINARY_PATH`: The path and Grafana Agent binary filename.
* `WORKING_PATH`: The path to a working directory, for example `/var/lib/grafana-agent-flow`.
* `BINARY_PATH`: The path to the Grafana Agent binary file.
* `WORKING_DIRECTORY`: The path to a working directory, for example `/var/lib/grafana-agent-flow`.

1. Create an environment file in `/etc/default/` called `grafana-agent-flow` with the following contents:

Expand All @@ -234,7 +234,7 @@ These steps assume you have a default systemd and Grafana Agent configuration.

Replace the following:

* `CONFIG_PATH`: The path and Grafana Agent configuration filename.
* `CONFIG_PATH`: The path to the Grafana Agent configuration file.

1. To reload the service files, run the following command in a terminal window:

Expand Down

0 comments on commit 98a011e

Please sign in to comment.