Skip to content

Commit 0e58ac1

Browse files
committed
Update docs relating to dt.config.profile and dt.config.log.values
Signed-off-by: nscuro <nscuro@protonmail.com>
1 parent a58d14f commit 0e58ac1

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

docs/operations/configuration/overview.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,17 @@ by [MicroProfile Config]:
5656
The [configuration reference](../../reference/configuration/api-server.md) includes the correct
5757
environment variable names for each listed config property.
5858

59+
## Debugging
60+
61+
To debug whether config values are properly resolved, and from *which source* they are resolved,
62+
it's possible to enable debug logging va [`dt.config.log.values`](../../reference/configuration/api-server.md#dtconfiglogvalues):
63+
64+
``` linenums="1"
65+
dt.config.log.values=true
66+
dt.logging.level."io.smallrye.config"=DEBUG
67+
```
68+
69+
!!! warning
70+
This will *not* mask or omit any secrets*. **Do not use in production environments!**
71+
5972
[MicroProfile Config]: https://microprofile.io/specifications/config/

docs/operations/scaling.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ are impractical, the `s3` provider is available.
2323

2424
By default, every instance serves API traffic **and** runs background workers.
2525
The `web` config profile disables all background processing, turning an instance
26-
into an API-only node. Activate it via:
26+
into an API-only node. Activate it via [`dt.config.profile`](../reference/configuration/api-server.md#dtconfigprofile):
2727

28-
```
29-
SMALLRYE_CONFIG_PROFILE=web
28+
``` linenums="1"
29+
dt.config.profile=web
3030
```
3131

3232
This results in two logical node types:
@@ -46,7 +46,7 @@ services:
4646
web:
4747
image: ghcr.io/dependencytrack/hyades-apiserver
4848
environment:
49-
SMALLRYE_CONFIG_PROFILE: "web"
49+
DT_CONFIG_PROFILE: "web"
5050
DT_DATASOURCE_URL: "jdbc:postgresql://postgres:5432/dtrack"
5151
DT_DATASOURCE_USERNAME: "dtrack"
5252
DT_DATASOURCE_PASSWORD: "dtrack"
@@ -149,7 +149,7 @@ EXTRA_JAVA_OPTIONS="-XX:MaxGCPauseMillis=100"
149149

150150
More CPU benefits worker throughput; more memory benefits caching and large BOM processing.
151151

152-
## Dex Engine Tuning
152+
## dex Engine Tuning
153153

154154
### Buffers
155155

@@ -204,7 +204,7 @@ Configuration:
204204
- [`notification.outbox-relay.poll-interval-ms`](../reference/configuration/api-server.md#dtnotificationoutbox-relaypoll-interval-ms)
205205
- [`notification.outbox-relay.batch-size`](../reference/configuration/api-server.md#dtnotificationoutbox-relaybatch-size)
206206

207-
## Separate Database for Dex
207+
## Separate Database for dex
208208

209209
By default, the durable execution engine uses the application database
210210
([`dt.dex-engine.datasource.name`](../reference/configuration/api-server.md#dtdex-enginedatasourcename)`=default`). For larger deployments, pointing dex

0 commit comments

Comments
 (0)