Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
307 lines (249 loc) · 12.6 KB
/
Copy path.env.example
File metadata and controls
307 lines (249 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# Generated by cmd/pitot-docgen from internal/config/config.go.
# Regenerate with just docs-generate; verify with just docs-generate-check.
# Pitot does not load dotenv files. Inject through your launcher or deployment.
# Precedence: built-in defaults < nonempty environment values.
# All settings require restart. Empty environment values mean no override.
# Every entry is commented out so copying this template sets nothing, preserving image ENV.
# Uncomment only settings you want to supply; use runtime secret injection for secrets.
# Local authentication requires PITOT_AUTH_CODE_SECRET (32+ characters).
# Chat is disabled unless PITOT_AI_PROVIDER selects anthropic or openai; its key is required.
# ANTHROPIC_API_KEY; string; secret
# Required when PITOT_AI_PROVIDER is anthropic.
# Default: (empty)
# ANTHROPIC_API_KEY=
# Alternatively set ANTHROPIC_API_KEY_FILE to a secret file path; do not set both.
# ANTHROPIC_BASE_URL; string
# Defaults to https://api.anthropic.com. Pitot appends /v1/messages, preserving any gateway path prefix. Use an HTTP(S) base URL without embedded credentials, a query, or a fragment.
# Default: (empty)
# ANTHROPIC_BASE_URL=
# OPENAI_API_KEY; string; secret
# Required when PITOT_AI_PROVIDER is openai.
# Default: (empty)
# OPENAI_API_KEY=
# Alternatively set OPENAI_API_KEY_FILE to a secret file path; do not set both.
# OPENAI_BASE_URL; string
# Defaults to https://api.openai.com/v1. Pitot appends /responses, preserving the API version and any gateway path prefix. Use an HTTP(S) base URL without embedded credentials, a query, or a fragment.
# Default: (empty)
# OPENAI_BASE_URL=
# PITOT_ADDR; string
# Binds the browser, API, MCP, OTLP/gRPC and OTLP/HTTP listener.
# Default: 127.0.0.1:7520
# PITOT_ADDR=
# PITOT_AI_MODEL; string
# Overrides the provider's default: claude-sonnet-5-5 for Anthropic and gpt-6.1-sol for OpenAI. The OpenAI provider expects a reasoning model supporting reasoning.encrypted_content for stateless Responses replay. A 400 rejecting encrypted content is reported as a server-side configuration error; choose a compatible reasoning model with PITOT_AI_MODEL.
# Default: (empty)
# PITOT_AI_MODEL=
# PITOT_AI_PROVIDER; string
# Enables chat by selecting exactly anthropic or openai. Empty disables chat.
# Default: (empty)
# PITOT_AI_PROVIDER=
# PITOT_ALERTS_EMAIL_DEFAULT_TO; string
# A comma-separated list of addresses that receive alerts from rules with no webhook and no email recipients of their own; requires SMTP.
# Default: (empty)
# PITOT_ALERTS_EMAIL_DEFAULT_TO=
# PITOT_ALERTS_EMAIL_HOURLY_LIMIT; integer
# Caps the alert emails sent to one address in any rolling hour, across all rules. Notifications over the limit are suppressed, not delayed, and shown on the rule; 0 suppresses all alert email.
# Default: 30
# PITOT_ALERTS_EMAIL_HOURLY_LIMIT=
# PITOT_ALERTS_ENABLED; boolean
# Runs the alert evaluation engine.
# Default: true
# PITOT_ALERTS_ENABLED=
# PITOT_ALERTS_EVALUATION_INTERVAL; duration
# Schedules alert evaluation; use a Go duration of at least 1s.
# Default: 30s
# PITOT_ALERTS_EVALUATION_INTERVAL=
# PITOT_ALERTS_HISTORY_DAYS; integer
# Sets alert history retention in days.
# Default: 7
# PITOT_ALERTS_HISTORY_DAYS=
# PITOT_AUTH_CODE_SECRET; string; secret
# Signs sign-in codes and login links; needs at least 32 characters in local mode and to issue or redeem OIDC break-glass links.
# Default: (empty)
# PITOT_AUTH_CODE_SECRET=
# Alternatively set PITOT_AUTH_CODE_SECRET_FILE to a secret file path; do not set both.
# PITOT_AUTH_MODE; string
# Selects local sign-in or oidc; each mode validates its prerequisites.
# Default: local
# PITOT_AUTH_MODE=
# PITOT_DATA_DIR; string
# Stores telemetry, query state, and the control database.
# Default: ./data
# PITOT_DATA_DIR=
# PITOT_DEFAULT_NAMESPACE; string
# Supplies the namespace for telemetry without one.
# Default: default
# PITOT_DEFAULT_NAMESPACE=
# PITOT_DUCKDB_MAX_CONNECTIONS; integer
# Caps the DuckDB read connection pool. Reads scan immutable Parquet concurrently; analytical and completed-batch writes use separate gates and connections. Zero selects available Go CPUs, bounded to 2–16. Startup logs and /readyz report the resolved pool size.
# Default: 0
# PITOT_DUCKDB_MAX_CONNECTIONS=
# PITOT_DUCKDB_MEMORY; string
# Caps DuckDB's memory (e.g. "8GB"). Empty selects 60% of detected available memory, reserving headroom for Go. If detection fails, DuckDB uses its default with a process headroom adjustment. Startup logs and /readyz report the resolved budget and detection status. Set an explicit cap when memory limit detection is incomplete.
# Default: (empty)
# PITOT_DUCKDB_MEMORY=
# PITOT_DUCKDB_THREADS; integer
# Caps DuckDB's global query worker pool. Zero selects one worker per CPU the process may run on (the affinity mask and cgroup quota, as GOMAXPROCS resolves them) rather than DuckDB's count of the machine's hardware threads. Set it to leave cores free for ingest on a query-heavy co-tenant host.
# Default: 0
# PITOT_DUCKDB_THREADS=
# PITOT_HEALTHCHECK_CERT_FILE; string
# Selects the client certificate pitot healthcheck presents; requires PITOT_HEALTHCHECK_KEY_FILE and PITOT_TLS_CLIENT_CA_FILE.
# Default: (empty)
# PITOT_HEALTHCHECK_CERT_FILE=
# PITOT_HEALTHCHECK_KEY_FILE; string
# Selects the private key for PITOT_HEALTHCHECK_CERT_FILE; requires PITOT_HEALTHCHECK_CERT_FILE.
# Default: (empty)
# PITOT_HEALTHCHECK_KEY_FILE=
# PITOT_INGEST_BATCH_SIZE; integer
# Sets the group-commit row target; valid values are 1–50000. Individual requests remain atomic and can exceed this target.
# Default: 50000
# PITOT_INGEST_BATCH_SIZE=
# PITOT_INGEST_MAX_IN_FLIGHT_BYTES; integer
# Caps decoded telemetry held across concurrent requests until durable publication. Zero is unbounded. A single request is admitted when no other request holds budget, even if it exceeds the limit.
# Default: 268435456
# PITOT_INGEST_MAX_IN_FLIGHT_BYTES=
# PITOT_INGEST_TOKEN; string; secret
# Sets the first ingest token, named configuration, when none has ever existed, so an automated install accepts telemetry as soon as it starts. Use foi_ plus 43 base64url characters. Only its digest is stored. It is ignored once any token has existed, including a revoked one, so a restart cannot bring back a revoked token.
# Default: (empty)
# PITOT_INGEST_TOKEN=
# Alternatively set PITOT_INGEST_TOKEN_FILE to a secret file path; do not set both.
# PITOT_MAINTENANCE_INTERVAL; duration
# Controls Parquet retention and compaction, and query-cache checkpointing.
# Default: 1h
# PITOT_MAINTENANCE_INTERVAL=
# PITOT_MCP_ENABLED; boolean
# Serves the MCP endpoint at /mcp.
# Default: true
# PITOT_MCP_ENABLED=
# PITOT_METRICS_PUBLIC; boolean
# Allows unauthenticated Prometheus scrapes.
# Default: false
# PITOT_METRICS_PUBLIC=
# PITOT_METRICS_TOKEN; string; secret
# Authorizes Prometheus scrapes with a bearer token; optional when using an admin session.
# Default: (empty)
# PITOT_METRICS_TOKEN=
# Alternatively set PITOT_METRICS_TOKEN_FILE to a secret file path; do not set both.
# PITOT_OIDC_ADMIN_GROUPS; string
# Lists identity-provider groups mapped to admin, separated by commas.
# Default: (empty)
# PITOT_OIDC_ADMIN_GROUPS=
# PITOT_OIDC_ALLOWED_DOMAINS; string
# Lists allowed email domains, separated by commas; wildcard * requires verified email.
# Default: (empty)
# PITOT_OIDC_ALLOWED_DOMAINS=
# PITOT_OIDC_ALLOWED_GROUPS; string
# Lists allowed identity-provider groups, separated by commas.
# Default: (empty)
# PITOT_OIDC_ALLOWED_GROUPS=
# PITOT_OIDC_AUTO_PROVISION; boolean
# Creates accounts on OIDC sign-in; requires an allowed group or domain.
# Default: false
# PITOT_OIDC_AUTO_PROVISION=
# PITOT_OIDC_CLIENT_ID; string
# Identifies Pitot's client registration; required in OIDC mode.
# Default: (empty)
# PITOT_OIDC_CLIENT_ID=
# PITOT_OIDC_CLIENT_SECRET; string; secret
# Authenticates Pitot's client registration; required in OIDC mode.
# Default: (empty)
# PITOT_OIDC_CLIENT_SECRET=
# Alternatively set PITOT_OIDC_CLIENT_SECRET_FILE to a secret file path; do not set both.
# PITOT_OIDC_DEFAULT_ROLE; string
# Assigns viewer, operator, or admin to users without a group role mapping.
# Default: viewer
# PITOT_OIDC_DEFAULT_ROLE=
# PITOT_OIDC_EMAIL_CLAIM; string
# Names the claim containing the user's email address.
# Default: email
# PITOT_OIDC_EMAIL_CLAIM=
# PITOT_OIDC_EMAIL_VERIFICATION; string
# Selects required verified-email claims or issuer trust; issuer trust requires an allowlist.
# Default: required
# PITOT_OIDC_EMAIL_VERIFICATION=
# PITOT_OIDC_ISSUER_URL; string
# Selects the identity provider issuer; required in OIDC mode. Pitot starts while it is unreachable and retries discovery; a mismatched issuer fails startup.
# Default: (empty)
# PITOT_OIDC_ISSUER_URL=
# PITOT_OIDC_OPERATOR_GROUPS; string
# Lists identity-provider groups mapped to operator, separated by commas.
# Default: (empty)
# PITOT_OIDC_OPERATOR_GROUPS=
# PITOT_PPROF_ENABLED; boolean
# Exposes Go's net/http/pprof handlers at /debug/pprof/* for CPU/heap/mutex/goroutine profiling under load. Off by default; the routes require an admin browser session with operations:read.
# Default: false
# PITOT_PPROF_ENABLED=
# PITOT_PUBLIC_URL; string
# Sets the external browser origin, MCP token audience, and trusted MCP request origin. Required for OIDC; HTTPS is required with MCP.
# Default: (empty)
# PITOT_PUBLIC_URL=
# PITOT_QUERY_CACHE_TTL; duration
# The oldest a dashboard panel, exemplar or trace detail result served from memory may be, measured from the end of the time window it covers (for traces and exemplars, from when their run started). A result younger than half the TTL is served as is; one younger than the TTL is served while one background run refreshes it; an older one is rerun. A request with Cache-Control: no-cache, such as a dashboard's manual refresh, always reruns. Zero disables the cache; concurrent identical requests still share one execution.
# Default: 10s
# PITOT_QUERY_CACHE_TTL=
# PITOT_RETENTION_DAYS; integer
# Sets telemetry retention in days; zero disables expiry.
# Default: 30
# PITOT_RETENTION_DAYS=
# PITOT_ROLLUP_INTERVAL; duration
# Schedules analytical rollups; use a Go duration of at least 1s.
# Default: 1m
# PITOT_ROLLUP_INTERVAL=
# PITOT_ROLLUP_SKIP_TO_LATEST; boolean
# Set once at boot, this advances the service and edge rollup watermarks to the current max ingested timestamp. Existing history is not aggregated into those analytical rollups. Completed-batch trace caches still rebuild all retained history in bounded passes; uncached files remain immediately queryable. Useful for large pre-seeded datasets (benchmarks, restores); off in normal operation.
# Default: false
# PITOT_ROLLUP_SKIP_TO_LATEST=
# PITOT_SCIM_TOKEN; string; secret
# Enables SCIM 2.0 user provisioning under /scim/v2 and turns off browser setup; requires OIDC mode and at least 32 characters.
# Default: (empty)
# PITOT_SCIM_TOKEN=
# Alternatively set PITOT_SCIM_TOKEN_FILE to a secret file path; do not set both.
# PITOT_SELF_SIGNUP; boolean
# Allows verified email addresses to create viewer accounts; requires local auth and SMTP.
# Default: false
# PITOT_SELF_SIGNUP=
# PITOT_SESSION_ABSOLUTE_TTL; duration
# Limits total session lifetime; it must be at least PITOT_SESSION_IDLE_TTL.
# Default: 168h
# PITOT_SESSION_ABSOLUTE_TTL=
# PITOT_SESSION_IDLE_TTL; duration
# Expires inactive sessions; use a Go duration of at least 5m.
# Default: 12h
# PITOT_SESSION_IDLE_TTL=
# PITOT_SMTP_FROM; string
# Sets the email sender address; required with SMTP.
# Default: (empty)
# PITOT_SMTP_FROM=
# PITOT_SMTP_HOST; string
# Selects the mail server. Host, username, password, and from must all be set to enable SMTP.
# Default: (empty)
# PITOT_SMTP_HOST=
# PITOT_SMTP_PASSWORD; string; secret
# Authenticates to the mail server; required with SMTP.
# Default: (empty)
# PITOT_SMTP_PASSWORD=
# Alternatively set PITOT_SMTP_PASSWORD_FILE to a secret file path; do not set both.
# PITOT_SMTP_PORT; integer
# Sets the mail server's positive TCP port.
# Default: 587
# PITOT_SMTP_PORT=
# PITOT_SMTP_USERNAME; string
# Authenticates to the mail server; required with SMTP.
# Default: (empty)
# PITOT_SMTP_USERNAME=
# PITOT_TLS_CERT_FILE; string
# Selects the TLS certificate file; requires PITOT_TLS_KEY_FILE.
# Default: (empty)
# PITOT_TLS_CERT_FILE=
# PITOT_TLS_CLIENT_CA_FILE; string
# Selects a PEM CA bundle; when set, the listener requires client certificates signed by it. Requires PITOT_TLS_CERT_FILE and PITOT_TLS_KEY_FILE.
# Default: (empty)
# PITOT_TLS_CLIENT_CA_FILE=
# PITOT_TLS_KEY_FILE; string
# Selects the TLS private key file; requires PITOT_TLS_CERT_FILE.
# Default: (empty)
# PITOT_TLS_KEY_FILE=
# PITOT_TRUSTED_PROXY_CIDRS; string
# Lists trusted proxy networks, separated by commas; empty trusts no forwarded client addresses.
# Default: (empty)
# PITOT_TRUSTED_PROXY_CIDRS=