Repository navigation
docs(audit): document the HEC audit destination - #164
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The HEC token assignment has invalid shell syntax in English and every translation.
Review effort: Balanced
Findings: 11
Open (11)
Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New Quote the HEC token placeholder in the bash example · New
What changed in this PR
Documents the new Semaphore Pro HEC audit destination alongside Syslog.
Changes:
- Adds HEC configuration, delivery semantics, and receiver examples.
- Updates the generated configuration reference.
- Synchronizes all ten translations.
| File | Description |
|---|---|
docs/admin-guide/audit-log.md |
Adds English HEC guidance. |
docs/reference/configuration.md |
Lists generated HEC options. |
i18n/de/.../audit-log.md |
Updates German translation. |
i18n/es/.../audit-log.md |
Updates Spanish translation. |
i18n/fr/.../audit-log.md |
Updates French translation. |
i18n/it/.../audit-log.md |
Updates Italian translation. |
i18n/ja/.../audit-log.md |
Updates Japanese translation. |
i18n/ko/.../audit-log.md |
Updates Korean translation. |
i18n/pt/.../audit-log.md |
Updates Portuguese translation. |
i18n/ru/.../audit-log.md |
Updates Russian translation. |
i18n/sr/.../audit-log.md |
Updates Serbian translation. |
i18n/zh/.../audit-log.md |
Updates Chinese translation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The required Structure and prose check currently fails because of translation drift outside this diff.
Review effort: Balanced
Findings: None
Resolved since last review (11)
Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example Quote the HEC token placeholder in the bash example
souryogurt
added this pull request to stack #166
October 6, 2026 07:16
souryogurt
force-pushed
the
feat/audit-log-hec
branch
from
October 7, 2026 05:13
769d6e7 to
8980e25
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.

Documents the HEC destination added to audit export in Semaphore Pro.
HEC delivery differs from Syslog: an event counts as sent only after a 2xx, everything else is retried.
The existing delivery notes that hold only for Syslog are now marked as Syslog-only. Indexer
acknowledgement is not supported, so the Splunk example says to keep it off for the token.
Product PR: semaphoreui/semaphore#4309