Usage of /usr/bin/loki-canary:
-addr string
The Loki server URL:Port, e.g. loki:3100
-buckets int
Number of buckets in the response_latency histogram (default 10)
-ca-file string
Client certificate authority for optional use with TLS connection to Loki
-cache-test-interval duration
The interval the cache test query should be run (default 15m0s)
-cache-test-now duration
duration how far back from current time the execution time (--now) should be set for running this query in the cache test instant-query. (default 1h0m0s)
-cache-test-range duration
The range value [24h] used in the cache test instant-query. (default 24h0m0s)
-cert-file string
Client PEM encoded X.509 certificate for optional use with TLS connection to Loki
-insecure
Allow insecure TLS connections
-interval duration
Duration between log entries (default 1s)
-key-file string
Client PEM encoded X.509 key for optional use with TLS connection to Loki
-labelname string
The label name for this instance of loki-canary to use in the log selector (default "name")
-labelvalue string
The unique label value for this instance of loki-canary to use in the log selector (default "loki-canary")
-logs-batch-size int
Send logs to Loki in batches of a specified size. Must be a non-negative value (0 or 1 will disable batching) (default 1)
-logs-batch-size-max int
Upper bound on -logs-batch-size. Only increase this value if you have increased memory limits for the canary pods (default 20)
-max-wait duration
Duration to keep querying Loki for missing websocket entries before reporting them missing (default 5m0s)
-metric-test-interval duration
The interval the metric test query should be run (default 1h0m0s)
-metric-test-range duration
The range value [24h] used in the metric test instant-query. Note: this value is truncated to the running time of the canary until this value is reached (default 24h0m0s)
-out-of-order-max duration
Maximum amount of time to go back for out of order entries (in seconds). (default 1m0s)
-out-of-order-min duration
Minimum amount of time to go back for out of order entries (in seconds). (default 30s)
-out-of-order-percentage int
Percentage (0-100) of log entries that should be sent out of order.
-pass string
Loki password. This credential should have both read and write permissions to Loki endpoints
-port int
Port which loki-canary should expose metrics (default 3500)
-pruneinterval duration
Frequency to check sent vs received logs, also the frequency which queries for missing logs will be dispatched to loki (default 1m0s)
-push
Push the logs directly to given Loki address
-query-append {{.log}}
LogQL filters to be appended to the Canary query e.g. '| json | line_format {{.log}}'
-query-timeout duration
How long to wait for a query response from Loki (default 10s)
-size int
Size in bytes of each log line (default 100)
-spot-check-initial-wait duration
How long should the spot check query wait before starting to check for entries (default 10s)
-spot-check-interval duration
Interval that a single result will be kept from sent entries and spot-checked against Loki, e.g. 15min default one entry every 15 min will be saved and then queried again every 15min until spot-check-max is reached (default 15m0s)
-spot-check-max duration
How far back to check a spot check entry before dropping it (default 4h0m0s)
-spot-check-query-rate duration
Interval that the canary will query Loki for the current list of all spot check entries (default 1m0s)
-streamname string
The stream name for this instance of loki-canary to use in the log selector (default "stream")
-streamvalue string
The unique stream value for this instance of loki-canary to use in the log selector (default "stdout")
-tenant-id string
Tenant ID to be set in X-Scope-OrgID header.
-tls
Does the loki connection use TLS?
-user string
Loki username.
-version
Print this builds version information
-wait duration
Duration to wait for log entries on websocket before querying loki for them (default 1m0s)
-write-max-backoff duration
Maximum backoff time between retries (default 5m0s)
-write-max-retries int
Maximum number of retries when push a log entry (default 10)
-write-min-backoff duration
Initial backoff time before first retry (default 500ms)
-write-timeout duration
How long to wait write response from Loki (default 10s)
Options (42)
| Option | Description | Source |
|---|---|---|
-addr string | The Loki server URL:Port, e.g. loki:3100 | help |
-buckets int | Number of buckets in the response_latency histogram (default 10) | help |
-ca-file string | Client certificate authority for optional use with TLS connection to Loki | help |
-cache-test-interval duration | The interval the cache test query should be run (default 15m0s) | help |
-cache-test-now duration | duration how far back from current time the execution time (--now) should be set for running this query in the cache test instant-query. | help |
-cache-test-range duration | The range value [24h] used in the cache test instant-query. | help |
-cert-file string | Client PEM encoded X.509 certificate for optional use with TLS connection to Loki | help |
-insecure | Allow insecure TLS connections | help |
-interval duration | Duration between log entries (default 1s) | help |
-key-file string | Client PEM encoded X.509 key for optional use with TLS connection to Loki | help |
-labelname string | The label name for this instance of loki-canary to use in the log selector (default "name") | help |
-labelvalue string | The unique label value for this instance of loki-canary to use in the log selector (default "loki-canary") | help |
-logs-batch-size int | Send logs to Loki in batches of a specified size. | help |
-logs-batch-size-max int | Upper bound on -logs-batch-size. | help |
-max-wait duration | Duration to keep querying Loki for missing websocket entries before reporting them missing (default 5m0s) | help |
-metric-test-interval duration | The interval the metric test query should be run (default 1h0m0s) | help |
-metric-test-range duration | The range value [24h] used in the metric test instant-query. | help |
-out-of-order-max duration | Maximum amount of time to go back for out of order entries (in seconds). | help |
-out-of-order-min duration | Minimum amount of time to go back for out of order entries (in seconds). | help |
-out-of-order-percentage int | Percentage (0-100) of log entries that should be sent out of order. | help |
-pass string | Loki password. | help |
-port int | Port which loki-canary should expose metrics (default 3500) | help |
-pruneinterval duration | Frequency to check sent vs received logs, also the frequency which queries for missing logs will be dispatched to loki (default 1m0s) | help |
-push | Push the logs directly to given Loki address | help |
-query-append .log | LogQL filters to be appended to the Canary query e.g. '| json | line_format {{.log}}' | help |
-query-timeout duration | How long to wait for a query response from Loki (default 10s) | help |
-size int | Size in bytes of each log line (default 100) | help |
-spot-check-initial-wait duration | How long should the spot check query wait before starting to check for entries (default 10s) | help |
-spot-check-interval duration | Interval that a single result will be kept from sent entries and spot-checked against Loki, e.g. 15min default one entry every 15 min will be saved and then queried again every 15min until… | help |
-spot-check-max duration | How far back to check a spot check entry before dropping it (default 4h0m0s) | help |
-spot-check-query-rate duration | Interval that the canary will query Loki for the current list of all spot check entries (default 1m0s) | help |
-streamname string | The stream name for this instance of loki-canary to use in the log selector (default "stream") | help |
-streamvalue string | The unique stream value for this instance of loki-canary to use in the log selector (default "stdout") | help |
-tenant-id string | Tenant ID to be set in X-Scope-OrgID header. | help |
-tls | Does the loki connection use TLS? | help |
-user string | Loki username. | help |
-version | Print this builds version information | help |
-wait duration | Duration to wait for log entries on websocket before querying loki for them (default 1m0s) | help |
-write-max-backoff duration | Maximum backoff time between retries (default 5m0s) | help |
-write-max-retries int | Maximum number of retries when push a log entry (default 10) | help |
-write-min-backoff duration | Initial backoff time before first retry (default 500ms) | help |
-write-timeout duration | How long to wait write response from Loki (default 10s) | help |