From 9b574baae59263b6bb1c9137205be7e0a8eb92cf Mon Sep 17 00:00:00 2001 From: sjvans <30337871+sjvans@users.noreply.github.com> Date: Fri, 15 Nov 2024 09:56:05 +0100 Subject: [PATCH 1/4] update audit-log presets --- guides/data-privacy/audit-logging.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/guides/data-privacy/audit-logging.md b/guides/data-privacy/audit-logging.md index e03a95a0d..f12d5a2df 100644 --- a/guides/data-privacy/audit-logging.md +++ b/guides/data-privacy/audit-logging.md @@ -47,13 +47,17 @@ npm add @cap-js/audit-logging { "audit-log": { "handle": [ "READ", "WRITE" ], + "outbox": true "[development]": { - "impl": "@cap-js/audit-logging/srv/audit-log-to-console", - "outbox": false + "impl": "@cap-js/audit-logging/srv/log2console" + }, + "[hybrid]": { + "impl": "@cap-js/audit-logging/srv/log2restv2", + "vcap": { "label": "auditlog" } }, "[production]": { - "impl": "@cap-js/audit-logging/srv/audit-log-to-restv2", - "outbox": true + "impl": "@cap-js/audit-logging/srv/log2restv2", + "vcap": { "label": "auditlog" } } } } @@ -65,7 +69,7 @@ npm add @cap-js/audit-logging - `outbox` — whether to use transactional outbox or not - `handle` — which events (`READ` and/or `WRITE`) to intercept and generate log messages from -**The preset uses profile-specific configurations** for development and production. Use the `cds env` command to find out the effective configuration for your current environment: +**The preset uses profile-specific configurations** for (hybrid) development and production. Use the `cds env` command to find out the effective configuration for your current environment: ::: code-group ```sh [w/o profile] From a07a576321c8a8c27f643bbc48794697d79a4c5d Mon Sep 17 00:00:00 2001 From: sjvans <30337871+sjvans@users.noreply.github.com> Date: Fri, 15 Nov 2024 09:57:56 +0100 Subject: [PATCH 2/4] #1443 --- guides/data-privacy/audit-logging.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/guides/data-privacy/audit-logging.md b/guides/data-privacy/audit-logging.md index f12d5a2df..e7b72c207 100644 --- a/guides/data-privacy/audit-logging.md +++ b/guides/data-privacy/audit-logging.md @@ -490,13 +490,12 @@ This provides an ultimate level of resiliency, plus additional benefits: - **False log messages are avoided** — messages are forwarded to the audit log service on successfully committed requests; and skipped in case of rollbacks. -This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring outbox: false in the configuration, for example, as we do in the default configuration for development: +This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring outbox: false in the configuration, for example, as shown in the following snippet for profile `development`: ```json { "audit-log": { "[development]": { - "impl": "@cap-js/audit-logging/srv/audit-log-to-console", "outbox": false // [!code focus] } } From 3a2df9419eea2bb3761dfbd0ca4df903fcac6841 Mon Sep 17 00:00:00 2001 From: Rene Jeglinsky Date: Tue, 19 Nov 2024 14:00:13 +0100 Subject: [PATCH 3/4] edit with new config feature --- guides/data-privacy/audit-logging.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/guides/data-privacy/audit-logging.md b/guides/data-privacy/audit-logging.md index e7b72c207..9c51b303a 100644 --- a/guides/data-privacy/audit-logging.md +++ b/guides/data-privacy/audit-logging.md @@ -490,14 +490,4 @@ This provides an ultimate level of resiliency, plus additional benefits: - **False log messages are avoided** — messages are forwarded to the audit log service on successfully committed requests; and skipped in case of rollbacks. -This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring outbox: false in the configuration, for example, as shown in the following snippet for profile `development`: - -```json -{ - "audit-log": { - "[development]": { - "outbox": false // [!code focus] - } - } -} -``` +This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring cds.audit-log,[development].outbox: false, for example, as we do in the default configuration for the `development` profile. From 84408b977c422dbf9c8671e694de7e3350786fa8 Mon Sep 17 00:00:00 2001 From: Rene Jeglinsky Date: Tue, 19 Nov 2024 14:00:57 +0100 Subject: [PATCH 4/4] typo --- guides/data-privacy/audit-logging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/data-privacy/audit-logging.md b/guides/data-privacy/audit-logging.md index 9c51b303a..a20682adf 100644 --- a/guides/data-privacy/audit-logging.md +++ b/guides/data-privacy/audit-logging.md @@ -490,4 +490,4 @@ This provides an ultimate level of resiliency, plus additional benefits: - **False log messages are avoided** — messages are forwarded to the audit log service on successfully committed requests; and skipped in case of rollbacks. -This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring cds.audit-log,[development].outbox: false, for example, as we do in the default configuration for the `development` profile. +This transparently applies to all implementations, even [custom implementations](#custom-implementation). You can opt out of this default by configuring cds.audit-log.[development].outbox = false, for example, as we do in the default configuration for the `development` profile.