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

chore: document upcoming kafka func for audit events #245

Merged
merged 2 commits into from
Jul 15, 2024
Merged

chore: document upcoming kafka func for audit events #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dec21b2
chore: document upcoming kafka func for audit events
markphelps Jul 12, 2024
f2117e2
chore: docs updates
markphelps Jul 13, 2024
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
1 change: 1 addition & 0 deletions .vale/styles/Flipt/spelling-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
affordance
APIs
auditable
avro
azblob
backoff
boolean
Expand Down
2 changes: 2 additions & 0 deletions configuration/auditing/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Currently, we support the following sinks for audit events:

- [Webhook](/configuration/overview#audit-events-webhook): the audit events are sent to a URL of your choice.

- [Kafka](/configuration/overview#audit-events-kafka): the audit events are sent to a Kafka topic of your choice.

You can find [examples](https://github.com/flipt-io/flipt/tree/main/examples/audit) in the main GitHub repository on how to enable audit events and how to tune configuration for it.

## Event Filtering
Expand Down
14 changes: 14 additions & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,20 @@
| audit.sinks.webhook.max_backoff_duration | Max exponential backoff duration for sending webhook upon failure | 15s | v1.27.0 |
| audit.sinks.webhook.templates[] | List of webhook templates for Flipt to send audit events to | | v1.28.0 |

#### Audit Events: Kafka

Check warning on line 440 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Audit Events: Kafka' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Audit Events: Kafka' should be in sentence case", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 440, "column": 6}}}, "severity": "WARNING"}

| Property | Description | Default | Since |
| ----------------------------------------- | ---------------------------------------------------- | -------- | ------- |
| audit.sinks.kafka.enabled | Enable Kafka sink | false | v1.46.0 |
| audit.sinks.kafka.topic | Kafka topic to send audit events to | | v1.46.0 |
| audit.sinks.kafka.bootstrap_servers | Kafka bootstrap servers | | v1.46.0 |
| audit.sinks.kafka.encoding | Encoding to use for events in Kafka (protobuf, avro) | protobuf | v1.46.0 |
| audit.sinks.kafka.schema_registry.url | URL to the schema registry for encoding | | v1.46.0 |

Check warning on line 448 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 448, "column": 47}}}, "severity": "WARNING"}
| audit.sinks.kafka.require_tls | Require TLS to access the Kafka broker | false | v1.46.0 |
| audit.sinks.kafka.insecure_skip_tls | Skip verifying the server's certificate chain | false | v1.46.0 |
| audit.sinks.kafka.authentication.username | SASL/SCRAM username to access the Kafka broker | | v1.46.0 |
| audit.sinks.kafka.authentication.password | SASL/SCRAM password to access the Kafka broker | | v1.46.0 |

### Analytics

| Property | Description | Default | Since |
Expand Down
Loading