-
Notifications
You must be signed in to change notification settings - Fork 1
Dsf 2 doc improvements #122
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
74654d7
updated gitignore
schwzr 76ee9b6
updated javadoc
schwzr 793a5cb
updated FHIR IG
schwzr 413d53e
added minimal version of api-gen scripts
schwzr f3da2f8
use local fhir ig instead of gitlab hosted fhir ig
schwzr 0c0caf9
updated role config docs
schwzr 07a5c4e
added first draft of logging documentation
schwzr ac8fc5f
updated trusted certificate page to reflect DSF 2 changes
schwzr 788ae2a
updated system requirements
schwzr 76ac60c
improved upgrade instructions, added postgres update manual
schwzr 4967df3
updated menu
schwzr edddbde
Update install-plugins.md
MadMax93 ddc9455
Update install-plugins.md
MadMax93 751393f
Update install-plugins.md
MadMax93 6ae2ac7
Update install-plugins.md
MadMax93 1bcaf30
Update install-plugins.md
MadMax93 6e55cc9
renamed 2.0.0-RC2 to 2.0.0
schwzr edace74
set 2.0.0 to latest version, adopted menu
schwzr 9c093de
fixed review comments
schwzr fddb3f9
fixed broken link
schwzr d78fc35
Merge remote-tracking branch 'origin/main' into dsf-2-doc-improvements
schwzr d341514
tar.gz files for 2.0.0, updated row numbers in install.md
hhund File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| title: Logging | ||
| icon: config | ||
| --- | ||
|
|
||
| ## 1. Introduction | ||
| The DSF BPE executes distributed workflows and provides three logging channels: **Standard Logs**, | ||
| a **Data Logger** for introspection purposes, and **BPMN Debug Logs** for process plugin developers. | ||
|
|
||
| --- | ||
|
|
||
| ## Standard Logging | ||
|
|
||
| | Purpose | Property Key | Environment Variable | Default | | ||
| |---------|--------------|----------------------|---------| | ||
| | External Log4j2 config | [`dev.dsf.log.config`](../bpe/configuration.md#dev-dsf-log-config) | [`DEV_DSF_LOG_CONFIG`](../bpe/configuration.md#dev-dsf-log-config) | `conf/log4j2.xml` | | ||
| | Enable stderr logging | [`dev.dsf.log.console.err.enabled`](../bpe/configuration.md#dev-dsf-log-console-err-enabled) | [`DEV_DSF_LOG_CONSOLE_ERR_ENABLED`](../bpe/configuration.md#dev-dsf-log-console-err-enabled) | `false` | | ||
| | Level for stderr | [`dev.dsf.log.console.err.level`](../bpe/configuration.md#dev-dsf-log-console-err-level) | [`DEV_DSF_LOG_CONSOLE_ERR_LEVEL`](../bpe/configuration.md#dev-dsf-log-console-err-level) | `INFO` | | ||
| | Style for stderr | [`dev.dsf.log.console.err.style`](../bpe/configuration.md#dev-dsf-log-console-err-style) | [`DEV_DSF_LOG_CONSOLE_ERR_STYLE`](../bpe/configuration.md#dev-dsf-log-console-err-style) | `TEXT_COLOR` | | ||
| | Enable stdout logging | [`dev.dsf.log.console.out.enabled`](../bpe/configuration.md#dev-dsf-log-console-out-enabled) | [`DEV_DSF_LOG_CONSOLE_OUT_ENABLED`](../bpe/configuration.md#dev-dsf-log-console-out-enabled) | `true` | | ||
| | Level for stdout | [`dev.dsf.log.console.out.level`](../bpe/configuration.md#dev-dsf-log-console-out-level) | [`DEV_DSF_LOG_CONSOLE_OUT_LEVEL`](../bpe/configuration.md#dev-dsf-log-console-out-level) | `INFO` | | ||
| | Style for stdout | [`dev.dsf.log.console.out.style`](../bpe/configuration.md#dev-dsf-log-console-out-style) | [`DEV_DSF_LOG_CONSOLE_OUT_STYLE`](../bpe/configuration.md#dev-dsf-log-console-out-style) | `TEXT_COLOR` | | ||
| | Enable file logging | [`dev.dsf.log.file.enabled`](../bpe/configuration.md#dev-dsf-log-file-enabled) | [`DEV_DSF_LOG_FILE_ENABLED`](../bpe/configuration.md#dev-dsf-log-file-enabled) | `true` | | ||
| | File log level | [`dev.dsf.log.file.level`](../bpe/configuration.md#dev-dsf-log-file-level) | [`DEV_DSF_LOG_FILE_LEVEL`](../bpe/configuration.md#dev-dsf-log-file-level) | `DEBUG` | | ||
| | File log style | [`dev.dsf.log.file.style`](../bpe/configuration.md#dev-dsf-log-file-style) | [`DEV_DSF_LOG_FILE_STYLE`](../bpe/configuration.md#dev-dsf-log-file-style) | `TEXT_MDC` | | ||
|
|
||
| --- | ||
|
|
||
| ## Data Logger | ||
|
|
||
| | Purpose | Property Key | Environment Variable | Default | | ||
| |---------|--------------|----------------------|---------| | ||
| | Enable data log file | [`dev.dsf.log.data.file.enabled`](../bpe/configuration.md#dev-dsf-log-data-file-enabled) | [`DEV_DSF_LOG_DATA_FILE_ENABLED`](../bpe/configuration.md#dev-dsf-log-data-file-enabled) | `false` | | ||
| | Data file style | [`dev.dsf.log.data.file.style`](../bpe/configuration.md#dev-dsf-log-data-file-style) | [`DEV_DSF_LOG_DATA_FILE_STYLE`](../bpe/configuration.md#dev-dsf-log-data-file-style) | `TEXT` | | ||
| | Enable data logs on stdout | [`dev.dsf.log.data.console.out.enabled`](../bpe/configuration.md#dev-dsf-log-data-console-out-enabled) | [`DEV_DSF_LOG_DATA_CONSOLE_OUT_ENABLED`](../bpe/configuration.md#dev-dsf-log-data-console-out-enabled) | `false` | | ||
| | Style for stdout | [`dev.dsf.log.data.console.out.style`](../bpe/configuration.md#dev-dsf-log-data-console-out-style) | [`DEV_DSF_LOG_DATA_CONSOLE_OUT_STYLE`](../bpe/configuration.md#dev-dsf-log-data-console-out-style) | `TEXT` | | ||
| | Enable data logs on stderr | [`dev.dsf.log.data.console.err.enabled`](../bpe/configuration.md#dev-dsf-log-data-console-err-enabled) | [`DEV_DSF_LOG_DATA_CONSOLE_ERR_ENABLED`](../bpe/configuration.md#dev-dsf-log-data-console-err-enabled) | `false` | | ||
| | Style for stderr | [`dev.dsf.log.data.console.err.style`](../bpe/configuration.md#dev-dsf-log-data-console-err-style) | [`DEV_DSF_LOG_DATA_CONSOLE_ERR_STYLE`](../bpe/configuration.md#dev-dsf-log-data-console-err-style) | `TEXT` | | ||
|
|
||
| --- | ||
|
|
||
| ## BPMN Debug Logging | ||
|
|
||
| | Purpose | Property Key | Environment Variable | Default | | ||
| |---------|--------------|----------------------|---------| | ||
| | Log current DSF user | [`dev.dsf.bpe.debug.log.message.currentUser`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-currentuser) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_CURRENTUSER`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-currentuser) | `false` | | ||
| | Log SQL statements | [`dev.dsf.bpe.debug.log.message.dbStatement`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-dbstatement) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_DBSTATEMENT`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-dbstatement) | `false` | | ||
| | Log activity start | [`dev.dsf.bpe.debug.log.message.onActivityStart`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-onactivitystart) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_ONACTIVITYSTART`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-onactivitystart) | `false` | | ||
| | Log activity end | [`dev.dsf.bpe.debug.log.message.onActivityEnd`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-onactivityend) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_ONACTIVITYEND`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-onactivityend) | `false` | | ||
| | Log all variables | [`dev.dsf.bpe.debug.log.message.variables`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-variables) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_VARIABLES`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-variables) | `false` | | ||
| | Log local variables only | [`dev.dsf.bpe.debug.log.message.variablesLocal`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-variableslocal) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_VARIABLESLOCAL`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-variableslocal) | `false` | | ||
| | Log webservice requests | [`dev.dsf.bpe.debug.log.message.webserviceRequest`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-webservicerequest) | [`DEV_DSF_BPE_DEBUG_LOG_MESSAGE_WEBSERVICEREQUEST`](../bpe/configuration.md#dev-dsf-bpe-debug-log-message-webservicerequest) | `false` | | ||
|
|
||
|
|
||
| ## Logging Styles | ||
| The DSF logging system supports multiple output styles that can be selected independently for each logging channel (console, file, audit, data). | ||
| Every logger exposes a *.style property and a corresponding environment variable. | ||
|
|
||
| ### Text-Based Logging Styles | ||
| #### TEXT | ||
|
|
||
| Plain, unformatted text output (default for console output, used before DSF 2). | ||
|
|
||
| Use when: | ||
| - You want minimal overhead and simple logging. | ||
| - Logs are read directly on the system. | ||
|
|
||
| Avoid when: | ||
| - A log aggregation system is used. | ||
|
|
||
| #### TEXT_MDC | ||
|
|
||
| Plain text with MDC (Mapped Diagnostic Context) fields, such as: | ||
|
|
||
| - correlationId | ||
| - processInstanceId | ||
| - user | ||
| - requestId | ||
|
|
||
| Recommended for: | ||
| - Production file logs | ||
| - Debugging distributed workflows with correlation IDs | ||
|
|
||
| Not ideal for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - A log aggregation system is used. | ||
|
|
||
| #### TEXT_COLOR and TEXT_COLOR_MDC | ||
|
|
||
| ANSI-colored text output for terminals. | ||
|
|
||
| Recommended for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Local development | ||
| - Docker logs viewed directly with docker logs | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Developers who want fast visual distinction between INFO/WARN/ERROR | ||
|
|
||
| Avoid for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Log ingestion systems | ||
| - Consoles without ANSI escape code support | ||
|
|
||
|
|
||
| ### JSON-Based Logging Styles | ||
| We support the structured logging formats `JSON_LOGSTASH`, `JSON_ECS`(Elastic Common Schema), `JSON_GELF`(Graylog Extended Log Format), and `JSON_GCP` (Google Cloud Platform Logging). They all include Mapped Diagnostic Context information (e.g., process names, ids, ...) and should be used in combination with your log aggreation system of your choice. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| title: Logging | ||
| icon: config | ||
| --- | ||
|
|
||
| ## Introduction | ||
| The DSF FHIR Server provides two logging mechanisms: a **Standard Application Logger** and a dedicated | ||
| **Audit Logger** for compliance-relevant access events. DSF 2.0.0 introduces unified `*.enabled` flags, | ||
| extended output styles, and improved environment variable support. | ||
|
|
||
|
|
||
|
|
||
| ## Audit Logging | ||
|
|
||
|
|
||
|
|
||
| | Purpose | Property Key | Environment Variable | Default | | ||
| |---------|--------------|----------------------|---------| | ||
| | Enable audit logs on stderr | [`dev.dsf.log.audit.console.err.enabled`](./configuration.md#dev-dsf-log-audit-console-err-enabled) | [`DEV_DSF_LOG_AUDIT_CONSOLE_ERR_ENABLED`](./configuration.md#dev-dsf-log-audit-console-err-enabled) | `false` | | ||
| | Style for stderr | [`dev.dsf.log.audit.console.err.style`](./configuration.md#dev-dsf-log-audit-console-err-style) | [`DEV_DSF_LOG_AUDIT_CONSOLE_ERR_STYLE`](./configuration.md#dev-dsf-log-audit-console-err-style) | `TEXT` | | ||
| | Enable audit logs on stdout | [`dev.dsf.log.audit.console.out.enabled`](./configuration.md#dev-dsf-log-audit-console-out-enabled) | [`DEV_DSF_LOG_AUDIT_CONSOLE_OUT_ENABLED`](./configuration.md#dev-dsf-log-audit-console-out-enabled) | `false` | | ||
| | Style for stdout | [`dev.dsf.log.audit.console.out.style`](./configuration.md#dev-dsf-log-audit-console-out-style) | [`DEV_DSF_LOG_AUDIT_CONSOLE_OUT_STYLE`](./configuration.md#dev-dsf-log-audit-console-out-style) | `TEXT` | | ||
| | Enable audit log file | [`dev.dsf.log.audit.file.enabled`](./configuration.md#dev-dsf-log-audit-file-enabled) | [`DEV_DSF_LOG_AUDIT_FILE_ENABLED`](./configuration.md#dev-dsf-log-audit-file-enabled) | `true` | | ||
| | Style for audit log file | [`dev.dsf.log.audit.file.style`](./configuration.md#dev-dsf-log-audit-file-style) | [`DEV_DSF_LOG_AUDIT_FILE_STYLE`](./configuration.md#dev-dsf-log-audit-file-style) | `TEXT_MDC` | | ||
|
|
||
| --- | ||
|
|
||
| ## Standard Application Logging | ||
|
|
||
| | Purpose | Property Key | Environment Variable | Default | | ||
| |---------|--------------|----------------------|---------| | ||
| | External Log4j2 config | [`dev.dsf.log.config`](./configuration.md#dev-dsf-log-config) | [`DEV_DSF_LOG_CONFIG`](./configuration.md#dev-dsf-log-config) | `conf/log4j2.xml` | | ||
| | Enable stderr logging | [`dev.dsf.log.console.err.enabled`](./configuration.md#dev-dsf-log-console-err-enabled) | [`DEV_DSF_LOG_CONSOLE_ERR_ENABLED`](./configuration.md#dev-dsf-log-console-err-enabled) | `false` | | ||
| | Level for stderr | [`dev.dsf.log.console.err.level`](./configuration.md#dev-dsf-log-console-err-level) | [`DEV_DSF_LOG_CONSOLE_ERR_LEVEL`](./configuration.md#dev-dsf-log-console-err-level) | `INFO` | | ||
| | Style for stderr | [`dev.dsf.log.console.err.style`](./configuration.md#dev-dsf-log-console-err-style) | [`DEV_DSF_LOG_CONSOLE_ERR_STYLE`](./configuration.md#dev-dsf-log-console-err-style) | `TEXT_COLOR` | | ||
| | Enable stdout logging | [`dev.dsf.log.console.out.enabled`](./configuration.md#dev-dsf-log-console-out-enabled) | [`DEV_DSF_LOG_CONSOLE_OUT_ENABLED`](./configuration.md#dev-dsf-log-console-out-enabled) | `true` | | ||
| | Level for stdout | [`dev.dsf.log.console.out.level`](./configuration.md#dev-dsf-log-console-out-level) | [`DEV_DSF_LOG_CONSOLE_OUT_LEVEL`](./configuration.md#dev-dsf-log-console-out-level) | `INFO` | | ||
| | Style for stdout | [`dev.dsf.log.console.out.style`](./configuration.md#dev-dsf-log-console-out-style) | [`DEV_DSF_LOG_CONSOLE_OUT_STYLE`](./configuration.md#dev-dsf-log-console-out-style) | `TEXT_COLOR` | | ||
| | Enable file logging | [`dev.dsf.log.file.enabled`](./configuration.md#dev-dsf-log-file-enabled) | [`DEV_DSF_LOG_FILE_ENABLED`](./configuration.md#dev-dsf-log-file-enabled) | `true` | | ||
| | File log level | [`dev.dsf.log.file.level`](./configuration.md#dev-dsf-log-file-level) | [`DEV_DSF_LOG_FILE_LEVEL`](./configuration.md#dev-dsf-log-file-level) | `DEBUG` | | ||
| | File log style | [`dev.dsf.log.file.style`](./configuration.md#dev-dsf-log-file-style) | [`DEV_DSF_LOG_FILE_STYLE`](./configuration.md#dev-dsf-log-file-style) | `TEXT_MDC` | | ||
|
|
||
| ## Logging Styles | ||
| The DSF logging system supports multiple output styles that can be selected independently for each logging channel (console, file, audit, data). | ||
| Every logger exposes a *.style property and a corresponding environment variable. | ||
|
|
||
| ### Text-Based Logging Styles | ||
| #### TEXT | ||
|
|
||
| Plain, unformatted text output (default for console output, used before DSF 2). | ||
|
|
||
| Use when: | ||
| - You want minimal overhead and simple logging. | ||
| - Logs are read directly on the system. | ||
|
|
||
| Avoid when: | ||
| - A log aggregation system is used. | ||
|
|
||
| #### TEXT_MDC | ||
|
|
||
| Plain text with MDC (Mapped Diagnostic Context) fields, such as: | ||
|
|
||
| - correlationId | ||
| - processInstanceId | ||
| - user | ||
| - requestId | ||
|
|
||
| Recommended for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Production file logs | ||
| - Debugging distributed workflows with correlation IDs | ||
|
|
||
| Not ideal for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - A log aggregation system is used. | ||
|
|
||
| #### TEXT_COLOR and TEXT_COLOR_MDC | ||
|
|
||
| ANSI-colored text output for terminals. | ||
|
|
||
| Recommended for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Local development | ||
| - Docker logs viewed directly with docker logs | ||
| - Developers who want fast visual distinction between INFO/WARN/ERROR | ||
|
|
||
| Avoid for: | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Log ingestion systems | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Consoles without ANSI escape code support | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ### JSON-Based Logging Styles | ||
| We support the structured logging formats `JSON_LOGSTASH`, `JSON_ECS`(Elastic Common Schema), `JSON_GELF`(Graylog Extended Log Format), and `JSON_GCP` (Google Cloud Platform Logging). They all include Mapped Diagnostic Context information (e.g., process names, ids, ...) and should be used in combination with your log aggreation system of your choice. | ||
schwzr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.