Skip to content

Commit

Permalink
Update pipeline/outputs/loki.md
Browse files Browse the repository at this point in the history 
Co-authored-by: Craig Norris <[email protected]>
Signed-off-by: Greg Eales <[email protected]>
  • Loading branch information
@0x006EA1E5 @cnorris-cs
0x006EA1E5 and cnorris-cs authored Dec 11, 2024
1 parent fc99aa2 commit 6149d49
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions pipeline/outputs/loki.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@ Be aware there is a separate Golang output plugin provided by [Grafana](https://
| :----------------------------- | :---------- | :------ |
| host | Loki hostname or IP address. Don't include the subpath (for example, `loki/api/v1/push`); use only the base hostname/URL. | `127.0.0.1` |
| uri | Specify a custom HTTP URI. It must start with forward slash. | /loki/api/v1/push |
| port | Loki TCP port | 3100 |
| tls | Use TLS authentication | off |
| http\_user | Set HTTP basic authentication user name | |
| http\_passwd | Set HTTP basic authentication password | |
| bearer\_token | Set bearer token authentication token value. | |
| header | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | |
| tenant\_id | Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent. | |
| labels | Stream labels for API request. It can be multiple comma separated of strings specifying `key=value` pairs. In addition to fixed parameters, it also allows to add custom record keys \(similar to `label_keys` property\). More details in the Labels section. | job=fluent-bit |
| label\_keys | Optional list of record keys that will be placed as stream labels. This configuration property is for records key only. More details in the Labels section. | |
| `uri` | Specify a custom HTTP URL. It must start with forward slash. | `/loki/api/v1/push` |
| `port` | Loki TCP port. | `3100` |
| `tls` | Use TLS authentication. | `off` |
| `http_user` | Set HTTP basic authentication user name. | _none_ |
| `http_passwd` | Set HTTP basic authentication password. | _none_ |
| `bearer_token` | Set bearer token authentication token value. | _none_ |
| `header` | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | _none_ |
| `tenant_id` | Tenant ID used by default to push logs to Loki. If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent. | _none_ |
| `labels` | Stream labels for API request. It can be multiple comma separated of strings specifying `key=value` pairs. In addition to fixed parameters, it also allows to add custom record keys (similar to `label_keys` property). More details in the Labels section. | `job=fluent-bit` |
| `label_keys` | Optional list of record keys that will be placed as stream labels. This configuration property is for records key only. More details in the Labels section. | _none_ |
| `label_map_path` | Specify the label map file path. The file defines how to extract labels from each record. More details in the Labels section. | _none_ |
| `structured_metadata` | Optional, comma-separated list of `key=value` strings specifying structured metadata for the log line. Like the `labels` parameter, values can reference record keys using record accessors. See [Structured metadata](#structured-metadata) for more information. | _none_ |
| `structured_metadata_map_keys` | Optional, comma-separated list of record key strings specifying record values of type map, used to dynamically populate structured metadata for the log line. Values can only reference record keys using record accessors, which should reference map values. Each entry from the referenced map will be used to add an entry to the structured metadata. See [Structured metadata](#structured-metadata) for more information. | _none_ |
Expand Down

0 comments on commit 6149d49

Please sign in to comment.