You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/operations/v2.0.0/bpe/logging.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,11 +62,11 @@ Every logger exposes a *.style property and a corresponding environment variable
62
62
Plain, unformatted text output (default for console output, used before DSF 2).
63
63
64
64
Use when:
65
-
- You want minimal overhead and simple logging.
66
-
- Logs are read directly on the system.
65
+
- You want minimal overhead and simple logging
66
+
- Logs are read directly on the system
67
67
68
68
Avoid when:
69
-
- A log aggregation system is used.
69
+
- A log aggregation system is used
70
70
71
71
#### TEXT_MDC
72
72
@@ -77,26 +77,26 @@ Plain text with MDC (Mapped Diagnostic Context) fields, such as:
77
77
- user
78
78
- requestId
79
79
80
-
Recommended for:
81
-
-Production file logs
82
-
-Debugging distributed workflows with correlation IDs
80
+
Use when:
81
+
-You want to log production environments without aggregation systems
82
+
-You want to debug distributed workflows with correlation IDs
83
83
84
-
Not ideal for:
85
-
- A log aggregation system is used.
84
+
Avoid when:
85
+
- A log aggregation system is used
86
86
87
87
#### TEXT_COLOR and TEXT_COLOR_MDC
88
88
89
89
ANSI-colored text output for terminals.
90
90
91
-
Recommended for:
92
-
-Local development
93
-
-Docker logs viewed directly with docker logs
94
-
-Developers who want fast visual distinction between INFO/WARN/ERROR
91
+
Use when:
92
+
-You want to develop locally
93
+
-You want to view docker logs directly with `docker logs` command
94
+
-You want a fast visual distinction between INFO/WARN/ERROR
95
95
96
-
Avoid for:
97
-
-Log ingestion systems
98
-
- Consoles without ANSI escape code support
96
+
Avoid when:
97
+
-A log aggregation system is used
98
+
- Consoles without ANSI escape code support are used
99
99
100
100
101
101
### JSON-Based Logging Styles
102
-
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.
102
+
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 the log aggreation system of your choice.
Copy file name to clipboardExpand all lines: docs/src/operations/v2.0.0/fhir/access-control.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,7 @@ DSF roles specified via the `dsf-role` property define general access to the RES
81
81
In order to allow users to start processes, the property `practitioner-role` can be used to assign codes from FHIR [CodeSystem](http://hl7.org/fhir/R4/codesystem.html) resources. Codes are specified in the form `system-url|code`.
82
82
If the uses has a code specified here that match with a `requester` extension within the process plugin's [ActivityDefinition](http://hl7.org/fhir/R4/activitydefinition.html) resource, the user can start the process if he also has the `dsf-role` `CREATE`.
83
83
84
-
Process plugins can defined and use there own code-systems. However, the DSF specifies a standard set of practitioner roles within the CodeSystem `http://dsf.dev/fhir/CodeSystem/practitioner-role`:
84
+
Process plugins can define and use their own code-systems. However, the DSF specifies a standard set of practitioner roles within the CodeSystem `http://dsf.dev/fhir/CodeSystem/practitioner-role`:
@@ -109,17 +109,19 @@ The first example defines a group of DSF administrators. Two client certificates
109
109
```
110
110
111
111
112
-
The second example defines a group of DSF administrators by specifying an `admin` role that gets matched against OAuth 2.0 access tokens:
112
+
The second example defines an administrator group consisting of all users with the OAuth role admin plus two additional administrators identified by their client-certificate thumbprints. These administrators may perform the basic DSF tasks: starting and continuing of new process instances (by creating tasks and answering QuestionnaireResponses) and reading all resources on the DSF FHIR server.
Copy file name to clipboardExpand all lines: docs/src/operations/v2.0.0/fhir/logging.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,11 +50,11 @@ Every logger exposes a *.style property and a corresponding environment variable
50
50
Plain, unformatted text output (default for console output, used before DSF 2).
51
51
52
52
Use when:
53
-
- You want minimal overhead and simple logging.
54
-
- Logs are read directly on the system.
53
+
- You want minimal overhead and simple logging
54
+
- Logs are read directly on the system
55
55
56
56
Avoid when:
57
-
- A log aggregation system is used.
57
+
- A log aggregation system is used
58
58
59
59
#### TEXT_MDC
60
60
@@ -65,26 +65,26 @@ Plain text with MDC (Mapped Diagnostic Context) fields, such as:
65
65
- user
66
66
- requestId
67
67
68
-
Recommended for:
69
-
-Production file logs
70
-
-Debugging distributed workflows with correlation IDs
68
+
Use when:
69
+
-You want to log production environments without aggregation systems
70
+
-You want to debug distributed workflows with correlation IDs
71
71
72
-
Not ideal for:
73
-
- A log aggregation system is used.
72
+
Avoid when:
73
+
- A log aggregation system is used
74
74
75
75
#### TEXT_COLOR and TEXT_COLOR_MDC
76
76
77
77
ANSI-colored text output for terminals.
78
78
79
-
Recommended for:
80
-
-Local development
81
-
-Docker logs viewed directly with docker logs
82
-
-Developers who want fast visual distinction between INFO/WARN/ERROR
79
+
Use when:
80
+
-You want to develop locally
81
+
-You want to view docker logs directly with `docker logs` command
82
+
-You want a fast visual distinction between INFO/WARN/ERROR
83
83
84
-
Avoid for:
85
-
-Log ingestion systems
86
-
- Consoles without ANSI escape code support
84
+
Avoid when:
85
+
-A log aggregation system is used
86
+
- Consoles without ANSI escape code support are used
87
87
88
88
89
89
### JSON-Based Logging Styles
90
-
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.
90
+
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 the log aggreation system of your choice.
Copy file name to clipboardExpand all lines: docs/src/operations/v2.0.0/upgrade-from-1.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,16 +22,18 @@ For DSF 2, we refined the [system requirements](install.md#prerequisites). If yo
22
22
23
23
::: info Non-standard configuration changes
24
24
25
-
The most non-standard configuration changes working in DSF 1 will continue to work in DSF 2. If you have set custom timeout options please change them to the ISO 8601 standard. `120000` (Milliseconds) must be changed to `PT2M`.
25
+
Most non-standard configuration changes working in DSF 1 will continue to work in DSF 2. If you have set custom timeout options please change them to the ISO 8601 standard. `120000` (Milliseconds) must be changed to `PT2M`.
26
26
27
27
- You can now use more advanced [logging options](./fhir/logging.md).
28
28
- If you use your own certificate authority, the [configuration](root-certificates.md) will be easier.
29
-
-If can now use more fine granular access control settings in your own[access control / role config settings](./fhir/access-control.md).
29
+
-More granular control in[access control / role config settings](./fhir/access-control.md).
30
30
:::
31
31
32
32
We recommend upgrading the PostgreSQL DBMS from version 15 to version 18. At present, it is possible to use PostgreSQL version 15, but we exclusively support PostgreSQL version 18 and test the DSF solely with version 18.
33
33
The DBMS upgrade is described below in the update instructions.
34
34
35
+
DSF 2 was designed to run DSF 1 (APIv1) process plugins, but due to stricter validation rules in DSF 2 we strongly recommend using the latest compatible plugin versions. Updates within the same major and minor version (e.g., from 1.2.3.4 to 1.2.9.9) are generally safe. An overview of the recommended MII/NUM versions can be found [here](./install-plugins.md).
36
+
35
37
## Modify DSF FHIR Server Setup
36
38
1. Preparation / Backup
37
39
* We recommend to create a backup of the `/opt/fhir` directory before proceeding with the upgrade.
0 commit comments