Odpytaj metryki telemetryczne ClickHouse

Odpowiedź

{
  "alertTriggered": true,
  "alertType": "standard",
  "currentValue": 3.7,
  "metrics": {
    "errorCount": 3,
    "p95LatencyMs": 6.6,
    "totalRequests": 3
  },
  "status": "success",
  "summary": "A short summary.",
  "threshold": 0.6,
  "timeWindowMinutes": 26,
  "tokensDeducted": 1
}

Co robi

Odpytaj metryki telemetryczne ClickHouse, aby ocenić triggery warunków progowych dla Zapsów automatycznego monitorowania

Żądanie

Treść

Pole	Typ	Wymagane	Opis
`alertType`	enum	tak	The metric evaluation rule to check against ClickHouse telemetry One of: error_rate, token_usage_spike, high_latency, status_code_count.
`endpointFilter`	string	nie	Optional relative path to scope metrics to a single endpoint (e.g. "/v1/scrape/favicon")
`targetStatusCode`	integer	nie	HTTP status code to count when alertType is status_code_count or error_rate
`threshold`	number	tak	Value threshold to evaluate against current metric value
`timeWindowMinutes`	integer	nie	Time window in minutes to evaluate (1 to 1440 minutes / 24 hrs)

Przykładowe żądanie

{
  "alertType": "error_rate",
  "endpointFilter": "https://example.com/api",
  "targetStatusCode": 500,
  "threshold": 10,
  "timeWindowMinutes": 60
}

Odpowiedź

Pole	Typ	Opis
`alertTriggered`	boolean
`alertType`	string
`currentValue`	number
`metrics`	object
`↳ errorCount`	integer
`↳ p95LatencyMs`	number
`↳ totalRequests`	integer
`status`	string
`summary`	string
`threshold`	number
`timeWindowMinutes`	integer
`tokensDeducted`	integer

Przykładowa odpowiedź

{
  "alertTriggered": true,
  "alertType": "standard",
  "currentValue": 3.7,
  "metrics": {
    "errorCount": 3,
    "p95LatencyMs": 6.6,
    "totalRequests": 3
  },
  "status": "success",
  "summary": "A short summary.",
  "threshold": 0.6,
  "timeWindowMinutes": 26,
  "tokensDeducted": 1
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

`400`	Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
`401`	Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
`402`	Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
`404`	Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
`429`	Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
`5xx`	Usługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/zapier/alerts/check' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"alertType": "error_rate", "endpointFilter": "https://example.com/api", "targetStatusCode": 500, "threshold": 10, "timeWindowMinutes": 60}'

const res = await fetch('https://app.castomapi.com/v1/zapier/alerts/check', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"alertType": "error_rate", "endpointFilter": "https://example.com/api", "targetStatusCode": 500, "threshold": 10, "timeWindowMinutes": 60})
});
const data = await res.json();
console.log(data);

import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/zapier/alerts/check', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"alertType": "error_rate", "endpointFilter": "https://example.com/api", "targetStatusCode": 500, "threshold": 10, "timeWindowMinutes": 60})
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    'https://app.castomapi.com/v1/zapier/alerts/check',
    headers={'x-api-key': '<your-api-key>'},
    json={"alertType": "error_rate", "endpointFilter": "https://example.com/api", "targetStatusCode": 500, "threshold": 10, "timeWindowMinutes": 60},
    timeout=30,
)
print(res.json())

<?php
$ch = curl_init('https://app.castomapi.com/v1/zapier/alerts/check');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['alertType' => 'error_rate', 'endpointFilter' => 'https://example.com/api', 'targetStatusCode' => 500, 'threshold' => 10, 'timeWindowMinutes' => 60]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 1 token. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa.

Limity żądań na minutę

Bez klucza	10
Free	60
Pro	300
Enterprise	1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Odpytaj metryki telemetryczne ClickHouse?

1 token za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json

Żądanie

Odpowiedź

Co robi

Żądanie

Treść

Przykładowe żądanie

Odpowiedź

Przykładowa odpowiedź

Błędy

Kod

Koszt i limity

Limity żądań na minutę

Pytania

Więcej w grupie Zapier

Gdzie pasuje