> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Endpoint de métricas do Prometheus no ClickHouse: exponha as métricas do servidor em uma porta dedicada para coleta.

# Endpoint de métricas do Prometheus

O ClickHouse expõe suas próprias métricas em uma porta dedicada, no formato de texto do Prometheus, para que um servidor Prometheus possa coletá-las.

Para armazenar métricas do Prometheus no ClickHouse e consultá-las com PromQL, consulte [Prometheus HTTP API e PromQL](/docs/pt-BR/interfaces/prometheus).

<Note>
  Se você estiver usando o ClickHouse Cloud, é possível expor métricas ao Prometheus por meio da [integração com o Prometheus](/docs/pt-BR/products/cloud/features/monitoring/prometheus).
</Note>

<h2 id="configure-the-metrics-port">
  Configurar a porta de métricas
</h2>

Configure uma porta dedicada quando um servidor Prometheus precisar coletar (scrape) as próprias métricas do ClickHouse:

```xml theme={null}
<prometheus>
    <port>9363</port>
    <endpoint>/metrics</endpoint>
    <metrics>true</metrics>
    <asynchronous_metrics>true</asynchronous_metrics>
    <events>true</events>
    <errors>true</errors>
    <histograms>true</histograms>
    <dimensional_metrics>true</dimensional_metrics>
</prometheus>
```

<h2 id="configure-extended-handlers">
  Configurar handlers estendidos
</h2>

A seção `<prometheus.handlers>` pode ser usada para criar handlers mais avançados na mesma porta.
Essa seção é semelhante a [`<http_handlers>`](/docs/pt-BR/concepts/features/interfaces/http), mas funciona para os protocolos Prometheus:

```xml theme={null}
<prometheus>
    <port>9363</port>
    <handlers>
        <my_rule_1>
            <url>/metrics</url>
            <handler>
                <type>expose_metrics</type>
                <metrics>true</metrics>
                <asynchronous_metrics>true</asynchronous_metrics>
                <events>true</events>
                <errors>true</errors>
                <histograms>true</histograms>
                <dimensional_metrics>true</dimensional_metrics>
                <labels>
                    <environment>production</environment>
                    <shard from_env="SHARD_NAME"></shard>
                </labels>
            </handler>
        </my_rule_1>
    </handlers>
</prometheus>
```

<h2 id="settings">
  Settings
</h2>

Para o comportamento completo dessas configurações, consulte a [seção Prometheus](/docs/pt-BR/reference/settings/server-settings/settings/other#prometheus) da referência de server settings.

| Nome | Padrão | Descrição |
| - | - | - |
| `port` | nenhum | Porta que expõe as métricas do ClickHouse. |
| `endpoint` | `/metrics` | Endpoint HTTP para coleta de métricas. Começa com `/`. Não deve ser usado junto com a seção `<handlers>`. |
| `url` / `headers` / `method` | nenhum | Filtros usados para encontrar um handler correspondente a uma requisição. Semelhantes aos campos de mesmo nome na seção [`<http_handlers>`](/docs/pt-BR/concepts/features/interfaces/http). |
| `info` | true | Expõe o gauge `ClickHouse_Info` com labels de identidade do servidor (`name`, `version`, `version_describe`, `version_major`, `version_minor`, `version_patch`). |
| `metrics` | true | Expõe métricas de [`system.metrics`](/docs/pt-BR/reference/system-tables/metrics). |
| `asynchronous_metrics` | true | Expõe métricas de [`system.asynchronous_metrics`](/docs/pt-BR/reference/system-tables/asynchronous_metrics). |
| `events` | true | Expõe métricas de [`system.events`](/docs/pt-BR/reference/system-tables/events). |
| `errors` | true | Expõe contagens de erros de [`system.errors`](/docs/pt-BR/reference/system-tables/errors). |
| `histograms` | true | Expõe métricas de [`system.histogram_metrics`](/docs/pt-BR/reference/system-tables/histogram_metrics). |
| `dimensional_metrics` | true | Expõe métricas de [`system.dimensional_metrics`](/docs/pt-BR/reference/system-tables/dimensional_metrics). |
| `labels` | nenhum | Labels constantes adicionados a cada métrica exposta. Cada elemento filho define um label: o nome do elemento é o nome do label (que deve corresponder a `[a-zA-Z_][a-zA-Z0-9_]*`) e o valor do elemento é o valor do label. Os valores dos labels aceitam as substituições padrão de configuração, como o atributo `from_env`. Um nome de label é rejeitado quando começa com `__` (reservado pelo Prometheus) ou quando entra em conflito com um label que esse endpoint já grava para alguma de suas seções habilitadas. O conjunto reservado, portanto, acompanha a superfície de exportação ativa do endpoint: `le` quando `histograms` está habilitado; os labels de `ClickHouse_Info` (`name`, `version`, `version_describe`, `version_major`, `version_minor`, `version_patch`) quando `info` está habilitado; e qualquer label usado por um histograma exposto ou por uma metric family dimensional (por exemplo, `group`, `direction` ou `operation_type`) quando `histograms` ou `dimensional_metrics` está habilitado. Como isso depende do que o endpoint de fato expõe, um nome pode ser válido em um endpoint e rejeitado em outro. |

<h2 id="check-the-endpoint">
  Verifique o endpoint
</h2>

```bash theme={null}
curl http://127.0.0.1:9363/metrics
```