29
29
# Maximum query execution time.
30
30
max_execution_time : 30s
31
31
32
+ # #
33
+ # # PostgreSQL db that is used to store metadata such us metric names, dashboards, alerts,
34
+ # # and so on.
35
+ # #
36
+ pg :
37
+ addr : postgres:5432
38
+ user : uptrace
39
+ password : uptrace
40
+ database : uptrace
41
+
32
42
# #
33
43
# # A list of pre-configured projects. Each project is fully isolated.
34
44
# #
@@ -95,110 +105,42 @@ metrics_from_spans:
95
105
where : span.is_event
96
106
97
107
# #
98
- # # Alerting rules for monitoring metrics.
99
- # #
100
- # # See https://uptrace.dev/get/alerting.html for details.
101
- # #
102
- alerting :
103
- rules :
104
- - name : Network errors
105
- metrics :
106
- - system.network.errors as $net_errors
107
- query :
108
- - $net_errors > 0 group by host.name
109
- # for the last 5 minutes
110
- for : 5m
111
- annotations :
112
- summary : ' {{ $labels.host_name }} has high number of net errors: {{ $values.net_errors }}'
113
-
114
- - name : Filesystem usage >= 90%
115
- metrics :
116
- - system.filesystem.usage as $fs_usage
117
- query :
118
- - group by host.name
119
- - group by device
120
- - where device !~ "loop"
121
- - $fs_usage{state="used"} / $fs_usage >= 0.9
122
- for : 5m
123
- annotations :
124
- summary : ' {{ $labels.host_name }} has high FS usage: {{ $values.fs_usage }}'
125
-
126
- - name : Uptrace is dropping spans
127
- metrics :
128
- - uptrace.projects.spans as $spans
129
- query :
130
- - $spans{type=dropped} > 0
131
- for : 1m
132
- annotations :
133
- summary : ' Uptrace has dropped {{ $values.spans }} spans'
134
-
135
- - name : Always firing (for fun and testing)
136
- metrics :
137
- - process.runtime.go.goroutines as $goroutines
138
- query :
139
- - $goroutines >= 0 group by host.name
140
- for : 1m
141
- annotations :
142
- summary : ' {{ $labels.host_name }} has high number of goroutines: {{ $values.goroutines }}'
143
-
144
- # Create alerts from error logs and span events.
145
- create_alerts_from_spans :
146
- enabled : true
147
- labels :
148
- alert_kind : error
149
-
150
- # #
151
- # # AlertManager client configuration.
152
- # # See https://uptrace.dev/get/alerting.html for details.
153
- # #
154
- # # Note that this is NOT an AlertManager config and you need to configure AlertManager separately.
155
- # # See https://prometheus.io/docs/alerting/latest/configuration/ for details.
156
- # #
157
- alertmanager_client :
158
- # AlertManager API endpoints that Uptrace uses to manage alerts.
159
- urls :
160
- - ' http://alertmanager:9093/api/v2/alerts'
161
-
162
- # #
163
- # # To require authentication, uncomment the following section.
108
+ # # To require authentication, uncomment one of the following sections.
164
109
# #
165
110
auth :
166
- # users:
167
- # - username: uptrace
168
- # password : uptrace
169
- # - username: admin
170
- # password: admin
171
-
172
- # # Cloudflare user provider: uses Cloudflare Zero Trust Access (Identity)
173
- # # See https://developers.cloudflare.com/cloudflare-one/identity/ for more info.
111
+ users :
112
+ - name : Anonymous
113
+ email : uptrace@localhost
114
+ password : uptrace
115
+ notify_by_email : true
116
+
117
+ # Cloudflare Zero Trust Access (Identity)
118
+ # See https://developers.cloudflare.com/cloudflare-one/identity/ for more info.
174
119
# cloudflare:
175
120
# # The base URL of the Cloudflare Zero Trust team.
176
121
# - team_url: https://myteam.cloudflareaccess.com
177
122
# # The Application Audience (AUD) Tag for this application.
178
123
# # You can retrieve this from the Cloudflare Zero Trust 'Access' Dashboard.
179
124
# audience: bea6df23b944e4a0cd178609ba1bb64dc98dfe1f66ae7b918e563f6cf28b37e0
180
125
181
- # # OpenID Connect (Single Sign-On)
182
- # oidc:
183
- # # The ID is used in API endpoints, for example, in redirect URL
184
- # # `http://<uptrace-host>/api/v1/sso/<oidc-id>/callback`.
185
- # - id: keycloak
186
- # # Display name for the button in the login form.
187
- # # Default to 'OpenID Connect'
188
- # display_name: Keycloak
189
- # # The base URL for the OIDC provider.
190
- # issuer_url: http://localhost:8080/realms/uptrace
191
- # # The OAuth 2.0 Client ID
192
- # client_id: uptrace
193
- # # The OAuth 2.0 Client Secret
194
- # client_secret: ogbhd8Q0X0e5AZFGSG3m9oirPvnetqkA
195
- # # Additional OAuth 2.0 scopes to request from the OIDC provider.
196
- # # Defaults to 'profile'. 'openid' is requested by default and need not be specified.
197
- # scopes:
198
- # - profile
199
- # # The OIDC UserInfo claim to use as the user's username.
200
- # # Defaults to 'preferred_username'.
201
- # claim: preferred_username
126
+ # OpenID Connect (Single Sign-On)
127
+ oidc :
128
+ # # The ID is used in API endpoints, for example, in redirect URL
129
+ # # `http://<uptrace-host>/api/v1/sso/<oidc-id>/callback`.
130
+ # - id: keycloak
131
+ # # Display name for the button in the login form.
132
+ # # Default to 'OpenID Connect'
133
+ # display_name: Keycloak
134
+ # # The base URL for the OIDC provider.
135
+ # issuer_url: http://localhost:8080/realms/uptrace
136
+ # # The OAuth 2.0 Client ID
137
+ # client_id: uptrace
138
+ # # The OAuth 2.0 Client Secret
139
+ # client_secret: ogbhd8Q0X0e5AZFGSG3m9oirPvnetqkA
140
+ # # Additional OAuth 2.0 scopes to request from the OIDC provider.
141
+ # # Defaults to 'profile'. 'openid' is requested by default and need not be specified.
142
+ # scopes:
143
+ # - profile
202
144
203
145
# #
204
146
# # Various options to tweak ClickHouse schema.
@@ -248,6 +190,8 @@ listen:
248
190
site :
249
191
# Overrides public URL for Vue-powered UI in case you put Uptrace behind a proxy.
250
192
# addr: 'https://uptrace.mydomain.com'
193
+ # The base path for the Vue-powered UI in case you serve Uptrace UI behind a sub path.
194
+ path : ' /'
251
195
252
196
# #
253
197
# # Spans processing options.
@@ -277,19 +221,6 @@ metrics:
277
221
# The number of measures to insert in a single query.
278
222
# batch_size: 10000
279
223
280
- # #
281
- # # SQLite/PostgreSQL db that is used to store metadata such us metric names, dashboards, alerts,
282
- # # and so on.
283
- # #
284
- db :
285
- # Either sqlite or postgres.
286
- driver : sqlite
287
- # Database connection string.
288
- #
289
- # Uptrace automatically creates SQLite database file in the current working directory.
290
- # Make sure the directory is writable by Uptrace process.
291
- dsn : ' file:uptrace.sqlite3?_pragma=foreign_keys(1)&_pragma=busy_timeout(1000)'
292
-
293
224
# #
294
225
# # uptrace-go client configuration.
295
226
# # Uptrace sends internal telemetry here. Defaults to listen.grpc.addr.
@@ -301,6 +232,18 @@ uptrace_go:
301
232
# key_file: config/tls/uptrace.key
302
233
# insecure_skip_verify: true
303
234
235
+ # #
236
+ # # SMTP settings to send emails.
237
+ # # https://uptrace.dev/get/alerting.html
238
+ # #
239
+ smtp_mailer :
240
+ enabled : true
241
+ host : mailhog
242
+ port : 1025
243
+ username : mailhog
244
+ password : mailhog
245
+ from : ' uptrace@localhost'
246
+
304
247
# #
305
248
# # Logging configuration.
306
249
# #
0 commit comments