Skip to content

kafka get-offset

Get offset for Kafka topic partition

Description

Get offset of a particular partition of kafka topic

Synopsis

kafka get-offset
    [--site <site>]
    [--cluster <cluster>]
    --topic <topic>
    <partition>
    [--offset_option <offset_option>]
    [--offset_time <offset_time>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Name of kafka cluster
     Example: --cluster "cluster-1"
     Default: default      Attributes: optional

topic - (string)

     Name of kafka topic
     Example: --topic "topic-1"
     Default: _None_      Attributes: required

partition - (int)

     Partition number
     Example: 1
     Default: _None_      Attributes: required

offset_option - (string)

     Value can be either "OLDEST" or "NEWEST"
     Example: --offset_option "OLDEST" , --offset_option "NEWEST"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: OLDEST, NEWEST

offset_time - (time)

     This gives the offset value at that point in time.
     Example: --offset_time "yesterday 9 pm"
     Default: _None_      Attributes: optional

Examples

Input: 

! kafka get-offset --topic "test-topic-1" 1 --offset_option "NEWEST"
Output: 
1

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "kafka"
Service Instance cluster
Namespace
Object Type "topic"
Object ID topic

Please see Access Control for details.