Skip to content

Commit

Permalink
chore: document upcoming kafka func for audit events
Browse files Browse the repository at this point in the history 
Signed-off-by: Mark Phelps <[email protected]>
  • Loading branch information
@markphelps
markphelps committed Jul 12, 2024
1 parent a585306 commit dec21b2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
2 changes: 2 additions & 0 deletions configuration/auditing/overview.mdx
View file
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
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,20 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"
| 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 |

Check failure on line 447 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'avro'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'avro'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 447, "column": 94}}}, "severity": "ERROR"}
| 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/PLAIN username to access the Kafka broker | | v1.46.0 |
| audit.sinks.kafka.authentication.password | SASL/PLAIN password to access the Kafka broker | | v1.46.0 |

### Analytics

| Property | Description | Default | Since |
Expand Down

0 comments on commit dec21b2

Please sign in to comment.