Skip to content
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

Document ServiceControl.Audit/IngestAuditMessages #7023

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document ServiceControl.Audit/IngestAuditMessages #7023

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
18 changes: 18 additions & 0 deletions servicecontrol/audit-instances/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,25 @@ Controls the maximum time delay to wait before restarting the audit ingestion pi

Valid settings are between 5 seconds and 1 hour.

### ServiceControl.Audit/IngestAuditMessages

Set to `false` to disable ingesting new audit messages. Useful in some upgrade scenarios.

| Context | Name |
| --- | --- |
| **Environment variable** | `SERVICECONTROL_AUDIT_INGESTAUDITMESSAGES` |
| **App config key** | `ServiceControl.Audit/IngestAuditMessages` |
| **SCMU field** | N/A |

| Type | Default value |
| --- | --- |
| bool | `true` |

### ServiceControl/IngestAuditMessages

> [!WARNING]
> This is the same setting as `ServiceControl.Audit/IngestAuditMessages` but kept for backward compatibility

Set to `false` to disable ingesting new audit messages. Useful in some upgrade scenarios.

| Context | Name |
Expand All @@ -251,6 +268,7 @@ Set to `false` to disable ingesting new audit messages. Useful in some upgrade s
| --- | --- |
| bool | `true` |


## Data retention

### ServiceControl.Audit/ExpirationProcessTimerInSeconds
Expand Down