cloudflare / cloudflare/cloudflare-python

Add typed methods for Load Balancing Analytics Events and Pool Health endpoints

Aberta
#2,693 1 comentário 0 reações 0 responsáveis Ver no GitHub
kind: enhancement
Linguagem predominante
Python
Estrelas
506
Forks
148
Merge médio
3h 15min
PRs com merge (30d)
1

Descrição

## Feature Request

The Python SDK is missing typed methods for two Load Balancing endpoints that are documented in the Cloudflare REST API:

### 1. Load Balancing Analytics Events

**REST endpoint:** `GET /accounts/{account_id}/load_balancing_analytics/events`

Returns per-origin health state change events with timestamps, pool health status, failure reasons, and response codes. This is critical for monitoring when individual origins go unhealthy.

**Current workaround:**
```python
resp = client.with_raw_response.get(
f"/accounts/{account_id}/load_balancing_analytics/events",
cast_to=object,
options={"params": {"per_page": 200, "page": 1, "since": "...", "until": "..."}}
)
data = resp.json()
```

**Desired:**
```python
events = client.load_balancers.analytics.events.list(
account_id=account_id,
since="2026-03-18T00:00:00Z",
until="2026-03-18T23:59:59Z",
)
```

### 2. Pool Health Details

**REST endpoint:** `GET /accounts/{account_id}/load_balancers/pools/{pool_id}/health`

Returns per-PoP, per-origin health status including response codes, RTT, and failure reasons. Useful for diagnosing which specific origins are failing and from which regions.

**Current workaround:**
```python
resp = client.with_raw_response.get(
f"/accounts/{account_id}/load_balancers/pools/{pool_id}/health",
cast_to=object,
)
data = resp.json()
```

**Desired:**
```python
health = client.load_balancers.pools.health.get(
pool_id=pool_id,
account_id=account_id,
)
```

### Use Case

We built an origin health monitor that detects when individual load balancer origins are unhealthy while the pool remains healthy (silent degradation / lost redundancy). Both endpoints are essential for this use case and are documented in the Cloudflare API docs, but require falling back to raw HTTP via `with_raw_response.get()`.

### References

- [Pool Health API docs](https://developers.cloudflare.com/api/resources/load_balancers/subresources/pools/subresources/health/methods/get/)
- [Load Balancing Analytics](https://developers.cloudflare.com/load-balancing/reference/load-balancing-analytics/)

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece pelos endpoints REST documentados e pelos pontos de entrada do cliente `load_balancers.analytics.events.list` e `load_balancers.pools.health.get`, depois compare os recursos tipados próximos do SDK. Está concluído quando ambos os endpoints estiverem disponíveis por meio de métodos tipados e expuserem os campos documentados de eventos e de integridade por origem, em vez de exigirem `with_raw_response.get()`.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
api, backend-api-design
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
58/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.