Skip to content

Commit

Permalink
Add Documentation for excludePersistentLag (#984)
Browse files Browse the repository at this point in the history
Signed-off-by: JosephABC <josephangbc@gmail.com>
  • Loading branch information
josephangbc authored Dec 8, 2022
1 parent 88caea1 commit 8f6def8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions content/docs/2.9/scalers/apache-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ triggers:
offsetResetPolicy: latest
allowIdleConsumers: false
scaleToZeroOnInvalidOffset: false
excludePersistentLag: false
version: 1.0.0
```
Expand All @@ -47,6 +48,7 @@ partitions on a topic, allowing for idle consumers. (Default: `false`, Optional)
- `scaleToZeroOnInvalidOffset` - This parameter controls what the scaler does when a partition doesn't have a valid offset.
If 'false' (the default), the scaler will keep a single consumer for that partition. Otherwise ('true'), the consumers for that
partition will be scaled to zero. See the [discussion](https://github.com/kedacore/keda/issues/2612) about this parameter.
- `excludePersistentLag` - When set to `true`, the scaler will exclude partition lag for partitions which current offset is the same as the current offset of the previous polling cycle. This parameter is useful to prevent scaling due to partitions which current offset message is unable to be consumed. If `false` (the default), scaler will include all consumer lag in all partitions as per normal. (Default: `false`, Optional)
- `version` - Version of your Kafka brokers. See [samara](https://github.com/Shopify/sarama) version (Default: `1.0.0`, Optional)

> **Note:**
Expand Down

0 comments on commit 8f6def8

Please sign in to comment.