Fix readme (grafana#8)

Signed-off-by: erikbaranowski <[email protected]>
udmire · May 17, 2023 · bb5bb82 · bb5bb82
1 parent d47e463
commit bb5bb82
Showing 1 changed file with 14 additions and 15 deletions.
diff --git a/modules/grafana-agent/telemetry-to-lgtm/README.md b/modules/grafana-agent/telemetry-to-lgtm/README.md
@@ -13,19 +13,19 @@ loader:
 
 | Name | Type | Description | Default | Required
 | ---- | ---- | ----------- | ------- | --------
-| `grafana_agent_port`    | `string`   | The port the Grafana Agent is running on. | `"12345"` | no
-| `grafana_agent_logpath` | `string`   | The filepath to Grafana Agent logs | | yes
-| `prometheus_endpoint`   | `receiver` | The Prometheus remote write endpoint. | | yes
-| `prometheus_user`       | `string`   | The Prometheus remote write basic auth username. | | yes
-| `prometheus_password`   | `secret`   | The Prometheus remote write basic auth password. | | yes
-| `loki_endpoint`         | `string`   | Loki endpoint | | yes
-| `loki_user`             | `string`   | Loki basic auth username. | | yes
-| `loki_password`         | `secret`   | Loki basic auth password. | | yes
-| `tempo_endpoint`        | `string`   | Tempo Endpoint | | yes
-| `tempo_user`            | `string`   | Tempo basic auth username. | | yes
-| `tempo_password`        | `secret`   | Tempo basic auth password. | | yes
-
-Grafana Agent logs must be forwarded to the file at `grafana_agent_logpath`. For example:
+| `grafana_agent_port`  | `string`   | The port the Grafana Agent is running on. | `"12345"` | no
+| `prometheus_endpoint` | `receiver` | The Prometheus remote write endpoint. | | yes
+| `prometheus_user`     | `string`   | The Prometheus remote write basic auth username. | | yes
+| `prometheus_password` | `secret`   | The Prometheus remote write basic auth password. | | yes
+| `loki_filepath`       | `string`   | The filepath to Grafana Agent logs | | yes
+| `loki_endpoint`       | `string`   | Loki endpoint | | yes
+| `loki_user`           | `string`   | Loki basic auth username. | | yes
+| `loki_password`       | `secret`   | Loki basic auth password. | | yes
+| `tempo_endpoint`      | `string`   | Tempo Endpoint | | yes
+| `tempo_user`          | `string`   | Tempo basic auth username. | | yes
+| `tempo_password`      | `secret`   | Tempo basic auth password. | | yes
+
+Grafana Agent logs must be forwarded to the file at `loki_filepath`. For example:
 
 ```bash
 grafana-agent run parent.river 2>${GRAFANA_AGENT_LOGPATH}
@@ -53,12 +53,11 @@ module.git "agent_telemetry" {
     path       = "modules/grafana-agent/telemetry-to-lgtm/module.river"
 
     arguments {
-        grafana_agent_logpath = "/path/to/logs.log"
-
         prometheus_endpoint = "https://prometheus-us-central1.grafana.net/api/prom/push"
         prometheus_user     = "123456"
         prometheus_password = env("GRAFANA_CLOUD_KEY")
 
+        loki_filepath = "/path/to/logs.log"
         loki_endpoint = "https://logs-prod-us-central1.grafana.net/loki/api/v1/push"
         loki_user     = "1234567"
         loki_password = env("GRAFANA_CLOUD_KEY")