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
Copy file name to clipboardExpand all lines: docs/victoriatraces/README.md
+25-10Lines changed: 25 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -352,13 +352,16 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
352
352
Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
353
353
-flagsAuthKey value
354
354
Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
355
-
Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
355
+
Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file.
356
+
Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
356
357
-forceFlushAuthKey value
357
358
authKey, which must be passed in query string to /internal/force_flush . It overrides -httpAuth.*. See https://docs.victoriametrics.com/victoriatraces/#forced-flush
358
-
Flag value can be read from the given file when using -forceFlushAuthKey=file:///abs/path/to/file or -forceFlushAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -forceFlushAuthKey=http://host/path or -forceFlushAuthKey=https://host/path
359
+
Flag value can be read from the given file when using -forceFlushAuthKey=file:///abs/path/to/file or -forceFlushAuthKey=file://./relative/path/to/file.
360
+
Flag value can be read from the given http/https url when using -forceFlushAuthKey=http://host/path or -forceFlushAuthKey=https://host/path
359
361
-forceMergeAuthKey value
360
362
authKey, which must be passed in query string to /internal/force_merge . It overrides -httpAuth.*. See https://docs.victoriametrics.com/victoriatraces/#forced-merge
361
-
Flag value can be read from the given file when using -forceMergeAuthKey=file:///abs/path/to/file or -forceMergeAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -forceMergeAuthKey=http://host/path or -forceMergeAuthKey=https://host/path
363
+
Flag value can be read from the given file when using -forceMergeAuthKey=file:///abs/path/to/file or -forceMergeAuthKey=file://./relative/path/to/file.
364
+
Flag value can be read from the given http/https url when using -forceMergeAuthKey=http://host/path or -forceMergeAuthKey=https://host/path
362
365
-fs.disableMmap
363
366
Whether to use pread() instead of mmap() forreading data files. By default, mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytesin memory. mmap() is usually faster for reading small data chunks than pread()
364
367
-futureRetention value
@@ -388,7 +391,8 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
388
391
Optional delay before http server shutdown. During this delay, the server returns non-OK responses from /health page, so load balancers can route new requests to other servers
389
392
-httpAuth.password value
390
393
Password for HTTP server's Basic Auth. The authentication is disabled if -httpAuth.username is empty
391
-
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
394
+
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file.
395
+
Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
392
396
-httpAuth.username string
393
397
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
394
398
-httpListenAddr array
@@ -418,14 +422,14 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
418
422
-internStringMaxLen int
419
423
The maximum length for strings to intern. A lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500)
420
424
-internalinsert.disable
421
-
Whether to disable /internal/insert HTTP endpoint
425
+
Whether to disable /internal/insert HTTP endpoint. See https://docs.victoriametrics.com/victoriatraces/cluster/#security
422
426
-internalinsert.maxRequestSize size
423
427
The maximum size in bytes of a single request, which can be accepted at /internal/insert HTTP endpoint
424
428
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864)
425
429
-internalselect.disable
426
430
Whether to disable /internal/select/* HTTP endpoints
427
431
-logIngestedRows
428
-
Whether to log all the ingested log entries; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victoriatraces/data-ingestion/ ; see also -logNewStreams
432
+
Whether to log all the ingested trace spans; this can be useful for debugging of data ingestion; see https://docs.victoriametrics.com/victoriatraces/data-ingestion/ ; see also -logNewStreams
429
433
-logNewStreams
430
434
Whether to log creation of new streams; this can be useful for debugging of high cardinality issues with log streams; see https://docs.victoriametrics.com/victoriatraces/keyconcepts/#stream-fields ; see also -logIngestedRows
431
435
-loggerDisableTimestamps
@@ -457,13 +461,19 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
457
461
Whether to expose TYPE and HELP metadata at the /metrics page, which is exposed at -httpListenAddr . The metadata may be needed when the /metrics page is consumed by systems, which require this information. For example, Managed Prometheus in Google Cloud - https://cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting#missing-metric-type
458
462
-metricsAuthKey value
459
463
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
460
-
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
464
+
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file.
465
+
Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
461
466
-opentelemetry.traces.maxRequestSize size
462
467
The maximum size in bytes of a single OpenTelemetry trace export request.
463
468
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 67108864)
469
+
-partitionManageAuthKey value
470
+
authKey, which must be passed in query string to /internal/partition/* . It overrides -httpAuth.* . See https://docs.victoriametrics.com/victoriatraces/#partitions-lifecycle
471
+
Flag value can be read from the given file when using -partitionManageAuthKey=file:///abs/path/to/file or -partitionManageAuthKey=file://./relative/path/to/file.
472
+
Flag value can be read from the given http/https url when using -partitionManageAuthKey=http://host/path or -partitionManageAuthKey=https://host/path
464
473
-pprofAuthKey value
465
474
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides -httpAuth.*
466
-
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
475
+
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file.
476
+
Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
467
477
-pushmetrics.disableCompression
468
478
Whether to disable request body compression when pushing metrics to every -pushmetrics.url
469
479
-pushmetrics.extraLabel array
@@ -483,13 +493,18 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
483
493
-retention.maxDiskSpaceUsageBytes size
484
494
The maximum disk space usage at -storageDataPath before older per-day partitions are automatically dropped; see https://docs.victoriametrics.com/victoriatraces/#retention-by-disk-space-usage ; see also -retentionPeriod
485
495
Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
496
+
-retention.maxDiskUsagePercent int
497
+
The maximum allowed disk usage percentage (1-100) for the filesystem that contains -storageDataPath before older per-day partitions are automatically dropped; mutually exclusive with -retention.maxDiskSpaceUsageBytes; see https://docs.victoriametrics.com/victoriatraces/#retention-by-disk-space-usage-percent
486
498
-retentionPeriod value
487
-
Log entries with timestamps older than now-retentionPeriod are automatically deleted;log entries with timestamps outside the retention are also rejected during data ingestion; the minimum supported retention is 1d (one day); see https://docs.victoriametrics.com/victoriatraces/#retention ; see also -retention.maxDiskSpaceUsageBytes
499
+
Trace spans with timestamps older than now-retentionPeriod are automatically deleted;trace spans with timestamps outside the retention are also rejected during data ingestion; the minimum supported retention is 1d (one day); see https://docs.victoriametrics.com/victoriatraces/#retention ; see also -retention.maxDiskSpaceUsageBytes and -retention.maxDiskUsagePercent
488
500
The following optional suffixes are supported: s (second), h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months (default 7d)
489
501
-search.maxConcurrentRequests int
490
502
The maximum number of concurrent search requests. It shouldn't be high, since a single request can saturate all the CPU cores, while many concurrently executed requests may require high amounts of memory. See also -search.maxQueueDuration (default 8)
491
503
-search.maxQueryDuration duration
492
504
The maximum duration for query execution. It can be overridden to a smaller value on a per-query basis via 'timeout' query arg (default 30s)
505
+
-search.maxQueryTimeRange value
506
+
The maximum time range, which can be setin the query sent to querying APIs. Queries with bigger time ranges are rejected. See https://docs.victoriametrics.com/victorialogs/querying/#resource-usage-limits
507
+
The following unit suffixes are required: s (second), m (minute), h (hour), d (day), w (week), y (year). Bare numbers without units are not allowed (except 0) (default 0)
493
508
-search.maxQueueDuration duration
494
509
The maximum time the search request waits for execution when -search.maxConcurrentRequests limit is reached; see also -search.maxQueryDuration (default 10s)
495
510
-search.traceMaxDurationWindow duration
@@ -512,7 +527,7 @@ It is recommended protecting internal HTTP endpoints from unauthorized access:
512
527
-storageDataPath string
513
528
Path to directory where to store VictoriaTraces data; see https://docs.victoriametrics.com/victoriatraces/#storage (default "victoria-traces-data")
514
529
-storageNode array
515
-
Comma-separated list of TCP addresses for storage nodes to route the ingested logs to and to send select queries to. If the list is empty, then the ingested logs are stored and queried locally from -storageDataPath
530
+
Comma-separated list of TCP addresses for storage nodes to route the ingested spans to and to send select queries to. If the list is empty, then the ingested spans are stored and queried locally from -storageDataPath
516
531
Supports an array of values separated by comma or specified via multiple flags.
517
532
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
0 commit comments