-
Notifications
You must be signed in to change notification settings - Fork 168
/
Copy pathjaeger-query-elasticsearch.yaml
341 lines (341 loc) · 16.2 KB
/
jaeger-query-elasticsearch.yaml
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
name: jaeger-query
synopsis: |
Jaeger query service provides a Web UI and an API for accessing trace data.
description: |
Jaeger query service provides a Web UI and an API for accessing trace data.
usage: jaeger-query [flags]
options:
- name: admin.http.host-port
default_value: :16687
usage: |
The host:port (e.g. 127.0.0.1:16687 or :16687) for the admin server, including health check, /metrics, etc.
- name: config-file
usage: |
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
- name: es-archive.bulk.actions
default_value: "1000"
usage: |
The number of requests that can be enqueued before the bulk processor decides to commit
- name: es-archive.bulk.flush-interval
default_value: 200ms
usage: |
A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled.
- name: es-archive.bulk.size
default_value: "5000000"
usage: |
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
- name: es-archive.bulk.workers
default_value: "1"
usage: |
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
- name: es-archive.create-index-templates
default_value: "true"
usage: |
Create index templates at application startup. Set to false when templates are installed manually.
- name: es-archive.enabled
default_value: "false"
usage: Enable extra storage
- name: es-archive.index-date-separator
default_value: '-'
usage: |
Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20".
- name: es-archive.index-prefix
usage: |
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
- name: es-archive.index-rollover-frequency-services
default_value: day
usage: |
Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es-archive.index-rollover-frequency-spans
default_value: day
usage: |
Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es-archive.log-level
default_value: error
usage: |
The Elasticsearch client log-level. Valid levels: [debug, info, error]
- name: es-archive.max-doc-count
default_value: "10000"
usage: |
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
- name: es-archive.num-replicas
default_value: "1"
usage: The number of replicas per index in Elasticsearch
- name: es-archive.num-shards
default_value: "5"
usage: The number of shards per index in Elasticsearch
- name: es-archive.password
usage: The password required by Elasticsearch
- name: es-archive.remote-read-clusters
usage: |
Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api.
- name: es-archive.send-get-body-as
usage: HTTP verb for requests that contain a body [GET, POST].
- name: es-archive.server-urls
default_value: http://127.0.0.1:9200
usage: |
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
- name: es-archive.sniffer
default_value: "false"
usage: |
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
- name: es-archive.sniffer-tls-enabled
default_value: "false"
usage: |
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
- name: es-archive.tags-as-fields.all
default_value: "false"
usage: |
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
- name: es-archive.tags-as-fields.config-file
usage: |
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
- name: es-archive.tags-as-fields.dot-replacement
default_value: '@'
usage: |
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
- name: es-archive.tags-as-fields.include
usage: |
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
- name: es-archive.timeout
default_value: 0s
usage: Timeout used for queries. A Timeout of zero means no timeout
- name: es-archive.tls.ca
usage: |
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
- name: es-archive.tls.cert
usage: |
Path to a TLS Certificate file, used to identify this process to the remote server(s)
- name: es-archive.tls.enabled
default_value: "false"
usage: Enable TLS when talking to the remote server(s)
- name: es-archive.tls.key
usage: |
Path to a TLS Private Key file, used to identify this process to the remote server(s)
- name: es-archive.tls.server-name
usage: |
Override the TLS server name we expect in the certificate of the remote server(s)
- name: es-archive.tls.skip-host-verify
default_value: "false"
usage: |
(insecure) Skip server's certificate chain and host name verification
- name: es-archive.token-file
usage: |
Path to a file containing bearer token. This flag also loads CA if it is specified.
- name: es-archive.use-aliases
default_value: "false"
usage: |
Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times.
- name: es-archive.use-ilm
default_value: "false"
usage: |
(experimental) Option to enable ILM for jaeger span & service indices. Use this option with es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+.
- name: es-archive.username
usage: |
The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
- name: es-archive.version
default_value: "0"
usage: |
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
- name: es.bulk.actions
default_value: "1000"
usage: |
The number of requests that can be enqueued before the bulk processor decides to commit
- name: es.bulk.flush-interval
default_value: 200ms
usage: |
A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled.
- name: es.bulk.size
default_value: "5000000"
usage: |
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
- name: es.bulk.workers
default_value: "1"
usage: |
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
- name: es.create-index-templates
default_value: "true"
usage: |
Create index templates at application startup. Set to false when templates are installed manually.
- name: es.index-date-separator
default_value: '-'
usage: |
Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20".
- name: es.index-prefix
usage: |
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
- name: es.index-rollover-frequency-services
default_value: day
usage: |
Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es.index-rollover-frequency-spans
default_value: day
usage: |
Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es.log-level
default_value: error
usage: |
The Elasticsearch client log-level. Valid levels: [debug, info, error]
- name: es.max-doc-count
default_value: "10000"
usage: |
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
- name: es.max-span-age
default_value: 72h0m0s
usage: The maximum lookback for spans in Elasticsearch
- name: es.num-replicas
default_value: "1"
usage: The number of replicas per index in Elasticsearch
- name: es.num-shards
default_value: "5"
usage: The number of shards per index in Elasticsearch
- name: es.password
usage: The password required by Elasticsearch
- name: es.remote-read-clusters
usage: |
Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api.
- name: es.send-get-body-as
usage: HTTP verb for requests that contain a body [GET, POST].
- name: es.server-urls
default_value: http://127.0.0.1:9200
usage: |
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
- name: es.sniffer
default_value: "false"
usage: |
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
- name: es.sniffer-tls-enabled
default_value: "false"
usage: |
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
- name: es.tags-as-fields.all
default_value: "false"
usage: |
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
- name: es.tags-as-fields.config-file
usage: |
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
- name: es.tags-as-fields.dot-replacement
default_value: '@'
usage: |
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
- name: es.tags-as-fields.include
usage: |
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
- name: es.timeout
default_value: 0s
usage: Timeout used for queries. A Timeout of zero means no timeout
- name: es.tls.ca
usage: |
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
- name: es.tls.cert
usage: |
Path to a TLS Certificate file, used to identify this process to the remote server(s)
- name: es.tls.enabled
default_value: "false"
usage: Enable TLS when talking to the remote server(s)
- name: es.tls.key
usage: |
Path to a TLS Private Key file, used to identify this process to the remote server(s)
- name: es.tls.server-name
usage: |
Override the TLS server name we expect in the certificate of the remote server(s)
- name: es.tls.skip-host-verify
default_value: "false"
usage: |
(insecure) Skip server's certificate chain and host name verification
- name: es.token-file
usage: |
Path to a file containing bearer token. This flag also loads CA if it is specified.
- name: es.use-aliases
default_value: "false"
usage: |
Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times.
- name: es.use-ilm
default_value: "false"
usage: |
(experimental) Option to enable ILM for jaeger span & service indices. Use this option with es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+.
- name: es.username
usage: |
The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
- name: es.version
default_value: "0"
usage: |
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
- name: help
shorthand: h
default_value: "false"
usage: help for jaeger-query
- name: log-level
default_value: info
usage: |
Minimal allowed log Level. For more levels see /~https://github.com/uber-go/zap
- name: metrics-backend
default_value: prometheus
usage: |
Defines which metrics backend to use for metrics reporting: expvar, prometheus, none
- name: metrics-http-route
default_value: /metrics
usage: |
Defines the route of HTTP endpoint for metrics backends that support scraping
- name: query.additional-headers
default_value: '[]'
usage: |
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
- name: query.base-path
default_value: /
usage: |
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
- name: query.bearer-token-propagation
default_value: "false"
usage: |
Allow propagation of bearer token to be used by storage plugins
- name: query.grpc-server.host-port
default_value: :16685
usage: |
The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server
- name: query.grpc.tls.cert
usage: |
Path to a TLS Certificate file, used to identify this server to clients
- name: query.grpc.tls.client-ca
usage: |
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
- name: query.grpc.tls.enabled
default_value: "false"
usage: Enable TLS on the server
- name: query.grpc.tls.key
usage: |
Path to a TLS Private Key file, used to identify this server to clients
- name: query.http-server.host-port
default_value: :16686
usage: |
The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server
- name: query.http.tls.cert
usage: |
Path to a TLS Certificate file, used to identify this server to clients
- name: query.http.tls.client-ca
usage: |
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
- name: query.http.tls.enabled
default_value: "false"
usage: Enable TLS on the server
- name: query.http.tls.key
usage: |
Path to a TLS Private Key file, used to identify this server to clients
- name: query.max-clock-skew-adjustment
default_value: 0s
usage: |
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
- name: query.static-files
usage: The directory path override for the static assets for the UI
- name: query.ui-config
usage: The path to the UI configuration file in JSON format
- name: span-storage.type
usage: |
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.
see_also:
- completion - generate the autocompletion script for the specified shell
- docs - Generates documentation
- env - Help about environment variables.
- status - Print the status.
- version - Print the version.