` | Number; um número não-zero de respostas com status (100-599) |
| `xxx` | Number; um número não-zero de respostas com outros códigos de status |
| `data` | Object; estatísticas de dados |
| `received` | Number; o número total de bytes recebidos de clientes |
| `sent` | Number; o número total de bytes enviados para clientes |
Exemplo:
```json
{
"ssl":{
"handshaked":4174,
"reuses":0,
"timedout":0,
"failed":0
},
"requests":{
"total":4327,
"processing":0,
"discarded":0
},
"responses":{
"200":4305,
"302":6,
"304":12,
"404":4
},
"data":{
"received":733955,
"sent":59207757
}
}
```
#### `/status/http/location_zones/`
Para coletar as métricas do `location`, defina a diretiva [status_zone](https://pt.angie.software//angie/docs/configuration/modules/http/index.md#status-zone)
no contexto de [location](https://pt.angie.software//angie/docs/configuration/modules/http/index.md#location) ou [if in location](https://pt.angie.software//angie/docs/configuration/modules/http/http_rewrite.md#if):
```nginx
location / {
root /usr/share/angie/html;
status_zone location_zone;
if ($request_uri ~* "^/condition") {
# ...
status_zone if_location_zone;
}
}
```
Para agrupar as métricas por um valor personalizado, use a sintaxe alternativa.
Aqui, as métricas são agregadas por [$host](https://pt.angie.software//angie/docs/configuration/modules/http/index.md#v-host),
com cada grupo relatado como uma zona independente:
```nginx
status_zone $host zone=server_zone:5;
```
A zona de memória compartilhada especificada coletará as seguintes estatísticas:
| `requests` | Object; estatísticas de requisições |
|--------------|--------------------------------------------------------------------------------------|
| `total` | Number; o número total de requisições de clientes |
| `discarded` | Number; o número total de requisições de clientes concluídas sem enviar uma resposta |
| `responses` | Object; estatísticas de respostas |
| `` | Number; um número não-zero de respostas com status (100-599) |
| `xxx` | Number; um número não-zero de respostas com outros códigos de status |
| `data` | Object; estatísticas de dados |
| `received` | Number; o número total de bytes recebidos de clientes |
| `sent` | Number; o número total de bytes enviados para clientes |
Exemplo:
```json
{
"requests": {
"total": 4158,
"discarded": 0
},
"responses": {
"200": 4157,
"304": 1
},
"data": {
"received": 538200,
"sent": 177606236
}
}
```
#### `/status/http/metric_zones/`
Métricas personalizadas definidas por [metric_zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_metric.md#metric-zone) ou [metric_complex_zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_metric.md#metric-complex-zone)
no contexto `http`. As métricas são atualizadas com a diretiva [metric](https://pt.angie.software//angie/docs/configuration/modules/http/http_metric.md#id3)
ou as variáveis do módulo.
| `discarded` | Number; o número de entradas de métricas descartadas porque a zona ficou sem
memória. |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `metrics` | Object; métricas por chave. Para zonas de métrica única, os valores são números.
Para zonas complexas, os valores são objetos com nomes de métricas. Para o modo
histograma, os valores são objetos com nomes de buckets. |
Se `discard_key` estiver definido e algumas entradas tiverem expirado,
suas métricas agregadas são expostas sob esta chave.
Exemplo:
```json
{
"discarded": 3,
"metrics": {
"example.com": {
"count": 42,
"max": 8
}
"expired": {
"count": 10,
"max": 3.2
}
}
}
```
### Servidor stream
#### `/status/stream/server_zones/`
Para coletar as métricas do `server`,
defina a diretiva [status_zone](https://pt.angie.software//angie/docs/configuration/modules/stream/index.md#s-status-zone) no contexto [server](https://pt.angie.software//angie/docs/configuration/modules/stream/index.md#s-server):
```nginx
server {
...
status_zone server_zone;
}
```
Para agrupar as métricas por um valor personalizado, use a sintaxe alternativa.
Aqui, as métricas são agregadas por [$host](https://pt.angie.software//angie/docs/configuration/modules/http/index.md#v-host),
com cada grupo relatado como uma zona independente:
```nginx
status_zone $host zone=server_zone:5;
```
A zona de memória compartilhada especificada coletará as seguintes estatísticas:
| `ssl` | Object; estatísticas SSL.
Presente se `server` definir `listen ssl;` |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `handshaked` | Number; o número total de handshakes SSL bem-sucedidos |
| `reuses` | Number; o número total de reutilizações de sessão durante o handshake SSL |
| `timedout` | Number; o número total de handshakes SSL que expiraram |
| `failed` | Number; o número total de handshakes SSL que falharam |
| `connections` | Object; estatísticas de conexões |
| `total` | Number; o número total de conexões de clientes |
| `processing` | Number; o número de conexões de clientes sendo processadas atualmente |
| `discarded` | Number; o número total de conexões de clientes
concluídas sem criar uma sessão |
| `passed` | Number; o número total de conexões de clientes
redirecionadas para outra porta de escuta com diretivas `pass` |
| `sessions` | Object; estatísticas de sessões |
| `success` | Number; o número de sessões concluídas com código 200, que significa conclusão bem-sucedida |
| `invalid` | Number; o número de sessões concluídas com código 400, que acontece quando os dados do cliente não puderam ser analisados, por exemplo, o cabeçalho do protocolo PROXY |
| `forbidden` | Number; o número de sessões concluídas com código 403, quando o acesso foi proibido, por exemplo, quando o acesso é limitado para determinados endereços de clientes |
| `internal_error` | Number; o número de sessões concluídas com código 500, erro interno do servidor |
| `bad_gateway` | Number; o número de sessões concluídas com código 502, gateway inválido, por exemplo, se um servidor upstream não pôde ser selecionado ou alcançado |
| `service_unavailable` | Number; o número de sessões concluídas com código 503, serviço indisponível, por exemplo, quando o acesso é limitado pelo número de conexões |
| `data` | Object; estatísticas de dados |
| `received` | Number; o número total de bytes recebidos de clientes |
| `sent` | Number; o número total de bytes enviados para clientes |
Exemplo:
```json
{
"ssl": {
"handshaked": 24,
"reuses": 0,
"timedout": 0,
"failed": 0
},
"connections": {
"total": 24,
"processing": 1,
"discarded": 0,
"passed": 2
},
"sessions": {
"success": 24,
"invalid": 0,
"forbidden": 0,
"internal_error": 0,
"bad_gateway": 0,
"service_unavailable": 0
},
"data": {
"received": 2762947,
"sent": 53495723
}
}
```
### Caches HTTP
```nginx
proxy_cache cache_zone;
proxy_cache_valid 200 10m;
```
#### `/status/http/caches/`
Para cada zona configurada com [proxy_cache](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache), os seguintes dados são
armazenados:
```json
{
"name_zone": {
"size": 0,
"cold": false,
"hit": {
"responses": 0,
"bytes": 0
},
"stale": {
"responses": 0,
"bytes": 0
},
"updating": {
"responses": 0,
"bytes": 0
},
"revalidated": {
"responses": 0,
"bytes": 0
},
"miss": {
"responses": 0,
"bytes": 0,
"responses_written": 0,
"bytes_written": 0
},
"expired": {
"responses": 0,
"bytes": 0,
"responses_written": 0,
"bytes_written": 0
},
"bypass": {
"responses": 0,
"bytes": 0,
"responses_written": 0,
"bytes_written": 0
}
}
}
```
| `size` | Número; o tamanho atual do cache |
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `max_size` | Número; limite configurado para o tamanho máximo do cache |
| `cold` | Booleano; `true` enquanto o cache loader carrega dados do disco |
| `hit` | Objeto; estatísticas de respostas válidas em cache ([proxy_cache_valid](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-valid)) |
| `responses` | Número; o número total de respostas lidas do cache |
| `bytes` | Número; o número total de bytes lidos do cache |
| `stale` | Objeto; estatísticas de respostas obsoletas obtidas do cache ([proxy_cache_use_stale](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-use-stale)) |
| `responses` | Número; o número total de respostas lidas do cache |
| `bytes` | Número; o número total de bytes lidos do cache |
| `updating` | Objeto; estatísticas de respostas obsoletas obtidas do cache enquanto as respostas estavam sendo atualizadas ([proxy_cache_use_stale](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-use-stale) updating) |
| `responses` | Número; o número total de respostas lidas do cache |
| `bytes` | Número; o número total de bytes lidos do cache |
| `revalidated` | Objeto; estatísticas de respostas expiradas e revalidadas obtidas do cache ([proxy_cache_revalidate](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-revalidate)) |
| `responses` | Número; o número total de respostas lidas do cache |
| `bytes` | Número; o número total de bytes lidos do cache |
| `miss` | Objeto; estatísticas de respostas não encontradas no cache |
| `responses` | Número; o número total de respostas correspondentes |
| `bytes` | Número; o número total de bytes lidos do servidor com proxy |
| `responses_written` | Número; o número total de respostas escritas no cache |
| `bytes_written` | Número; o número total de bytes escritos no cache |
| `expired` | Objeto; estatísticas de respostas expiradas não obtidas do cache |
| `responses` | Número; o número total de respostas correspondentes |
| `bytes` | Número; o número total de bytes lidos do servidor com proxy |
| `responses_written` | Número; o número total de respostas escritas no cache |
| `bytes_written` | Número; o número total de bytes escritos no cache |
| `bypass` | Objeto; estatísticas de respostas não consultadas no cache ([proxy_cache_bypass](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-bypass)) |
| `responses` | Número; o número total de respostas correspondentes |
| `bytes` | Número; o número total de bytes lidos do servidor com proxy |
| `responses_written` | Número; o número total de respostas escritas no cache |
| `bytes_written` | Número; o número total de bytes escritos no cache |
No Angie PRO, se o cache sharding estiver habilitado com diretivas [proxy_cache_path](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-path),
fragmentos individuais são expostos como membros de objeto de um objeto `shards`:
| `shards` | Objeto; lista fragmentos individuais como membros |
|------------|-------------------------------------------------------------------------------|
| `` | Objeto; representa um fragmento individual com seu caminho de cache como nome |
| `size` | Número; o tamanho atual do fragmento |
| `max_size` | Número; tamanho máximo do fragmento, se configurado |
| `cold` | Booleano; `true` enquanto o cache loader carrega dados do disco |
```json
{
"name_zone": {
"shards": {
"/path/to/shard1": {
"size": 0,
"cold": false
},
"/path/to/shard2": {
"size": 0,
"cold": false
}
}
}
```
### Clientes ACME
#### `/status/http/acme_clients/`
Para cada [acme_client](https://pt.angie.software//angie/docs/configuration/modules/http/http_acme.md#acme-client) configurado no bloco `http`, retorna o
status atual do cliente e do certificado:
```json
{
"state": "ready",
"certificate": "valid",
"details": "The client is ready to request a certificate.",
"next_run": "|sampledateshort|T16:15:43.805Z"
}
```
| `state` | String; estado do cliente ACME. Valores possíveis: `ready`,
`requesting`, `disabled`, `failed`. |
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| `certificate` | String; status do certificado. Valores possíveis: `valid`,
`expired`, `missing`, `mismatch`, `error`. |
| `details` | String; detalhes breves do status da última operação ACME. |
| `next_run` | Data; próxima tentativa agendada para solicitar ou renovar o certificado.
Não retornado quando `state` é `disabled` ou
`requesting`. |
### limit_conn
```nginx
limit_conn_zone $binary_remote_addr zone=limit_conn_zone:10m;
```
#### `/status/http/limit_conns/`, `/status/stream/limit_conns/`
Objetos para cada [limit_conn em http](#limit-conn) ou [limit_conn em stream](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_limit_conn.md#s-limit-conn) configurado nos contextos com os seguintes campos:
```json
{
"passed": 73,
"skipped": 0,
"rejected": 0,
"exhausted": 0
}
```
| `passed` | Número; o número total de conexões aprovadas |
|-------------|----------------------------------------------------------------------------------------------------------|
| `skipped` | Número; o número total de conexões aprovadas com chave de comprimento zero, ou chave excedendo 255 bytes |
| `rejected` | Número; o número total de conexões excedendo o limite configurado |
| `exhausted` | Número; o número total de conexões rejeitadas devido ao esgotamento do armazenamento da zona |
### limit_req
```nginx
limit_req_zone $binary_remote_addr zone=limit_req_zone:10m rate=1r/s;
```
#### `/status/http/limit_reqs/`
Objetos para cada [limit_req](#limit-req) configurado com os seguintes campos:
```json
{
"passed": 54816,
"skipped": 0,
"delayed": 65,
"rejected": 26,
"exhausted": 0
}
```
| `passed` | Número; o número total de requisições aprovadas |
|-------------|-------------------------------------------------------------------------------------------------------------|
| `skipped` | Número; o número total de requisições aprovadas com chave de comprimento zero, ou chave excedendo 255 bytes |
| `delayed` | Número; o número total de requisições atrasadas |
| `rejected` | Número; o número total de requisições rejeitadas |
| `exhausted` | Número; o número total de requisições rejeitadas devido ao esgotamento do armazenamento da zona |
### HTTP upstream
Para habilitar a coleta das seguintes métricas,
defina a diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone) no contexto [upstream](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream),
por exemplo:
```nginx
upstream upstream {
zone upstream 256k;
server backend.example.com service=_example._tcp resolve max_conns=5;
keepalive 4;
}
```
#### `/status/http/upstreams/`
onde é o nome de qualquer [upstream](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream) especificado com a diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone)
```json
{
"peers": {
"192.168.16.4:80": {
"server": "backend.example.com",
"service": "_example._tcp",
"backup": false,
"weight": 5,
"state": "up",
"selected": {
"current": 2,
"total": 232
},
"max_conns": 5,
"responses": {
"200": 222,
"302": 12
},
"data": {
"sent": 543866,
"received": 27349934
},
"health": {
"fails": 0,
"unavailable": 0,
"downtime": 0
},
"sid": ""
}
},
"keepalive": 2
}
```
| `peers` | Objeto; contém as métricas dos peers do upstream como subobjetos
cujos nomes são representações canônicas dos endereços dos peers.
Membros de cada subobjeto: |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `server` | String; o parâmetro da diretiva [server](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server) |
| `service` | String; nome do serviço como especificado na diretiva [server](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server), se configurado |
| `backup` | Booleano; `true` para servidores de backup |
| `weight` | Número; [peso](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server) configurado |
| `state` | String; o estado atual do peer e quais requisições são enviadas para ele:
- `busy`: indica que o número de requisições para o servidor
atingiu o limite definido por [max_conns](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server),
e nenhuma nova requisição é enviada para ele;
- `down`: desabilitado manualmente, nenhuma requisição é enviada;
- `recovering`: recuperando após uma falha
de acordo com [slow_start](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#slow-start),
mais e mais requisições são enviadas ao longo do tempo;
- `unavailable`: atingiu o limite [max_fails](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#max-fails),
apenas requisições de teste do cliente são enviadas
em intervalos definidos por [fail_timeout](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#fail-timeout);
- `up`: operacional, requisições são enviadas normalmente;
Estados adicionais no Angie PRO:
- `checking`: configurado como `essential` e sendo verificado,
apenas [requisições de sonda](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream_probe.md#u-upstream-probe) são enviadas;
- `draining`: similar a `down`,
mas requisições de sessões previamente vinculadas
(via [sticky](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-sticky)) ainda são enviadas;
- `unhealthy`: não operacional,
apenas [requisições de sonda](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream_probe.md#u-upstream-probe) são enviadas. |
| `selected` | Objeto; estatísticas de seleção de peer |
| `current` | Número; o número atual de conexões para o peer |
| `total` | Número; número total de requisições encaminhadas para o peer |
| `last` | String ou número; momento em que o peer foi selecionado pela última vez,
formatado como uma [data](#api-date-format) |
| `max_conns` | Número; o número [máximo](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server) configurado de conexões ativas simultâneas para o peer, se especificado |
| `responses` | Objeto; estatísticas de respostas |
| `` | Número; um número não-zero de respostas com status (100-599) |
| `xxx` | Número; um número não-zero de respostas com outros códigos de status |
| `data` | Objeto; estatísticas de dados |
| `received` | Número; o número total de bytes recebidos do peer |
| `sent` | Número; o número total de bytes enviados para o peer |
| `health` | Objeto; estatísticas de saúde |
| `fails` | Número; o número total de tentativas malsucedidas de comunicação com o peer |
| `unavailable` | Número; quantas vezes o peer ficou `unavailable` devido ao atingimento do limite [max_fails](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#max-fails) |
| `downtime` | Número; o tempo total (em milissegundos) quando o peer estava `unavailable` para seleção |
| `downstart` | String ou número; momento em que o peer ficou `unavailable`,
formatado como uma [data](#api-date-format) |
| `header_time` | Número; tempo médio (em milissegundos)
para receber os cabeçalhos de resposta do servidor;
veja [response_time_factor (PRO)](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-response-time-factor) |
| `response_time` | Número; tempo médio (em milissegundos)
para receber a resposta completa do servidor;
veja [response_time_factor (PRO)](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-response-time-factor) |
| `sid` | String; [id configurado](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#reresolve) do servidor no grupo upstream |
| `keepalive` | Número; o número atual de conexões em cache |
| `backup_switch` | Objeto; contém o estado atual da lógica de backup ativo,
presente se [backup_switch (PRO)](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-backup-switch) estiver configurado para o upstream |
| `active` | Número; o nível do grupo ativo
que está sendo usado atualmente para balanceamento de carga de requisições.
Se o grupo ativo for o primário, o valor é 0 |
| `timeout` | Número; tempo de espera restante em milissegundos,
após o qual o balanceador irá verificar novamente por nós saudáveis
em grupos com níveis mais baixos, começando pelo grupo primário,
enquanto grupos com níveis mais altos não são verificados;
não exibido para o grupo primário (nível 0) |
##### `health/probes` (PRO)
#### Versionchanged
Alterado na versão 1.2.0: PRO
Se o upstream tiver sondas [upstream_probe (PRO)](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream_probe.md#u-upstream-probe) configuradas,
o objeto `health` também possui um subobjeto `probes`
que armazena os contadores de sonda de saúde do servidor,
enquanto `state`, além dos valores listados na tabela acima,
também pode ser `checking` e `unhealthy`:
```json
{
"192.168.16.4:80": {
"state": "unhealthy",
"...": "...",
"health": {
"...": "...",
"probes": {
"count": 10,
"fails": 10,
"last": "|sampledateshort|T09:56:07Z"
}
}
}
}
```
O valor `checking` de `state` não é contado como `downtime`
e significa que o servidor, que possui uma sonda configurada como `essential`,
ainda não foi verificado;
o valor `unhealthy` significa que o servidor está com mau funcionamento.
Ambos os estados também implicam que o servidor não está incluído no balanceamento de carga.
Para detalhes das sondas de saúde, veja [upstream_probe](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream_probe.md#u-upstream-probe).
Contadores em `probes`:
| `count` | Número; total de sondas para este servidor |
|-----------|--------------------------------------------------------------------------------------------|
| `fails` | Número; total de sondas falhadas |
| `last` | String ou número; momento da última sonda,
formatado como uma [data](#api-date-format) |
##### `queue` (PRO)
#### Versionchanged
Alterado na versão 1.4.0: PRO
Se uma [fila de requisições](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-queue) estiver configurada para o upstream,
o objeto upstream também contém um objeto `queue` aninhado
com contadores da fila de requisições:
```json
{
"queue": {
"queued": 20112,
"waiting": 1011,
"dropped": 6031,
"timedout": 560,
"overflows": 13
}
}
```
Os valores dos contadores são somados em todos os processos worker:
| `queued` | Número; número total de requisições que entraram na fila |
|-------------|------------------------------------------------------------------------------------------------------------|
| `waiting` | Número; número atual de requisições na fila |
| `dropped` | Número; número total de requisições removidas da fila
porque o cliente fechou prematuramente a conexão |
| `timedout` | Número; número total de requisições removidas da fila devido a timeout |
| `overflows` | Número; número total de ocorrências de overflow da fila |
### Upstream de stream
Para habilitar a coleta das seguintes métricas,
defina a diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-zone) no contexto [upstream](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-upstream),
por exemplo:
```nginx
upstream upstream {
zone upstream 256k;
server backend.example.com service=_example._tcp resolve max_conns=5;
keepalive 4;
}
```
#### `/status/stream/upstreams/`
Aqui, é o nome de um [upstream](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream) que está
configurado com uma diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone).
```json
{
"peers": {
"192.168.16.4:1935": {
"server": "backend.example.com",
"service": "_example._tcp",
"backup": false,
"weight": 5,
"state": "up",
"selected": {
"current": 2,
"total": 232
},
"max_conns": 5,
"data": {
"sent": 543866,
"received": 27349934
},
"health": {
"fails": 0,
"unavailable": 0,
"downtime": 0
}
}
}
}
```
| `peers` | Objeto; contém as métricas dos peers do upstream como subobjetos
cujos nomes são representações canônicas dos endereços dos peers.
Membros de cada subobjeto: |
|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `server` | String; endereço definido pela diretiva [server](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server) |
| `service` | String; nome do serviço, se definido pela diretiva [server](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server) |
| `backup` | Booleano; `true` para servidores de backup |
| `weight` | Número; o [peso](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server) definido para o peer |
| `state` | String; o estado atual do peer e quais requisições são enviadas para ele:
- `busy`: indica que o número de requisições para o servidor
atingiu o limite definido por [max_conns](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server),
e nenhuma nova requisição é enviada para ele
- `down`: desabilitado manualmente, nenhuma requisição é enviada
- `recovering`: recuperando após uma falha
de acordo com [slow_start](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-slow-start),
mais e mais requisições são enviadas ao longo do tempo
- `unavailable`: atingiu o limite [max_fails](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-max-fails),
apenas requisições de teste do cliente são enviadas
em intervalos definidos por [fail_timeout](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-fail-timeout)
- `up`: operacional, requisições são enviadas normalmente
Estados adicionais no Angie PRO:
- `checking`: configurado como `essential` e sendo verificado,
apenas [requisições de sonda](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream_probe.md#s-u-upstream-probe) são enviadas
- `draining`: similar a `down`,
mas requisições de sessões previamente vinculadas
(via [sticky](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-sticky)) ainda são enviadas
- `unhealthy`: não operacional,
apenas [requisições de sonda](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream_probe.md#s-u-upstream-probe) são enviadas |
| `selected` | Objeto; estatísticas sobre a seleção deste peer para conexões |
| `current` | Número; número atual de conexões para o peer |
| `total` | Número; número total de conexões encaminhadas para o peer |
| `last` | String ou número; momento em que o peer foi selecionado pela última vez,
formatado como uma [data](#api-date-format) |
| `max_conns` | Número;
número [máximo](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server)
de conexões ativas simultâneas para o peer, se definido |
| `data` | Objeto; estatísticas de transferência de dados |
| `received` | Número; total de bytes recebidos do peer |
| `sent` | Número; total de bytes enviados para o peer |
| `health` | Objeto; estatísticas de saúde do peer |
| `fails` | Número; total de tentativas falhadas para alcançar o peer |
| `unavailable` | Número; número total de vezes que o peer ficou `unavailable` devido a
atingir o valor [max_fails](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-max-fails) |
| `downtime` | Número; tempo total (em milissegundos) que o peer esteve
`unavailable` (indisponível para seleção) |
| `downstart` | String ou número; momento em que o peer ficou `unavailable` pela última vez,
formatado como uma [data](#api-date-format) |
| `connect_time`
(PRO 1.4.0+) | Número; tempo médio (em milissegundos)
para estabelecer uma conexão com o servidor;
veja a diretiva [response_time_factor (PRO)](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-response-time-factor) |
| `first_byte_time`
(PRO 1.4.0+) | Número; tempo médio (em milissegundos)
para receber o primeiro byte da resposta do servidor;
veja a diretiva [response_time_factor (PRO)](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-response-time-factor) |
| `last_byte_time`
(PRO 1.4.0+) | Número; tempo médio (em milissegundos)
para receber a resposta completa do servidor;
veja a diretiva [response_time_factor (PRO)](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-response-time-factor) |
| `backup_switch`
(PRO 1.10.0+) | Objeto; contém o estado atual da lógica de backup ativo,
presente se [backup_switch (PRO)](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-backup-switch) estiver configurado para o upstream |
| `active` | Número; nível do grupo ativo
atualmente usado para balanceamento de carga.
Se o grupo ativo for o grupo primário, o valor é 0 |
| `timeout` | Número; tempo de espera restante em milissegundos
após o qual o balanceador de carga irá verificar novamente por nós saudáveis
em grupos com níveis mais baixos, começando pelo grupo primário,
enquanto grupos com níveis mais altos não são verificados;
não exibido para o grupo primário (nível 0) |
#### Versionchanged
Alterado na versão 1.4.0: PRO
No Angie PRO, se o upstream tiver sondas [upstream_probe (PRO)](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream_probe.md#s-u-upstream-probe) configuradas,
o objeto `health` também tem um subobjeto `probes`
que armazena os contadores de sonda de saúde do servidor,
enquanto `state`, além dos valores da tabela acima,
também pode ser `checking` e `unhealthy`:
```json
{
"192.168.16.4:80": {
"state": "unhealthy",
"...": "...",
"health": {
"...": "...",
"probes": {
"count": 2,
"fails": 2,
"last": "|sampledateshort|T11:03:54Z"
}
}
}
}
```
O valor `checking` de `state` significa que o servidor,
que tem uma sonda configurada com o parâmetro `essential`,
ainda não foi verificado;
o valor `unhealthy` significa que o servidor não está operacional.
Ambos os estados também significam que o servidor não está incluído no balanceamento de carga.
Para detalhes das sondas de saúde, veja [upstream_probe](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream_probe.md#s-u-upstream-probe).
Contadores em `probes`:
| `count` | Número; número total de sondas para este servidor |
|-----------|--------------------------------------------------------------------------------------------|
| `fails` | Número; número de sondas falhadas |
| `last` | String ou número; momento da última sonda,
formatado como uma [data](#api-date-format) |
## API de Configuração Dinâmica (PRO)
A API inclui uma seção `/config` que permite atualizações dinâmicas
na configuração do Angie em formato JSON
com requisições HTTP `PUT`, `PATCH` e `DELETE`.
Todas as atualizações são atômicas: as novas configurações são aplicadas como um todo,
ou nenhuma é aplicada.
Em caso de erro, o Angie reporta o motivo.
### Subseções de `/config`
Atualmente, a configuração de servidores individuais dentro de upstreams está disponível
na seção `/config` para os módulos [HTTP](#api-config-http-upstreams-servers) e [stream](#api-config-stream-upstreams-servers); o número de configurações
elegíveis para configuração dinâmica está aumentando constantemente.
#### `/config/http/upstreams//servers/`
Permite configurar peers individuais de upstream,
incluindo excluir peers existentes ou adicionar novos.
Parâmetros do caminho URI:
| `` | Nome do upstream; para ser configurável via `/config`, deve
ter uma diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone) configurada, definindo uma zona
de memória compartilhada. |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `` | O nome do peer dentro do upstream, definido como
`@`, onde:
- `@` é um nome de serviço opcional, usado para
resolução de registros SRV.
- `` é o nome de domínio do serviço (se `resolve`
estiver presente) ou seu IP; uma porta opcional pode ser definida aqui. |
Por exemplo, a seguinte configuração:
```nginx
upstream backend {
server backend.example.com service=_http._tcp resolve;
server 127.0.0.1;
zone backend 1m;
}
```
Permite os seguintes nomes de peer:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/_http._tcp@backend.example.com/
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/127.0.0.1:80/
```
Esta subseção da API permite definir os parâmetros `weight`, `max_conns`,
`max_fails`, `fail_timeout`, `slow_start`, `backup`, `down` e
`sid`, conforme descrito em [server](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-server).
#### NOTE
Não há um parâmetro `drain` (PRO) separado aqui;
para habilitar `drain`,
defina `down` para o valor string `drain`:
```console
$ curl -X PUT -d \"drain\" \
http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com/down
```
Exemplo:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com?defaults=on
```
```json
{
"weight": 1,
"max_conns": 0,
"max_fails": 1,
"fail_timeout": 10,
"slow_start": 0,
"backup": true,
"down": false,
"sid": ""
}
```
Os parâmetros realmente disponíveis são limitados aos suportados pelo
método de balanceamento de carga atual do [upstream](https://pt.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream).
Então, se o upstream estiver configurado com o método `random`:
```nginx
upstream backend {
zone backend 256k;
server backend.example.com resolve max_conns=5;
random;
}
```
Você não conseguirá adicionar um novo peer que defina `backup`:
```console
$ curl -X PUT -d '{ "backup": true }' \
http://127.0.0.1/config/http/upstreams/backend/servers/backend1.example.com
```
```json
{
"error": "FormatError",
"description": "The \"backup\" field is unknown."
}
```
#### NOTE
Mesmo com um método de balanceamento de carga compatível, o parâmetro `backup`
só pode ser definido ao adicionar um novo peer.
#### `/config/stream/upstreams//servers/`
Permite configurar peers individuais de upstream,
incluindo excluir peers existentes ou adicionar novos.
Parâmetros do caminho URI:
| `` | Nome do bloco `upstream`;
para ser configurável via `/config`,
deve ter uma diretiva [zone](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-zone) configurada,
definindo uma zona de memória compartilhada. |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `` | O nome do peer dentro do upstream, definido como
`@`, onde:
- `@` é um nome de serviço opcional, usado para
resolução de registros SRV.
- `` é o nome de domínio do serviço (se `resolve`
estiver presente) ou seu IP; uma porta opcional pode ser definida aqui. |
Por exemplo, a seguinte configuração:
```nginx
upstream backend {
server backend.example.com:8080 service=_example._tcp resolve;
server 127.0.0.1:12345;
zone backend 1m;
}
```
Permite os seguintes nomes de peer:
```console
$ curl http://127.0.0.1/config/stream/upstreams/backend/servers/_example._tcp@backend.example.com:8080/
$ curl http://127.0.0.1/config/stream/upstreams/backend/servers/127.0.0.1:12345/
```
Esta subseção da API permite definir os parâmetros `weight`,
`max_conns`, `max_fails`, `fail_timeout`, `slow_start`, `backup` e
`down`, conforme descrito em [server](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-server).
#### NOTE
Não há um parâmetro `drain` (PRO) separado aqui;
para habilitar o modo `drain`,
defina `down` para o valor string `drain`:
```console
$ curl -X PUT -d \"drain\" \
http://127.0.0.1/config/stream/upstreams/backend/servers/backend.example.com/down
```
Exemplo:
```console
$ curl http://127.0.0.1/config/stream/upstreams/backend/servers/backend.example.com?defaults=on
```
```json
{
"weight": 1,
"max_conns": 0,
"max_fails": 1,
"fail_timeout": 10,
"slow_start": 0,
"backup": true,
"down": false,
}
```
Os parâmetros realmente disponíveis são limitados aos suportados pelo
método de balanceamento de carga atual do [upstream](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-upstream).
Então, se o upstream estiver configurado com o método `random`:
```nginx
upstream backend {
zone backend 256k;
server backend.example.com resolve max_conns=5;
random;
}
```
Você não conseguirá adicionar um novo peer que defina `backup`:
```console
$ curl -X PUT -d '{ "backup": true }' \
http://127.0.0.1/config/stream/upstreams/backend/servers/backend1.example.com
```
```json
{
"error": "FormatError",
"description": "The \"backup\" field is unknown."
}
```
#### NOTE
Mesmo com um método de balanceamento de carga compatível, o parâmetro `backup`
só pode ser definido ao adicionar um novo peer.
Ao excluir peers, você pode definir o
argumento `connection_drop=` (PRO) para sobrescrever as
configurações [proxy_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/stream/stream_proxy.md#s-proxy-connection-drop):
```console
$ curl -X DELETE \
http://127.0.0.1/config/stream/upstreams/backend/servers/backend1.example.com?connection_drop=off
$ curl -X DELETE \
http://127.0.0.1/config/stream/upstreams/backend/servers/backend2.example.com?connection_drop=on
$ curl -X DELETE \
http://127.0.0.1/config/stream/upstreams/backend/servers/backend3.example.com?connection_drop=1000
```
### Métodos HTTP
Vamos considerar a semântica de cada método HTTP aplicável a esta seção
usando a seguinte configuração upstream como exemplo:
```nginx
http {
# ...
upstream backend {
zone upstream 256k;
server backend.example.com resolve max_conns=5;
# ...
}
server {
# ...
location /config/ {
api /config/;
allow 127.0.0.1;
deny all;
}
}
}
```
#### GET
O método HTTP `GET` consulta uma entidade em qualquer caminho existente dentro de
`/config`, assim como faz para outras seções da API.
Por exemplo, o
ramo de servidor upstream `/config/http/upstreams/backend/servers/`
habilita estas consultas:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com/max_conns
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
$ curl http://127.0.0.1/config/http/upstreams/backend/servers
$ # ...
$ curl http://127.0.0.1/config
```
Você pode obter valores de parâmetros padrão com o argumento `defaults=on`:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers?defaults=on
```
```json
{
"backend.example.com": {
"weight": 1,
"max_conns": 5,
"max_fails": 1,
"fail_timeout": 10,
"slow_start": 0,
"backup": false,
"down": false,
"sid": ""
}
}
```
#### PUT
O método HTTP `PUT` cria uma nova entidade JSON no caminho especificado
ou substitui *inteiramente* uma existente.
Por exemplo, para adicionar o parâmetro `max_fails`, não especificado anteriormente,
ao servidor `backend.example.com` dentro do upstream `backend`:
```console
$ curl -X PUT -d '2' \
http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com/max_fails
```
```json
{
"success": "Updated",
"description": "Existing configuration API entity \"/config/http/upstreams/backend/servers/backend.example.com/max_fails\" was updated with replacing."
}
```
Verifique as alterações:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
```
```json
{
"max_conns": 5,
"max_fails": 2
}
```
#### DELETE
O método HTTP `DELETE` exclui configurações *previamente definidas* no caminho especificado;
ao fazer isso, restaura os valores padrão se houver algum.
Por exemplo, para excluir o parâmetro `max_fails` previamente modificado
do servidor `backend.example.com` dentro do upstream `backend`:
```console
$ curl -X DELETE \
http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com/max_fails
```
```console
{
"success": "Reset",
"description": "Configuration API entity \"/config/http/upstreams/backend/servers/backend.example.com/max_fails\" was reset to default."
}
```
Verifique as alterações usando o argumento `defaults=on`:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com?defaults=on
```
```json
{
"weight": 1,
"max_conns": 5,
"max_fails": 1,
"fail_timeout": 10,
"slow_start": 0,
"backup": false,
"down": false,
"sid": ""
}
```
O parâmetro `max_fails` retornou ao seu valor padrão.
Ao excluir servidores, você pode definir o argumento `connection_drop=`
(PRO) para sobrescrever as configurações [proxy_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-connection-drop), [grpc_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/http/http_grpc.md#grpc-connection-drop),
[fastcgi_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/http/http_fastcgi.md#fastcgi-connection-drop), [scgi_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/http/http_scgi.md#scgi-connection-drop) e
[uwsgi_connection_drop](https://pt.angie.software//angie/docs/configuration/modules/http/http_uwsgi.md#uwsgi-connection-drop):
```console
$ curl -X DELETE \
http://127.0.0.1/config/http/upstreams/backend/servers/backend1.example.com?connection_drop=off
$ curl -X DELETE \
http://127.0.0.1/config/http/upstreams/backend/servers/backend2.example.com?connection_drop=on
$ curl -X DELETE \
http://127.0.0.1/config/http/upstreams/backend/servers/backend3.example.com?connection_drop=1000
```
#### PATCH
O método HTTP `PATCH` cria uma nova entidade no caminho especificado
ou substitui parcialmente ou complementa uma existente
([RFC 7386](https://datatracker.ietf.org/doc/html/rfc7396))
fornecendo uma definição JSON em seu payload.
O método opera da seguinte forma: se as entidades da nova definição
existem na configuração, elas são sobrescritas; caso contrário, são adicionadas.
Por exemplo, para alterar o parâmetro `down` do
servidor `backend.example.com` dentro do upstream `backend`,
deixando o resto intacto:
```console
$ curl -X PATCH -d '{ "down": true }' \
http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
```
```json
{
"success": "Updated",
"description": "Existing configuration API entity \"/config/http/upstreams/backend/servers/backend.example.com\" was updated with merging."
}
```
Verifique as alterações:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
```
```json
{
"max_conns": 5,
"down": true
}
```
Observe que o objeto JSON fornecido com a requisição `PATCH` *foi mesclado* com o
existente em vez de substituí-lo inteiramente, como seria o caso com `PUT`.
Os valores `null` são um caso especial; eles são usados para excluir
itens específicos de configuração durante tal mesclagem.
#### NOTE
Esta exclusão é idêntica ao `DELETE`;
em particular, ela restaura os valores padrão.
Por exemplo, para excluir o parâmetro `down` adicionado anteriormente
e simultaneamente atualizar `max_conns`:
```console
$ curl -X PATCH -d '{ "down": null, "max_conns": 6 }' \
http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
```
```json
{
"success": "Updated",
"description": "Existing configuration API entity \"/config/http/upstreams/backend/servers/backend.example.com\" was updated with merging."
}
```
Verifique as alterações:
```console
$ curl http://127.0.0.1/config/http/upstreams/backend/servers/backend.example.com
```
```json
{
"max_conns": 6
}
```
O parâmetro `down`, para o qual um valor `null` foi fornecido, foi excluído;
o valor de `max_conns` foi atualizado.