Skip to main content
Quick navigation

Limit Commit Offset Policy

Introduction

Limit Commit Offset Policy limits commit offset attempts on the same groupId within a minute.

If commit offset attempts hit more than limitation in specific duration, it will respond PolicyViolationException.

Configuration

keytypeDefaultdescription
groupIdString.*groupId regex, groupId that match this regex will have the interceptor applied.
maximumCommitsPerMinuteintMaximum commit offset attempts on the same groupId within a minute
actionActionBLOCKAction to take if the value is outside the specified range.
throttleTimeMsint100Value to throttle with (only applicable when action is set to THROTTLE).

Action

  • BLOCK → when fail, save in audit and return error.
  • INFO → execute API with wrong value, save in audit.
  • THROTTLE → when fail, save in audit and the request will be throttled with time = throttleTimeMs.

Example

{
"name": "limit-commit-offset-policy",
"pluginClass": "io.conduktor.gateway.interceptor.safeguard.LimitCommitOffsetPolicyPlugin",
"priority": 100,
"config": {
"groupId": "myGroupId.*",
"maximumCommitsPerMinute": 5,
"action": "BLOCK"
}
}