Skip to content

Commit a3b79a1

Browse files
hhundhhund
committed
log config parameters, fixed typos
1 parent b7b4080 commit a3b79a1

File tree

2 files changed

+236
-12
lines changed

2 files changed

+236
-12
lines changed

‎docs/src/operations/v2.0.0-RC1/bpe/configuration.md‎

Lines changed: 121 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ icon: config
176176
- **Property:** dev.dsf.bpe.fhir.client.connections.config.default.enable.debug.logging
177177
- **Required:** No
178178
- **Description:** FHIR server connections YAML: Default value for properties `enable-debug-logging` and `oidc-auth.enable-debug-logging`
179-
- **Recommendation:** To enable debug logging of requests and reponses to configured FHIR servers by default set to `true`
179+
- **Recommendation:** To enable debug logging of requests and responses to configured FHIR servers by default set to `true`
180180
- **Default:** `false`
181181

182182

@@ -229,14 +229,14 @@ icon: config
229229
### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE
230230
- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache
231231
- **Required:** No
232-
- **Description:** Set `false` to disable caching of OIDC dicovery and jwks resources as well as access tokens in the 'Client Credentials Grant' client; access tokens are evicted 10 seconds before they expire
232+
- **Description:** Set `false` to disable caching of OIDC discovery and jwks resources as well as access tokens in the 'Client Credentials Grant' client; access tokens are evicted 10 seconds before they expire
233233
- **Default:** `true`
234234

235235

236236
### DEV_DSF_BPE_FHIR_CLIENT_CONNECTIONS_CONFIG_OIDC_CACHE_TIMEOUT_ACCESS_TOKEN
237237
- **Property:** dev.dsf.bpe.fhir.client.connections.config.oidc.cache.timeout.access.token
238238
- **Required:** No
239-
- **Description:** OIDC 'Client Credentials Grant' client cache timeout of access tokens before they expire, duration is subtracted from the expires at value of the acess token
239+
- **Description:** OIDC 'Client Credentials Grant' client cache timeout of access tokens before they expire, duration is subtracted from the expires at value of the access token
240240
- **Default:** `PT10S`
241241

242242

@@ -407,7 +407,7 @@ icon: config
407407
- **Property:** dev.dsf.bpe.mail.password
408408
- **Required:** No
409409
- **Description:** SMTP server authentication password
410-
- **Recommendation:** Configure if the SMTP server reqiures username/password authentication; use docker secret file to configure using *DEV_DSF_BPE_MAIL_PASSWORD_FILE*; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS*
410+
- **Recommendation:** Configure if the SMTP server requires username/password authentication; use docker secret file to configure using *DEV_DSF_BPE_MAIL_PASSWORD_FILE*; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS*
411411

412412

413413
### DEV_DSF_BPE_MAIL_PORT
@@ -482,7 +482,7 @@ icon: config
482482
- **Property:** dev.dsf.bpe.mail.username
483483
- **Required:** No
484484
- **Description:** SMTP server authentication username
485-
- **Recommendation:** Configure if the SMTP server reqiures username/password authentication; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS*
485+
- **Recommendation:** Configure if the SMTP server requires username/password authentication; enable SMTP over TLS via *DEV_DSF_BPE_MAIL_USESMTPS*
486486

487487

