forked from vectordotdev/vector
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathloki.toml
More file actions
140 lines (118 loc) · 3.91 KB
/
Copy pathloki.toml
File metadata and controls
140 lines (118 loc) · 3.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
[sinks.loki]
title = "loki"
beta = true
common = true
delivery_guarantee = "best_effort"
egress_method = "batching"
function_category = "transmit"
healthcheck = true
input_types = ["log"]
min_version = "0"
requirements = {}
write_to_description = "[Loki][urls.loki]"
<%= render("_partials/_component_options.toml", type: "sink", name: "loki") %>
<%= render("_partials/_batch_options.toml", namespace: "sinks.loki.options", common: false, max_events: nil, max_size: 10490000, timeout_secs: 1) %>
<%= render("_partials/_buffer_options.toml", namespace: "sinks.loki.options") %>
<%= render(
"_partials/_request_options.toml",
namespace: "sinks.loki.options",
common: false,
in_flight_limit: 5,
rate_limit_duration_secs: 1,
rate_limit_num: 5,
retry_attempts: -1,
retry_initial_backoff_secs: 1,
retry_max_duration_secs: 10,
timeout_secs: 60
) %>
<%= render("_partials/_tls_connector_options.toml", namespace: "sinks.loki.options", can_enable: false, can_verify: true) %>
[sinks.loki.options.endpoint]
type = "string"
required = true
examples = ["http://localhost:3100", "http://127.0.0.1:8080"]
description = "The endpoint used to ship logs to."
[sinks.loki.options.encoding]
type = "string"
common = true
required = true
description = """\
The encoding format used to serialize the events before outputting.\
"""
[sinks.loki.options.encoding.enum]
json = "Each event is encoded into JSON"
text = "Each event is encoded into text via the `message` key."
[sinks.loki.options.tenant_id]
type = "string"
required = false
examples = ["some_tenant_id"]
description = """\
The tenant id that will be sent with every request, by default this is not \
required since a proxy should set this header. When running loki locally a \
tenant id is not required either.
You can read more about tenant id's [here][urls.loki_multi_tenancy]\
"""
[sinks.loki.options.labels]
type = "table"
required = true
examples = [{label = "value"}]
description = """\
A set of labels that will be attached to each batch of events. These values\
are also templateable to allow events to provide dynamic label values.\
Note: If the set of label values has high cardinality this can cause drastic\
performance issues with Loki. To ensure this does not happen one should try\
to reduce the amount of unique label values.\
"""
[sinks.loki.options.labels.children."`[label-name`"]
type = "string"
required = true
templateable = true
examples = [ {key = "value"}, {key = "{{ event_field }}"}]
description = "A key-value pair for labels."
[sinks.loki.options.remove_label_fields]
type = "bool"
required = false
default = false
description = """\
If this is set to `true` then when labels are collected from events those \
fields will also get removed from the event.\
"""
[sinks.loki.options.remove_timestamp]
type = "bool"
required = false
default = true
description = """\
If this is set to `true` then the timestamp will be removed from the event. \
This is useful because loki uses the timestamp to index the event.\
"""
[sinks.loki.options.auth]
type = "table"
common = false
required = false
description = "Options for the authentication strategy."
[sinks.loki.options.auth.children.strategy]
type = "string"
required = true
sort = 1
description = "The authentication strategy to use."
[sinks.loki.options.auth.children.strategy.enum]
basic = "The [basic authentication strategy][urls.basic_auth]."
[sinks.loki.options.auth.children.password]
type = "string"
examples = ["${PASSWORD_ENV_VAR}", "password"]
required = true
relevant_when = {strategy = "basic"}
description = """\
The basic authentication password.\
If using GrafanaLab's hosted Loki then this must be set\
to your `instanceId`.\
"""
[sinks.loki.options.auth.children.user]
type = "string"
examples = ["${USERNAME_ENV_VAR}", "username"]
required = true
relevant_when = {strategy = "basic"}
description = """\
The basic authentication user name.\
If using GrafanaLab's hosted Loki then this must be set\
to your Grafana.com api key.\
"""