minor: add missing utility
[distro-setup] / default / prometheus
1 # iank: initial file from 2.24, added to empty ARGS.
2 # overlapping-blocks is for backfil of recording rules,
3 # https://jessicagreben.medium.com/prometheus-fill-in-data-for-new-recording-rules-30a14ccb8467
4
5 # config.file and tsdb.path are to configure the upstream version to use
6 # the default locations of the debian package.
7
8 # Sets the command-line arguments to pass to the server.
9
10 ARGS="--web.listen-address=127.0.0.1:9090
11 --web.external-url=https://i.b8.nz:9091
12 --log.level=info
13 --storage.tsdb.allow-overlapping-blocks
14 --config.file=/etc/prometheus/prometheus.yml
15 --storage.tsdb.path=/var/lib/prometheus/metrics2/"
16
17
18
19 # --config.file="prometheus.yml"
20 # Prometheus configuration file path.
21 # --web.listen-address="0.0.0.0:9090"
22 # Address to listen on for UI, API, and telemetry.
23 # --web.config.file="" [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication.
24 # --web.read-timeout=5m Maximum duration before timing out read of the request, and closing idle connections.
25 # --web.max-connections=512 Maximum number of simultaneous connections.
26 # --web.external-url=<URL> The URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy). Used for generating relative and absolute links back to
27 # Prometheus itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by Prometheus. If omitted, relevant URL components will be derived
28 # automatically.
29 # --web.route-prefix=<path> Prefix for the internal routes of web endpoints. Defaults to path of --web.external-url.
30 # --web.user-assets=<path> Path to static asset directory, available at /user.
31 # --web.enable-lifecycle Enable shutdown and reload via HTTP request.
32 # --web.enable-admin-api Enable API endpoints for admin control actions.
33 # --web.enable-remote-write-receiver
34 # Enable API endpoint accepting remote write requests.
35 # --web.console.templates="consoles"
36 # Path to the console template directory, available at /consoles.
37 # --web.console.libraries="console_libraries"
38 # Path to the console library directory.
39 # --web.page-title="Prometheus Time Series Collection and Processing Server"
40 # Document title of Prometheus instance.
41 # --web.cors.origin=".*" Regex for CORS origin. It is fully anchored. Example: 'https?://(domain1|domain2)\.com'
42 # --storage.tsdb.path="data/"
43 # Base path for metrics storage. Use with server mode only.
44 # --storage.tsdb.retention=STORAGE.TSDB.RETENTION
45 # [DEPRECATED] How long to retain samples in storage. This flag has been deprecated, use "storage.tsdb.retention.time" instead. Use with server mode only.
46 # --storage.tsdb.retention.time=STORAGE.TSDB.RETENTION.TIME
47 # How long to retain samples in storage. When this flag is set it overrides "storage.tsdb.retention". If neither this flag nor "storage.tsdb.retention" nor
48 # "storage.tsdb.retention.size" is set, the retention time defaults to 15d. Units Supported: y, w, d, h, m, s, ms. Use with server mode only.
49 # --storage.tsdb.retention.size=STORAGE.TSDB.RETENTION.SIZE
50 # Maximum number of bytes that can be stored for blocks. A unit is required, supported units: B, KB, MB, GB, TB, PB, EB. Ex: "512MB". Based on powers-of-2, so 1KB is 1024B. Use
51 # with server mode only.
52 # --storage.tsdb.no-lockfile
53 # Do not create lockfile in data directory. Use with server mode only.
54 # --storage.tsdb.allow-overlapping-blocks
55 # Allow overlapping blocks, which in turn enables vertical compaction and vertical query merge. Use with server mode only.
56 # --storage.tsdb.head-chunks-write-queue-size=0
57 # Size of the queue through which head chunks are written to the disk to be m-mapped, 0 disables the queue completely. Experimental. Use with server mode only.
58 # --storage.agent.path="data-agent/"
59 # Base path for metrics storage. Use with agent mode only.
60 # --storage.agent.wal-compression
61 # Compress the agent WAL. Use with agent mode only.
62 # --storage.agent.retention.min-time=STORAGE.AGENT.RETENTION.MIN-TIME
63 # Minimum age samples may be before being considered for deletion when the WAL is truncated Use with agent mode only.
64 # --storage.agent.retention.max-time=STORAGE.AGENT.RETENTION.MAX-TIME
65 # Maximum age samples may be before being forcibly deleted when the WAL is truncated Use with agent mode only.
66 # --storage.agent.no-lockfile
67 # Do not create lockfile in data directory. Use with agent mode only.
68 # --storage.remote.flush-deadline=<duration>
69 # How long to wait flushing sample on shutdown or config reload.
70 # --storage.remote.read-sample-limit=5e7
71 # Maximum overall number of samples to return via the remote read interface, in a single query. 0 means no limit. This limit is ignored for streamed response types. Use with
72 # server mode only.
73 # --storage.remote.read-concurrent-limit=10
74 # Maximum number of concurrent remote read calls. 0 means no limit. Use with server mode only.
75 # --storage.remote.read-max-bytes-in-frame=1048576
76 # Maximum number of bytes in a single frame for streaming remote read response types before marshalling. Note that client might have limit on frame size as well. 1MB as
77 # recommended by protobuf by default. Use with server mode only.
78 # --rules.alert.for-outage-tolerance=1h
79 # Max time to tolerate prometheus outage for restoring "for" state of alert. Use with server mode only.
80 # --rules.alert.for-grace-period=10m
81 # Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than grace period. Use with server mode only.
82 # --rules.alert.resend-delay=1m
83 # Minimum amount of time to wait before resending an alert to Alertmanager. Use with server mode only.
84 # --alertmanager.notification-queue-capacity=10000
85 # The capacity of the queue for pending Alertmanager notifications. Use with server mode only.
86 # --query.lookback-delta=5m The maximum lookback duration for retrieving metrics during expression evaluations and federation. Use with server mode only.
87 # --query.timeout=2m Maximum time a query may take before being aborted. Use with server mode only.
88 # --query.max-concurrency=20
89 # Maximum number of queries executed concurrently. Use with server mode only.
90 # --query.max-samples=50000000
91 # Maximum number of samples a single query can load into memory. Note that queries will fail if they try to load more samples than this into memory, so this also limits the
92 # number of samples a query can return. Use with server mode only.
93 # --enable-feature= ... Comma separated feature names to enable. Valid options: agent, exemplar-storage, expand-external-labels, memory-snapshot-on-shutdown, promql-at-modifier,
94 # promql-negative-offset, remote-write-receiver (DEPRECATED), extra-scrape-metrics, new-service-discovery-manager. See https://prometheus.io/docs/prometheus/latest/feature_flags/
95 # for more details.
96 # --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error]
97 # --log.format=logfmt Output format of log messages. One of: [logfmt, json]