Skip to main content

System - Kafka Events Meta Read

Endpoint​

/o/system/kafka/events/meta

Overview​

Returns distinct filter values for Kafka event logs: event types, consumer groups, topics, and cluster IDs.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Requires authenticated dashboard user access to management-read endpoints.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API key.
auth_tokenStringYes (or use api_key)Dashboard auth token.

Examples​

Example 1: Read Kafka events filter metadata​

/o/system/kafka/events/meta?api_key=YOUR_API_KEY
{
  "eventTypes": ["consume", "error"],
  "groupIds": ["countly-events"],
  "topics": ["events"],
  "clusterIds": ["cluster-a"]
}

Response​

Success Response​

{
  "eventTypes": ["consume", "commit", "error"],
  "groupIds": ["countly-events", "countly-sessions"],
  "topics": ["events", "sessions"],
  "clusterIds": ["cluster-a"]
}

Response Fields​

FieldTypeDescription
eventTypesArray of StringDistinct non-empty type values.
groupIdsArray of StringDistinct non-empty groupId values.
topicsArray of StringDistinct non-empty topic values.
clusterIdsArray of StringDistinct non-empty clusterId values.

Error Responses​

Status Code: 500 Internal Server Error

{
  "result": "Error fetching Kafka events meta"
}

Behavior​

Behavior Modes​

ModeTriggerResponse Shape
Cache hitRequest arrives within 30-second meta cache TTLCached meta object.
Cache missCache expired or not created yetRecomputed meta object from distinct queries.
Query failureDistinct query throwsWrapped error message.

Operational Considerations​

  • Metadata responses are cached in memory for 30 seconds.
  • Cache is shared per server process; values can differ briefly across multi-node deployments.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.kafka_consumer_eventsSource for filter value extraction.Reads distinct values of type, groupId, topic, clusterId.