@@ -95,147 +95,149 @@ usage: thanos sidecar [<flags>]
95
95
96
96
Sidecar for Prometheus server.
97
97
98
+
98
99
Flags:
100
+ -h, --[no-]help Show context-sensitive help (also try
101
+ --help-long and --help-man).
102
+ --[no-]version Show application version.
103
+ --log.level=info Log filtering level.
104
+ --log.format=logfmt Log format to use. Possible options: logfmt or
105
+ json.
106
+ --tracing.config-file=<file-path>
107
+ Path to YAML file with tracing
108
+ configuration. See format details:
109
+ https://thanos.io/tip/thanos/tracing.md/#configuration
110
+ --tracing.config=<content>
111
+ Alternative to 'tracing.config-file' flag
112
+ (mutually exclusive). Content of YAML file
113
+ with tracing configuration. See format details:
114
+ https://thanos.io/tip/thanos/tracing.md/#configuration
115
+ --[no-]enable-auto-gomemlimit
116
+ Enable go runtime to automatically limit memory
117
+ consumption.
99
118
--auto-gomemlimit.ratio=0.9
100
119
The ratio of reserved GOMEMLIMIT memory to the
101
120
detected maximum container or system memory.
102
- --enable-auto-gomemlimit Enable go runtime to automatically limit memory
103
- consumption.
121
+ --http-address="0.0.0.0:10902"
122
+ Listen host:port for HTTP endpoints.
123
+ --http-grace-period=2m Time to wait after an interrupt received for
124
+ HTTP Server.
125
+ --http.config="" [EXPERIMENTAL] Path to the configuration file
126
+ that can enable TLS or authentication for all
127
+ HTTP endpoints.
104
128
--grpc-address="0.0.0.0:10901"
105
129
Listen ip:port address for gRPC endpoints
106
130
(StoreAPI). Make sure this address is routable
107
131
from other components.
108
- --grpc-grace-period=2m Time to wait after an interrupt received for
109
- GRPC Server.
110
- --grpc-server-max-connection-age=60m
111
- The grpc server max connection age. This
112
- controls how often to re-establish connections
113
- and redo TLS handshakes.
114
132
--grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to
115
133
disable TLS
134
+ --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
135
+ disable TLS
116
136
--grpc-server-tls-client-ca=""
117
137
TLS CA to verify clients against. If no
118
138
client CA is specified, there is no client
119
139
verification on server side. (tls.NoClientCert)
120
- --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
121
- disable TLS
122
140
--grpc-server-tls-min-version="1.3"
123
141
TLS supported minimum version for gRPC server.
124
142
If no version is specified, it'll default to
125
143
1.3. Allowed values: ["1.0", "1.1", "1.2",
126
144
"1.3"]
127
- --hash-func= Specify which hash function to use when
128
- calculating the hashes of produced files.
129
- If no function has been specified, it does not
130
- happen. This permits avoiding downloading some
131
- files twice albeit at some performance cost.
132
- Possible values are: "", "SHA256".
133
- -h, --help Show context-sensitive help (also try
134
- --help-long and --help-man).
135
- --http-address="0.0.0.0:10902"
136
- Listen host:port for HTTP endpoints.
137
- --http-grace-period=2m Time to wait after an interrupt received for
138
- HTTP Server.
139
- --http.config="" [EXPERIMENTAL] Path to the configuration file
140
- that can enable TLS or authentication for all
141
- HTTP endpoints.
142
- --log.format=logfmt Log format to use. Possible options: logfmt or
143
- json.
144
- --log.level=info Log filtering level.
145
- --min-time=0000-01-01T00:00:00Z
146
- Start of time range limit to serve. Thanos
147
- sidecar will serve only metrics, which happened
148
- later than this value. Option can be a constant
149
- time in RFC3339 format or time duration
150
- relative to current time, such as -1d or 2h45m.
151
- Valid duration units are ms, s, m, h, d, w, y.
152
- --objstore.config=<content>
153
- Alternative to 'objstore.config-file'
154
- flag (mutually exclusive). Content of
155
- YAML file that contains object store
156
- configuration. See format details:
157
- https://thanos.io/tip/thanos/storage.md/#configuration
158
- --objstore.config-file=<file-path>
159
- Path to YAML file that contains object
160
- store configuration. See format details:
161
- https://thanos.io/tip/thanos/storage.md/#configuration
145
+ --grpc-server-max-connection-age=60m
146
+ The grpc server max connection age. This
147
+ controls how often to re-establish connections
148
+ and redo TLS handshakes.
149
+ --grpc-grace-period=2m Time to wait after an interrupt received for
150
+ GRPC Server.
151
+ --prometheus.url=http://localhost:9090
152
+ URL at which to reach Prometheus's API.
153
+ For better performance use local network.
154
+ --prometheus.ready_timeout=10m
155
+ Maximum time to wait for the Prometheus
156
+ instance to start up
162
157
--prometheus.get_config_interval=30s
163
158
How often to get Prometheus config
164
159
--prometheus.get_config_timeout=30s
165
160
Timeout for getting Prometheus config
161
+ --prometheus.http-client-file=<file-path>
162
+ Path to YAML file or string with http
163
+ client configs. See Format details:
164
+ https://thanos.io/tip/components/sidecar.md/#configuration.
166
165
--prometheus.http-client=<content>
167
166
Alternative to 'prometheus.http-client-file'
168
167
flag (mutually exclusive). Content
169
168
of YAML file or string with http
170
169
client configs. See Format details:
171
170
https://thanos.io/tip/components/sidecar.md/#configuration.
172
- --prometheus.http-client-file=<file-path>
173
- Path to YAML file or string with http
174
- client configs. See Format details:
175
- https://thanos.io/tip/components/sidecar.md/#configuration.
176
- --prometheus.ready_timeout=10m
177
- Maximum time to wait for the Prometheus
178
- instance to start up
179
- --prometheus.url=http://localhost:9090
180
- URL at which to reach Prometheus's API.
181
- For better performance use local network.
171
+ --tsdb.path="./data" Data directory of TSDB.
172
+ --reloader.config-file="" Config file watched by the reloader.
182
173
--reloader.config-envsubst-file=""
183
174
Output file for environment variable
184
175
substituted config file.
185
- --reloader.config-file="" Config file watched by the reloader.
186
- --reloader.method=http Method used to reload the configuration.
187
- --reloader.process-name="prometheus"
188
- Executable name used to match the process being
189
- reloaded when using the signal method.
190
- --reloader.retry-interval=5s
191
- Controls how often reloader retries config
192
- reload in case of error.
193
176
--reloader.rule-dir=RELOADER.RULE-DIR ...
194
177
Rule directories for the reloader to refresh
195
178
(repeated field).
196
179
--reloader.watch-interval=3m
197
180
Controls how often reloader re-reads config and
198
181
rules.
182
+ --reloader.retry-interval=5s
183
+ Controls how often reloader retries config
184
+ reload in case of error.
185
+ --reloader.method=http Method used to reload the configuration.
186
+ --reloader.process-name="prometheus"
187
+ Executable name used to match the process being
188
+ reloaded when using the signal method.
189
+ --request.logging-config-file=<file-path>
190
+ Path to YAML file with request logging
191
+ configuration. See format details:
192
+ https://thanos.io/tip/thanos/logging.md/#configuration
199
193
--request.logging-config=<content>
200
194
Alternative to 'request.logging-config-file'
201
195
flag (mutually exclusive). Content
202
196
of YAML file with request logging
203
197
configuration. See format details:
204
198
https://thanos.io/tip/thanos/logging.md/#configuration
205
- --request.logging-config-file=<file-path>
206
- Path to YAML file with request logging
199
+ --objstore.config-file=<file-path>
200
+ Path to YAML file that contains object
201
+ store configuration. See format details:
202
+ https://thanos.io/tip/thanos/storage.md/#configuration
203
+ --objstore.config=<content>
204
+ Alternative to 'objstore.config-file'
205
+ flag (mutually exclusive). Content of
206
+ YAML file that contains object store
207
207
configuration. See format details:
208
- https://thanos.io/tip/thanos/logging.md/#configuration
209
- --shipper.meta-file-name="thanos.shipper.json"
210
- the file to store shipper metadata in
211
- --shipper.upload-compacted
208
+ https://thanos.io/tip/thanos/storage.md/#configuration
209
+ --[no-]shipper.upload-compacted
212
210
If true shipper will try to upload compacted
213
211
blocks as well. Useful for migration purposes.
214
212
Works only if compaction is disabled on
215
213
Prometheus. Do it once and then disable the
216
214
flag when done.
215
+ --hash-func= Specify which hash function to use when
216
+ calculating the hashes of produced files.
217
+ If no function has been specified, it does not
218
+ happen. This permits avoiding downloading some
219
+ files twice albeit at some performance cost.
220
+ Possible values are: "", "SHA256".
221
+ --shipper.meta-file-name="thanos.shipper.json"
222
+ the file to store shipper metadata in
223
+ --store.limits.request-series=0
224
+ The maximum series allowed for a single Series
225
+ request. The Series call fails if this limit is
226
+ exceeded. 0 means no limit.
217
227
--store.limits.request-samples=0
218
228
The maximum samples allowed for a single
219
229
Series request, The Series call fails if
220
230
this limit is exceeded. 0 means no limit.
221
231
NOTE: For efficiency the limit is internally
222
232
implemented as 'chunks limit' considering each
223
233
chunk contains a maximum of 120 samples.
224
- --store.limits.request-series=0
225
- The maximum series allowed for a single Series
226
- request. The Series call fails if this limit is
227
- exceeded. 0 means no limit.
228
- --tracing.config=<content>
229
- Alternative to 'tracing.config-file' flag
230
- (mutually exclusive). Content of YAML file
231
- with tracing configuration. See format details:
232
- https://thanos.io/tip/thanos/tracing.md/#configuration
233
- --tracing.config-file=<file-path>
234
- Path to YAML file with tracing
235
- configuration. See format details:
236
- https://thanos.io/tip/thanos/tracing.md/#configuration
237
- --tsdb.path="./data" Data directory of TSDB.
238
- --version Show application version.
234
+ --min-time=0000-01-01T00:00:00Z
235
+ Start of time range limit to serve. Thanos
236
+ sidecar will serve only metrics, which happened
237
+ later than this value. Option can be a constant
238
+ time in RFC3339 format or time duration
239
+ relative to current time, such as -1d or 2h45m.
240
+ Valid duration units are ms, s, m, h, d, w, y.
239
241
240
242
```
241
243
0 commit comments