You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* chore: upgrade dskit
* Fix tests
* Bump prometheus as well
* Make change more consistent
* Add go build flag to a few more places
* Remove build tag, cleanup dependencies
* Tidy up some more
* Add route injector middleware
* Add missing route matcher
* Fix flaky test
* Bump again after rebase
Copy file name to clipboardExpand all lines: cmd/pyroscope/help-all.txt.tmpl
+54-2Lines changed: 54 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -335,8 +335,12 @@ Usage of ./pyroscope:
335
335
Output log messages in the given format. Valid formats: [logfmt, json] (default "logfmt")
336
336
-log.level value
337
337
Only log messages with the given severity or above. Valid levels: [debug, info, warn, error] (default info)
338
+
-memberlist.abort-if-fast-join-fails
339
+
Abort if this node fails the fast memberlist cluster joining procedure at startup. When enabled, it's guaranteed that other services, depending on memberlist, have an updated view over the cluster state when they're started.
338
340
-memberlist.abort-if-join-fails
339
-
If this node fails to join memberlist cluster, abort.
341
+
Abort if this node fails to join memberlist cluster at startup. When enabled, it's not guaranteed that other services are started only after the cluster state has been successfully updated; use 'abort-if-fast-join-fails' instead.
342
+
-memberlist.acquire-writer-timeout duration
343
+
Timeout for acquiring one of the concurrent write slots. After this time, the message will be dropped. (default 250ms)
340
344
-memberlist.advertise-addr string
341
345
Gossip address to advertise to other members in the cluster. Used for NAT traversal.
342
346
-memberlist.advertise-port int
@@ -345,6 +349,8 @@ Usage of ./pyroscope:
345
349
IP address to listen on for gossip messages. Multiple addresses may be specified. Defaults to 0.0.0.0
346
350
-memberlist.bind-port int
347
351
Port to listen on for gossip messages. (default 7946)
Timeout for broadcasting all remaining locally-generated updates to other nodes when shutting down. Only used if there are nodes left in the memberlist cluster, and only applies to locally-generated updates, not to broadcast messages that are result of incoming gossip updates. 0 = no timeout, wait until all locally-generated updates are sent. (default 10s)
348
354
-memberlist.cluster-label string
349
355
The cluster label is an optional string to include in outbound packets and gossip streams. Other members in the memberlist cluster will discard any message whose label doesn't match the configured one, unless the 'cluster-label-verification-disabled' configuration option is set to true.
350
356
-memberlist.cluster-label-verification-disabled
@@ -365,6 +371,8 @@ Usage of ./pyroscope:
365
371
Timeout for leaving memberlist cluster. (default 20s)
366
372
-memberlist.left-ingesters-timeout duration
367
373
How long to keep LEFT ingesters in the ring. (default 5m0s)
374
+
-memberlist.max-concurrent-writes int
375
+
Maximum number of concurrent writes to other nodes. (default 3)
368
376
-memberlist.max-join-backoff duration
369
377
Max backoff duration to join other cluster members. (default 1m0s)
370
378
-memberlist.max-join-retries int
@@ -375,6 +383,10 @@ Usage of ./pyroscope:
375
383
Min backoff duration to join other cluster members. (default 1s)
376
384
-memberlist.nodename string
377
385
Name of the node in memberlist cluster. Defaults to hostname.
386
+
-memberlist.notify-interval duration
387
+
How frequently to notify watchers when a key changes. Can reduce CPU activity in large memberlist deployments. 0 to notify without delay.
388
+
-memberlist.obsolete-entries-timeout duration
389
+
[experimental] How long to keep obsolete entries in the KV store. (default 30s)
378
390
-memberlist.packet-dial-timeout duration
379
391
Timeout used when connecting to other nodes to send packet. (default 2s)
380
392
-memberlist.packet-write-timeout duration
@@ -388,7 +400,7 @@ Usage of ./pyroscope:
388
400
-memberlist.retransmit-factor int
389
401
Multiplication factor used when sending out messages (factor * log(N+1)). (default 4)
390
402
-memberlist.stream-timeout duration
391
-
The timeout for establishing a connection with a remote node, and for read/write operations. (default 10s)
403
+
The timeout for establishing a connection with a remote node, and for read/write operations. (default 2s)
392
404
-memberlist.tls-ca-path string
393
405
Path to the CA certificates to validate server certificate against. If not set, the host's root CA certificates are used.
394
406
-memberlist.tls-cert-path string
@@ -407,6 +419,8 @@ Usage of ./pyroscope:
407
419
Override the expected name on the server certificate.
408
420
-memberlist.transport-debug
409
421
Log debug transport messages. Note: global log.level must be at debug level as well.
422
+
-memberlist.watch-prefix-buffer-size int
423
+
Size of the buffered channel for the WatchPrefix function. (default 128)
410
424
-modules
411
425
List available modules that can be used as target and exit.
412
426
-multi.mirror-enabled
@@ -513,6 +527,8 @@ Usage of ./pyroscope:
513
527
Enable backoff and retry when we hit rate limits.
514
528
-querier.frontend-client.backoff-retries int
515
529
Number of times to backoff and retry before failing. (default 10)
Read k6 labels from request headers and set them as dynamic profile tags.
788
+
-server.cluster-validation.grpc.enabled
789
+
[experimental] When enabled, cluster label validation is executed: configured cluster validation label is compared with the cluster validation label received through the requests.
790
+
-server.cluster-validation.grpc.soft-validation
791
+
[experimental] When enabled, soft cluster label validation is executed. Can be enabled only together with server.cluster-validation.grpc.enabled
792
+
-server.cluster-validation.http.enabled
793
+
[experimental] When enabled, cluster label validation is executed: configured cluster validation label is compared with the cluster validation label received through the requests.
[experimental] Comma-separated list of user agents that are excluded from the cluster validation check.
798
+
-server.cluster-validation.http.soft-validation
799
+
[experimental] When enabled, soft cluster label validation is executed. Can be enabled only together with server.cluster-validation.http.enabled
800
+
-server.cluster-validation.label string
801
+
[experimental] Optionally define the cluster validation label.
768
802
-server.graceful-shutdown-timeout duration
769
803
Timeout for graceful shutdowns (default 30s)
804
+
-server.grpc-collect-max-streams-by-conn
805
+
If true, the max streams by connection gauge will be collected. (default true)
770
806
-server.grpc-conn-limit int
771
807
Maximum number of simultaneous grpc connections, <=0 to disable
772
808
-server.grpc-listen-address string
@@ -805,6 +841,10 @@ Usage of ./pyroscope:
805
841
After having pinged for keepalive check, the duration after which an idle connection should be closed, Default: 20s (default 20s)
806
842
-server.grpc.num-workers int
807
843
If non-zero, configures the amount of GRPC server workers used to serve the requests.
844
+
-server.grpc.recv-buffer-pools-enabled
845
+
Deprecated option, has no effect and will be removed in a future version.
846
+
-server.grpc.stats-tracking-enabled
847
+
If true, the request_message_bytes, response_message_bytes, and inflight_requests metrics will be tracked. Enabling this option prevents the use of memory pools for parsing gRPC request bodies and may lead to more memory allocations. (default true)
808
848
-server.http-conn-limit int
809
849
Maximum number of simultaneous http connections, <=0 to disable
810
850
-server.http-idle-timeout duration
@@ -839,20 +879,32 @@ Usage of ./pyroscope:
839
879
Comma separated list of headers to exclude from loggin. Only used if server.log-request-headers is true.
840
880
-server.log-source-ips-enabled
841
881
Optionally log the source IPs.
882
+
-server.log-source-ips-full
883
+
Log all source IPs instead of only the originating one. Only used if server.log-source-ips-enabled is true
842
884
-server.log-source-ips-header string
843
885
Header field storing the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used
844
886
-server.log-source-ips-regex string
845
887
Regex for matching the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used
846
888
-server.path-prefix string
847
889
Base path to serve all API routes from (e.g. /v1/)
890
+
-server.proxy-protocol-enabled
891
+
Enables PROXY protocol.
848
892
-server.register-instrumentation
849
893
Register the intrumentation handlers (/metrics etc). (default true)
If set to true, gRPC statuses will be reported in instrumentation labels with their string representations. Otherwise, they will be reported as "error".
896
+
-server.throughput.latency-cutoff duration
897
+
Requests taking over the cutoff are be observed to measure throughput. Server-Timing header is used with specified unit as the indicator, for example 'Server-Timing: unit;val=8.2'. If set to 0, the throughput is not calculated.
898
+
-server.throughput.unit string
899
+
Unit of the server throughput metric, for example 'processed_bytes' or 'samples_processed'. Observed values are gathered from the 'Server-Timing' header with the 'val' key. If set, it is appended to the request_server_throughput metric name. (default "samples_processed")
852
900
-server.tls-cipher-suites string
853
901
Comma-separated list of cipher suites to use. If blank, the default Go cipher suites is used.
854
902
-server.tls-min-version string
855
903
Minimum TLS version to use. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. If blank, the Go TLS minimum version is used.
904
+
-server.trace-request-headers
905
+
Optionally add request headers to tracing spans.
906
+
-server.trace-request-headers-exclude-list string
907
+
Comma separated list of headers to exclude from tracing spans. Only used if server.trace-request-headers is true. The following headers are always excluded: Authorization, Cookie, X-Csrf-Token.
856
908
-shutdown-delay duration
857
909
Wait time before shutting down after a termination signal.
Copy file name to clipboardExpand all lines: cmd/pyroscope/help.txt.tmpl
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ Usage of ./pyroscope:
110
110
-log.level value
111
111
Only log messages with the given severity or above. Valid levels: [debug, info, warn, error] (default info)
112
112
-memberlist.abort-if-join-fails
113
-
If this node fails to join memberlist cluster, abort.
113
+
Abort if this node fails to join memberlist cluster at startup. When enabled, it's not guaranteed that other services are started only after the cluster state has been successfully updated; use 'abort-if-fast-join-fails' instead.
114
114
-memberlist.advertise-addr string
115
115
Gossip address to advertise to other members in the cluster. Used for NAT traversal.
116
116
-memberlist.advertise-port int
@@ -201,6 +201,8 @@ Usage of ./pyroscope:
201
201
Read k6 labels from request headers and set them as dynamic profile tags.
202
202
-server.graceful-shutdown-timeout duration
203
203
Timeout for graceful shutdowns (default 30s)
204
+
-server.grpc-collect-max-streams-by-conn
205
+
If true, the max streams by connection gauge will be collected. (default true)
204
206
-server.grpc-conn-limit int
205
207
Maximum number of simultaneous grpc connections, <=0 to disable
206
208
-server.grpc-listen-address string
@@ -239,6 +241,10 @@ Usage of ./pyroscope:
239
241
After having pinged for keepalive check, the duration after which an idle connection should be closed, Default: 20s (default 20s)
240
242
-server.grpc.num-workers int
241
243
If non-zero, configures the amount of GRPC server workers used to serve the requests.
244
+
-server.grpc.recv-buffer-pools-enabled
245
+
Deprecated option, has no effect and will be removed in a future version.
246
+
-server.grpc.stats-tracking-enabled
247
+
If true, the request_message_bytes, response_message_bytes, and inflight_requests metrics will be tracked. Enabling this option prevents the use of memory pools for parsing gRPC request bodies and may lead to more memory allocations. (default true)
242
248
-server.http-conn-limit int
243
249
Maximum number of simultaneous http connections, <=0 to disable
244
250
-server.http-idle-timeout duration
@@ -273,20 +279,32 @@ Usage of ./pyroscope:
273
279
Comma separated list of headers to exclude from loggin. Only used if server.log-request-headers is true.
274
280
-server.log-source-ips-enabled
275
281
Optionally log the source IPs.
282
+
-server.log-source-ips-full
283
+
Log all source IPs instead of only the originating one. Only used if server.log-source-ips-enabled is true
276
284
-server.log-source-ips-header string
277
285
Header field storing the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used
278
286
-server.log-source-ips-regex string
279
287
Regex for matching the source IPs. Only used if server.log-source-ips-enabled is true. If not set the default Forwarded, X-Real-IP and X-Forwarded-For headers are used
280
288
-server.path-prefix string
281
289
Base path to serve all API routes from (e.g. /v1/)
290
+
-server.proxy-protocol-enabled
291
+
Enables PROXY protocol.
282
292
-server.register-instrumentation
283
293
Register the intrumentation handlers (/metrics etc). (default true)
If set to true, gRPC statuses will be reported in instrumentation labels with their string representations. Otherwise, they will be reported as "error".
296
+
-server.throughput.latency-cutoff duration
297
+
Requests taking over the cutoff are be observed to measure throughput. Server-Timing header is used with specified unit as the indicator, for example 'Server-Timing: unit;val=8.2'. If set to 0, the throughput is not calculated.
298
+
-server.throughput.unit string
299
+
Unit of the server throughput metric, for example 'processed_bytes' or 'samples_processed'. Observed values are gathered from the 'Server-Timing' header with the 'val' key. If set, it is appended to the request_server_throughput metric name. (default "samples_processed")
286
300
-server.tls-cipher-suites string
287
301
Comma-separated list of cipher suites to use. If blank, the default Go cipher suites is used.
288
302
-server.tls-min-version string
289
303
Minimum TLS version to use. Allowed values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13. If blank, the Go TLS minimum version is used.
304
+
-server.trace-request-headers
305
+
Optionally add request headers to tracing spans.
306
+
-server.trace-request-headers-exclude-list string
307
+
Comma separated list of headers to exclude from tracing spans. Only used if server.trace-request-headers is true. The following headers are always excluded: Authorization, Cookie, X-Csrf-Token.
290
308
-shutdown-delay duration
291
309
Wait time before shutting down after a termination signal.
0 commit comments