488488
### DEV_DSF_BPE_MAIL_USESMTPS
@@ -495,7 +495,7 @@ icon: config
495495
### DEV_DSF_BPE_PROCESS_API_ALLOWED_BPE_CLASSES
496496
- **Property:** dev.dsf.bpe.process.api.allowed.bpe.classes
497497
- **Required:** No
498-
- **Description:** Map with files containing qualified classs names allowed to be loaded by plugins for api versions; map key must match v([1-9]+[0-9]*)
498+
- **Description:** Map with files containing qualified class names allowed to be loaded by plugins for api versions; map key must match v([1-9]+[0-9]*)
499499
- **Recommendation:** Change only during development
500500
- **Example:** `{v1: 'some/example.file', v2: 'other.file'}`
501501
- **Default:** `{:}`
@@ -632,13 +632,125 @@ icon: config
632632
### DEV_DSF_BPE_SERVER_UI_THEME
633633
- **Property:** dev.dsf.bpe.server.ui.theme
634634
- **Required:** No
635-
- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments im configured; supported values: `dev`, `test` and `prod`
635+
- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments if configured; supported values: `dev`, `test` and `prod`
636+
637+
638+
### DEV_DSF_LOG_CONFIG
639+
- **Property:** dev.dsf.log.config
640+
- **Required:** No
641+
- **Description:** Location of a log4j configuration xml file; if file is readable, overrides configuration specified via *DEV_DSF_LOG_...* parameters
642+
- **Default:** `conf/log4j2.xml`
643+
644+
645+
### DEV_DSF_LOG_CONSOLE_ERR_ENABLED
646+
- **Property:** dev.dsf.log.console.err.enabled
647+
- **Required:** No
648+
- **Description:** Set to `true` to enable console err output of the standard logger
649+
- **Default:** `false`
650+
651+
652+
### DEV_DSF_LOG_CONSOLE_ERR_LEVEL
653+
- **Property:** dev.dsf.log.console.err.level
654+
- **Required:** No
655+
- **Description:** Standard logger console err output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
656+
- **Default:** `INFO`
657+
658+
659+
### DEV_DSF_LOG_CONSOLE_ERR_STYLE
660+
- **Property:** dev.dsf.log.console.err.style
661+
- **Required:** No
662+
- **Description:** Standard logger console err output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR`
663+
- **Default:** `TEXT_COLOR`
664+
665+
666+
### DEV_DSF_LOG_CONSOLE_OUT_ENABLED
667+
- **Property:** dev.dsf.log.console.out.enabled
668+
- **Required:** No
669+
- **Description:** Set to `false` to disable console out output of the standard logger
670+
- **Default:** `true`
671+
672+
673+
### DEV_DSF_LOG_CONSOLE_OUT_LEVEL
674+
- **Property:** dev.dsf.log.console.out.level
675+
- **Required:** No
676+
- **Description:** Standard logger console out output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
677+
- **Default:** `INFO`
678+
679+
680+
### DEV_DSF_LOG_CONSOLE_OUT_STYLE
681+
- **Property:** dev.dsf.log.console.out.style
682+
- **Required:** No
683+
- **Description:** Standard logger console out output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR`
684+
- **Default:** `TEXT_COLOR`
685+
686+
687+
### DEV_DSF_LOG_DATA_CONSOLE_ERR_ENABLED
688+
- **Property:** dev.dsf.log.data.console.err.enabled
689+
- **Required:** No
690+
- **Description:** Set to `true` to enable console err output of the special data logger; the data logger can be used by process plugins to log sensitive data
691+
- **Default:** `false`
692+
693+
694+
### DEV_DSF_LOG_DATA_CONSOLE_ERR_STYLE
695+
- **Property:** dev.dsf.log.data.console.err.style
696+
- **Required:** No
697+
- **Description:** Special data logger console err style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
698+
- **Default:** `TEXT`
699+
700+
701+
### DEV_DSF_LOG_DATA_CONSOLE_OUT_ENABLED
702+
- **Property:** dev.dsf.log.data.console.out.enabled
703+
- **Required:** No
704+
- **Description:** Set to `true` to enable console out output of the special data logger; the data logger can be used by process plugins to log sensitive data
705+
- **Default:** `false`
706+
707+
708+
### DEV_DSF_LOG_DATA_CONSOLE_OUT_STYLE
709+
- **Property:** dev.dsf.log.data.console.out.style
710+
- **Required:** No
711+
- **Description:** Special data logger console out style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
712+
- **Default:** `TEXT`
713+
714+
715+
### DEV_DSF_LOG_DATA_FILE_ENABLED
716+
- **Property:** dev.dsf.log.data.file.enabled
717+
- **Required:** No
718+
- **Description:** Set to `true` to enable log file output of the special data logger; the data logger can be used by process plugins to log sensitive data
719+
- **Default:** `false`
720+
721+
722+
### DEV_DSF_LOG_DATA_FILE_STYLE
723+
- **Property:** dev.dsf.log.data.file.style
724+
- **Required:** No
725+
- **Description:** Special data logger file style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
726+
- **Default:** `TEXT`
727+
728+
729+
### DEV_DSF_LOG_FILE_ENABLED
730+
- **Property:** dev.dsf.log.file.enabled
731+
- **Required:** No
732+
- **Description:** Set to `false` to disable log file output of the standard logger
733+
- **Default:** `true`
734+
735+
736+
### DEV_DSF_LOG_FILE_LEVEL
737+
- **Property:** dev.dsf.log.file.level
738+
- **Required:** No
739+
- **Description:** Standard logger log file output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
740+
- **Default:** `DEBUG`
741+
742+
743+
### DEV_DSF_LOG_FILE_STYLE
744+
- **Property:** dev.dsf.log.file.style
745+
- **Required:** No
746+
- **Description:** Standard logger log file output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
747+
- **Default:** `TEXT_MDC`
636748

