> For the complete documentation index, see [llms.txt](https://docs.warpstream.com/warpstream/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.warpstream.com/warpstream/reference/api-reference/client-metrics.md).

# Client Metrics

These APIs let you manage [KIP-714 client metrics subscriptions](/warpstream/kafka/configure-kafka-client/client-metrics-kip-714.md) on a WarpStream virtual cluster. A subscription is a named record that tells matching Kafka clients to push their internal producer/consumer metrics to the cluster on a schedule.

The same subscriptions are also manageable via the Kafka AdminClient (`kafka-configs.sh --entity-type client-metrics`). Both paths read and write the same store, so subscriptions you create with one are visible to the other.

## Subscription fields

Each subscription has a name and three configurable fields:

| Field         | Description                                                                                                                              |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `name`        | Subscription name. Required.                                                                                                             |
| `interval_ms` | How often matched clients push, in milliseconds. Default 300000 (5 minutes). Min 100, max 3600000 (1 hour).                              |
| `metrics`     | Comma-separated list of metric-name prefixes the client should send. An empty value means "all metrics".                                 |
| `match`       | Comma-separated list of `key=regex` selectors that pick which clients this subscription applies to. An empty value matches every client. |

Match keys: `client_instance_id`, `client_id`, `client_software_name`, `client_software_version`, `client_source_address`, `client_source_port`. Patterns are full-string regex anchored as `^(?:pattern)$`. See [Client Metrics (KIP-714)](/warpstream/kafka/configure-kafka-client/client-metrics-kip-714.md#match-selectors) for details and gotchas.

## Authentication

All endpoints accept application keys. The list and describe endpoints additionally accept read-only keys; the update and delete endpoints require admin permissions.

## Limits

Up to 100 subscriptions are allowed per virtual cluster.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.warpstream.com/warpstream/reference/api-reference/client-metrics.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.