Skip to content

Update logging docs to mention logback config options #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nscuro merged 1 commit into from
Jun 12, 2026
+26 −1
Merged

Update logging docs to mention logback config options #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vale/styles/config/vocabularies/DependencyTrack/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Keycloak
LDAP
LDAPS
Liquibase
Logback
Lucene
MSSQL
Mattermost
Expand Down Expand Up @@ -73,6 +74,7 @@ SSDs
Sigstore
Snyk
Sonatype
Splunk
TTLs
Timescale
Tink
Expand Down Expand Up @@ -173,6 +175,7 @@ keytool
npm
px
sAMAccountName
stdout
timestamptz
truststore
userinfo
Expand Down
24 changes: 23 additions & 1 deletion docs/guides/administration/configuring-observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,29 @@ dt.logging.level."ROOT"=ERROR
Refer to the [environment variable mapping](../../reference/configuration/application.md#environment-variable-mapping) documentation
for how to express these properties as environment variables.

## Changing the logging configuration

Dependency-Track uses [Logback] for logging. The default configuration writes logs to stdout in a
human-readable text format.

The container images also ship a JSON-formatted configuration at `logback-json.xml`, located in the
app's working directory. JSON output is typically the better choice when shipping logs to a
centralized log management system such as Splunk, Elasticsearch, or Loki. Activate it by pointing
Logback at that file:

```ini
EXTRA_JAVA_OPTIONS="-Dlogback.configurationFile=logback-json.xml"
```

Set the flag via `EXTRA_JAVA_OPTIONS` so the container appends it to the JVM command line. See the
[JVM options reference](../../reference/configuration/application.md#jvm-options) for details.

To use a fully custom configuration, mount your own file into the container and reference it the same
way, with either a relative path (resolved against the working directory) or an absolute path. The
[Logback configuration manual][Logback] describes the file format.

[Logback]: https://logback.qos.ch/manual/configuration.html
[MicroProfile Health]: https://download.eclipse.org/microprofile/microprofile-health-4.0.1/microprofile-health-spec-4.0.1.html
[probe types]: https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/
[Prometheus text exposition format]: https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format
[dashboards]: https://github.com/DependencyTrack/dependency-track/tree/main/dev/monitoring/grafana/dashboards
[probe types]: https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/