637749

638750
### DEV_DSF_PROXY_NOPROXY
639751
- **Property:** dev.dsf.proxy.noProxy
640752
- **Required:** No
641-
- **Description:** Forward proxy no-proxy list, entries will match exactly or agianst (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported
753+
- **Description:** Forward proxy no-proxy list, entries will match exactly or against (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported
642754
- **Example:** `foo.bar, test.com:8080`
643755

644756

@@ -783,7 +895,7 @@ icon: config
783895
### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_DISCOVERY_PATH
784896
- **Property:** dev.dsf.server.auth.oidc.provider.discovery.path
785897
- **Required:** No
786-
- **Description:** OIDC provider dicovery path
898+
- **Description:** OIDC provider discovery path
787899
- **Default:** `/.well-known/openid-configuration`
788900

789901

‎docs/src/operations/v2.0.0-RC1/fhir/configuration.md‎

Lines changed: 115 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,13 +220,125 @@ icon: config
220220
### DEV_DSF_FHIR_SERVER_UI_THEME
221221
- **Property:** dev.dsf.fhir.server.ui.theme
222222
- **Required:** No
223-
- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments im configured; supported values: `dev`, `test` and `prod`
223+
- **Description:** UI theme parameter, adds a color indicator to the ui to distinguish `dev`, `test` and `prod` environments if configured; supported values: `dev`, `test` and `prod`
224+
225+
226+
### DEV_DSF_LOG_AUDIT_CONSOLE_ERR_ENABLED
227+
- **Property:** dev.dsf.log.audit.console.err.enabled
228+
- **Required:** No
229+
- **Description:** Set to `true` to enable console err output of the audit logger
230+
- **Default:** `false`
231+
232+
233+
### DEV_DSF_LOG_AUDIT_CONSOLE_ERR_STYLE
234+
- **Property:** dev.dsf.log.audit.console.err.style
235+
- **Required:** No
236+
- **Description:** Audit logger console err style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
237+
- **Default:** `STYLE_TEXT`
238+
239+
240+
### DEV_DSF_LOG_AUDIT_CONSOLE_OUT_ENABLED
241+
- **Property:** dev.dsf.log.audit.console.out.enabled
242+
- **Required:** No
243+
- **Description:** Set to `true` to enable console out output of the audit logger
244+
- **Default:** `false`
245+
246+
247+
### DEV_DSF_LOG_AUDIT_CONSOLE_OUT_STYLE
248+
- **Property:** dev.dsf.log.audit.console.out.style
249+
- **Required:** No
250+
- **Description:** Audit logger console out style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
251+
- **Default:** `STYLE_TEXT`
252+
253+
254+
### DEV_DSF_LOG_AUDIT_FILE_ENABLED
255+
- **Property:** dev.dsf.log.audit.file.enabled
256+
- **Required:** No
257+
- **Description:** Set to `false` to disable log file output of the audit logger
258+
- **Default:** `true`
259+
260+
261+
### DEV_DSF_LOG_AUDIT_FILE_STYLE
262+
- **Property:** dev.dsf.log.audit.file.style
263+
- **Required:** No
264+
- **Description:** Audit logger file style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
265+
- **Default:** `TEXT_MDC`
266+
267+
268+
### DEV_DSF_LOG_CONFIG
269+
- **Property:** dev.dsf.log.config
270+
- **Required:** No
271+
- **Description:** Location of a log4j configuration xml file; if file is readable, overrides configuration specified via *DEV_DSF_LOG_...* parameters
272+
- **Default:** `conf/log4j2.xml`
273+
274+
275+
### DEV_DSF_LOG_CONSOLE_ERR_ENABLED
276+
- **Property:** dev.dsf.log.console.err.enabled
277+
- **Required:** No
278+
- **Description:** Set to `true` to enable console err output of the standard logger
279+
- **Default:** `false`
280+
281+
282+
### DEV_DSF_LOG_CONSOLE_ERR_LEVEL
283+
- **Property:** dev.dsf.log.console.err.level
284+
- **Required:** No
285+
- **Description:** Standard logger console err output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
286+
- **Default:** `INFO`
287+
288+
289+
### DEV_DSF_LOG_CONSOLE_ERR_STYLE
290+
- **Property:** dev.dsf.log.console.err.style
291+
- **Required:** No
292+
- **Description:** Standard logger console err output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR`
293+
- **Default:** `TEXT_COLOR`
294+
295+
296+
### DEV_DSF_LOG_CONSOLE_OUT_ENABLED
297+
- **Property:** dev.dsf.log.console.out.enabled
298+
- **Required:** No
299+
- **Description:** Set to `false` to disable console out output of the standard logger
300+
- **Default:** `true`
301+
302+
303+
### DEV_DSF_LOG_CONSOLE_OUT_LEVEL
304+
- **Property:** dev.dsf.log.console.out.level
305+
- **Required:** No
306+
- **Description:** Standard logger console out output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
307+
- **Default:** `INFO`
308+
309+
310+
### DEV_DSF_LOG_CONSOLE_OUT_STYLE
311+
- **Property:** dev.dsf.log.console.out.style
312+
- **Required:** No
313+
- **Description:** Standard logger console out output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`, `TEXT_COLOR_MDC`, `TEXT_COLOR`
314+
- **Default:** `TEXT_COLOR`
315+
316+
317+
### DEV_DSF_LOG_FILE_ENABLED
318+
- **Property:** dev.dsf.log.file.enabled
319+
- **Required:** No
320+
- **Description:** Set to `false` to disable log file output of the standard logger
321+
- **Default:** `true`
322+
323+
324+
### DEV_DSF_LOG_FILE_LEVEL
325+
- **Property:** dev.dsf.log.file.level
326+
- **Required:** No
327+
- **Description:** Standard logger log file output level, one of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`
328+
- **Default:** `DEBUG`
329+
330+
331+
### DEV_DSF_LOG_FILE_STYLE
332+
- **Property:** dev.dsf.log.file.style
333+
- **Required:** No
334+
- **Description:** Standard logger log file output style, one of: `JSON_ECS`, `JSON_GCP`, `JSON_GELF`, `JSON_LOGSTASH`, `TEXT_MDC`, `TEXT`
335+
- **Default:** `TEXT_MDC`
224336

225337

226338
### DEV_DSF_PROXY_NOPROXY
227339
- **Property:** dev.dsf.proxy.noProxy
228340
- **Required:** No
229-
- **Description:** Forward proxy no-proxy list, entries will match exactly or agianst (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported
341+
- **Description:** Forward proxy no-proxy list, entries will match exactly or against (one level) sub-domains, if no port is specified - all ports are matched; comma or space separated list, YAML block scalars supported
230342
- **Example:** `foo.bar, test.com:8080`
231343

232344

@@ -371,7 +483,7 @@ icon: config
371483
### DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_DISCOVERY_PATH
372484
- **Property:** dev.dsf.server.auth.oidc.provider.discovery.path
373485
- **Required:** No
374-
- **Description:** OIDC provider dicovery path
486+
- **Description:** OIDC provider discovery path
375487
- **Default:** `/.well-known/openid-configuration`
376488

377489

0 commit comments

Comments
 (0)