Skip to content

docs(audit): document the HEC audit destination - #164

Merged
fiftin merged 3 commits into
mainfrom
feat/audit-log-hec
Oct 7, 2026
Merged

fiftin merged 3 commits into
mainfrom
feat/audit-log-hec

Conversation

@souryogurt

@souryogurt souryogurt commented Oct 4, 2026 •

Copy link
Copy Markdown
Collaborator

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The HEC token assignment has invalid shell syntax in English and every translation.

Review effort: Balanced
Findings: 11 Low severity

Open (11)
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.

Comment thread docs/admin-guide/audit-log.md Outdated
Comment thread i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
Comment thread i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md Outdated
@souryogurt souryogurt self-assigned this Oct 4, 2026
@souryogurt
souryogurt requested review from fiftin and a balanced review from Copilot October 4, 2026 22:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@souryogurt
souryogurt added this pull request to stack #166 October 6, 2026 07:16
@fiftin
fiftin merged commit 9f282b6 into main Oct 7, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants