Skip to content

Add documentation on binding cache validation #724

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

Merged
chombium merged 1 commit into from
Jul 10, 2026
Merged

Add documentation on binding cache validation #724

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
2 changes: 2 additions & 0 deletions docs/syslog-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
An agent that forwards app logs to a syslog drain. Drains are registered by binding User Provided Services to apps.
Any logs coming from a registered app are forwarded to the configured endpoint.

The Syslog Binding Cache validates the Syslog Drain URL defined by the application developers and informs them in case they have misconfigured something. It also provides the following two metrics: `blacklisted_drains` (number of drains configured to blacklisted destinations) and `invalid_drains` (total amount of misconfigured drains, including blacklisted ones). The Syslog Agent should always get valid drains, but it validates the drains itself as well as a safeguard against tampering of the Syslog Binding Cache API. If something goes wrong, the Syslog Agent will write logs stating that something went wrong and advising the operator to check the Syslog Binding Cache.

#### Deploying Syslog Agent

To deploy syslog agent, add the following jobs to all instance groups and the variables to the variables section.
Expand Down
Loading