1prometheus(1)                       2.32.1                       prometheus(1)
2
3
4

NAME

6       prometheus - The Prometheus monitoring server
7

SYNOPSIS

9       prometheus [<flags>]
10
11

DESCRIPTION

13       The Prometheus monitoring server
14

OPTIONS

16       -h, --help
17              Show  context-sensitive  help  (also try --help-long and --help-
18              man).
19
20       --version
21              Show application version.
22
23       --config.file="/etc/prometheus/prometheus.yml"
24              Prometheus configuration file path.
25
26       --web.listen-address="0.0.0.0:9090"
27              Address to listen on for UI, API, and telemetry.
28
29       --web.config.file=""
30              [EXPERIMENTAL] Path to configuration file that can enable TLS or
31              authentication.
32
33       --web.read-timeout=5m
34              Maximum  duration  before  timing  out  read of the request, and
35              closing idle connections.
36
37       --web.max-connections=512
38              Maximum number of simultaneous connections.
39
40       --web.external-url=<URL>
41              The URL under which Prometheus is externally reachable (for  ex‐
42              ample,  if  Prometheus  is served via a reverse proxy). Used for
43              generating relative and absolute links back  to  Prometheus  it‐
44              self.  If  the URL has a path portion, it will be used to prefix
45              all HTTP endpoints served by Prometheus.  If  omitted,  relevant
46              URL components will be derived automatically.
47
48       --web.route-prefix=<path>
49              Prefix  for  the  internal  routes of web endpoints. Defaults to
50              path of --web.external-url.
51
52       --web.user-assets=<path>
53              Path to user asset directory, available at /user.
54
55       --web.enable-lifecycle
56              Enable shutdown and reload via HTTP request.
57
58       --web.enable-admin-api
59              Enable API endpoints for admin control actions.
60
61       --web.console.templates="/etc/prometheus/consoles"
62              Path to the console template directory, available at /consoles.
63
64       --web.console.libraries="/etc/prometheus/console_libraries"
65              Path to the console library directory.
66
67       --web.page-title="Prometheus  Time  Series  Collection  and  Processing
68       Server"
69              Document title of Prometheus instance.
70
71       --web.cors.origin=".*"
72              Regex   for   CORS   origin.  It  is  fully  anchored.  Example:
73              'https?://(domain1|domain2).com'
74
75       --storage.tsdb.path="/var/lib/prometheus/metrics2/"
76              Base path for metrics storage. Use with server mode only.
77
78       --storage.tsdb.retention=STORAGE.TSDB.RETENTION
79              [DEPRECATED] How long to retain samples in  storage.  This  flag
80              has  been deprecated, use "storage.tsdb.retention.time" instead.
81              Use with server mode only.
82
83       --storage.tsdb.retention.time=STORAGE.TSDB.RETENTION.TIME
84              How long to retain samples in storage. When this flag is set  it
85              overrides  "storage.tsdb.retention".  If  neither  this flag nor
86              "storage.tsdb.retention"  nor  "storage.tsdb.retention.size"  is
87              set,  the retention time defaults to 15d. Units Supported: y, w,
88              d, h, m, s, ms. Use with server mode only.
89
90       --storage.tsdb.retention.size=STORAGE.TSDB.RETENTION.SIZE
91              Maximum number of bytes that can be stored for blocks. A unit is
92              required,  supported  units:  B,  KB,  MB,  GB,  TB, PB, EB. Ex:
93              "512MB". Use with server mode only.
94
95       --storage.tsdb.no-lockfile
96              Do not create lockfile in data directory. Use with  server  mode
97              only.
98
99       --storage.tsdb.allow-overlapping-blocks
100              Allow  overlapping  blocks,  which in turn enables vertical com‐
101              paction and vertical query merge. Use with server mode only.
102
103       --storage.agent.path="data-agent/"
104              Base path for metrics storage. Use with agent mode only.
105
106       --storage.agent.wal-compression
107              Compress the agent WAL. Use with agent mode only.
108
109       --storage.agent.retention.min-time=STORAGE.AGENT.RETENTION.MIN-TIME
110              Minimum age samples may be before being considered for  deletion
111              when the WAL is truncated Use with agent mode only.
112
113       --storage.agent.retention.max-time=STORAGE.AGENT.RETENTION.MAX-TIME
114              Maximum  age  samples  may be before being forcibly deleted when
115              the WAL is truncated Use with agent mode only.
116
117       --storage.agent.no-lockfile
118              Do not create lockfile in data directory. Use  with  agent  mode
119              only.
120
121       --storage.remote.flush-deadline=<duration>
122              How long to wait flushing sample on shutdown or config reload.
123
124       --storage.remote.read-sample-limit=5e7
125              Maximum  overall number of samples to return via the remote read
126              interface, in a single query. 0 means no limit.  This  limit  is
127              ignored for streamed response types. Use with server mode only.
128
129       --storage.remote.read-concurrent-limit=10
130              Maximum  number  of  concurrent  remote  read  calls. 0 means no
131              limit. Use with server mode only.
132
133       --storage.remote.read-max-bytes-in-frame=1048576
134              Maximum number of bytes in a single frame for  streaming  remote
135              read  response  types before marshalling. Note that client might
136              have limit on frame size as well. 1MB as recommended by protobuf
137              by default. Use with server mode only.
138
139       --rules.alert.for-outage-tolerance=1h
140              Max time to tolerate prometheus outage for restoring "for" state
141              of alert. Use with server mode only.
142
143       --rules.alert.for-grace-period=10m
144              Minimum duration between alert and restored "for" state. This is
145              maintained  only  for  alerts with configured "for" time greater
146              than grace period. Use with server mode only.
147
148       --rules.alert.resend-delay=1m
149              Minimum amount of time to wait  before  resending  an  alert  to
150              Alertmanager. Use with server mode only.
151
152       --alertmanager.notification-queue-capacity=10000
153              The  capacity  of  the  queue for pending Alertmanager notifica‐
154              tions. Use with server mode only.
155
156       --query.lookback-delta=5m
157              The maximum lookback duration for retrieving metrics during  ex‐
158              pression evaluations and federation. Use with server mode only.
159
160       --query.timeout=2m
161              Maximum  time  a  query  may take before being aborted. Use with
162              server mode only.
163
164       --query.max-concurrency=20
165              Maximum number of queries executed concurrently. Use with server
166              mode only.
167
168       --query.max-samples=50000000
169              Maximum  number  of samples a single query can load into memory.
170              Note that queries will fail if they try  to  load  more  samples
171              than this into memory, so this also limits the number of samples
172              a query can return. Use with server mode only.
173
174       --enable-feature=
175              Comma separated feature names to enable. Valid  options:  agent,
176              exemplar-storage,   expand-external-labels,  memory-snapshot-on-
177              shutdown,  promql-at-modifier,  promql-negative-offset,  remote-
178              write-receiver, extra-scrape-metrics, new-service-discovery-man‐
179              ager.   See    https://prometheus.io/docs/prometheus/latest/fea
180              ture_flags/ for more details.
181
182       --log.level=info
183              Only log messages with the given severity or above. One of: [de‐
184              bug, info, warn, error]
185
186       --log.format=logfmt
187              Output format of log messages. One of: [logfmt, json]
188
189
190
191version                           prometheus,                    prometheus(1)
Impressum