Spis treści

Przegląd Kontrole Zdrowia Metryki i Monitorowanie Konfiguracja Alertów Logowanie Żądań Śledzenie Rozproszone Monitorowanie SLA Pulpity Nawigacyjne Narzędzia Monitorowania Najlepsze Praktyki

Dokumentacja API

Monitorowanie API, Metryki i Kontrole Zdrowia

Monitoruj Smart Money API z kompleksowymi kontrolami zdrowia, metrykami wydajności i alertami. Śledź czas działania, opóźnienia, wskaźniki błędów i zgodność z SLA.

Opublikowano 21 marca 2026 • 13 minut czytania • Operacje

Przegląd Monitorowania

Smart Money API zapewnia kompleksowe możliwości monitorowania, aby śledzić stan zdrowia, wydajność i niezawodność usług. Wdroż te strategie monitorowania, aby wcześnie wykrywać problemy i utrzymywać wysoki czas działania.

Trzy warstwy monitorowania:

Kontrole Zdrowia — Dostępność punktu końcowego i podstawowa funkcjonalność
Metryki — Dane dotyczące wydajności (opóźnienie, przepustowość, wskaźniki błędów)
Logowanie — Szczegóły żądań/odpowiedzi do debugowania i audytu

Docelowe Metryki: 99.9% czasu działania, <100ms p95 opóźnienia, <0.1% wskaźnik błędów, <5 sekund średni czas wykrycia.

Kontrole Zdrowia

Punkt Końcowy Zdrowia API

Kontrola Zdrowia
// Proste sprawdzenie żywotności (bez wymaganej autoryzacji)
GET /health
// Odpowiedź
HTTP/1.1 200 OK
{
 "status": "healthy",
 "timestamp": 1709980800000,
 "uptime": 99.95
}

Szczegółowy Stan Zdrowia

Szczegółowe Zdrowie
// Szczegółowy stan ze zdrowiem komponentów
GET /v1/status
  -H "Authorization: Bearer token"
{
 "status": "operational",
 "components": {
 "api": "healthy",
 "database": "healthy",
 "cache": "healthy",
 "exchanges": "healthy"
  },
 "metrics": {
 "p95_latency_ms": 85,
 "error_rate": 0.0012,
 "uptime_percent": 99.95
  }
}

Uzyskaj swój klucz API w 30 sekund

Gotowy do budowania? Pobierz darmowy klucz API (200 wywołań/dzień, bez karty) i zacznij pobierać dane dotyczące wielorybów, finansowania i danych łańcuchowych w czasie rzeczywistym.

Uzyskaj swój klucz API →

Metryki i Monitorowanie

Kluczowe Metryki do Śledzenia

Metryka	Cel	Próg Alarmowy
Czas Działania	99.9%	<99.5%
P95 Opóźnienie	<100ms	>500ms
Wskaźnik Błędów	<0.1%	>1%
Żądania/sek	Różne	Zbliżanie się do limitu
Współczynnik Trafień w Cache	>70%	<50%

Punkt Końcowy Metryk API

Zapytanie Metryk
// Pobierz metryki API do monitorowania
GET /v1/metrics?period=1h
  -H "Authorization: Bearer token"
// Zwraca metryki w formacie Prometheus
# HELP api_requests_total Całkowita liczba żądań API
# TYPE api_requests_total counter
api_requests_total{method="GET",status="200"} 4502
api_requests_total{method="GET",status="429"} 12

Konfiguracja Alertów

Alerty Webhook

Utwórz Alert
POST /v1/alerts
  -H "Authorization: Bearer token"
  -d '{
 "name": "Wysoki Wskaźnik Błędów",
 "condition": "error_rate > 0.01",
 "webhook_url": "https://hooks.slack.com/...",
 "severity": "high"
  }'

Typy Alertów

Alert Czasu Działania — API niedostępne przez 5+ minut
Alert Opóźnienia — P95 opóźnienie przekracza próg
Alert Wskaźnika Błędów — Wskaźnik błędów powyżej 1%
Alert Limitu Szybkości — Zbliżanie się do limitu szybkości
Alert Świeżości Danych — Dane starsze niż próg

Logowanie Żądań

Poziomy Logowania

Przykład Logu
// Typowy wpis logu żądania API
{
 "timestamp": "2026-03-21T14:00:00Z",
 "request_id": "req_abc123def456",
 method: GET,
 path: /v1/whales/btc,
 status: 200,
 duration_ms: 45,
 user_id: acct_12345
}

Strukturalne Logowanie

Wszystkie logi są strukturalnymi JSONami dla łatwego parsowania i analizy:

Znacznik czasu w formacie ISO 8601
ID żądania do śledzenia
Metoda HTTP i ścieżka
Status odpowiedzi i opóźnienie
ID użytkownika i odcisk klucza API
Komunikaty o błędach, jeśli dotyczy

Śledzenie Rozproszone

Śledzenie ID Żądania

Nagłówki Śledzenia
// Wszystkie żądania zawierają nagłówki śledzenia
curl -H "X-Request-ID: req-abc123" \
  https://api.smartmoneyapi.com/v1/whales
// Odpowiedź zawiera to samo ID
X-Request-ID: req-abc123
X-Response-Time: 45ms
X-Server: api-prod-01

Propagacja Kontekstu Śledzenia

Użyj standardu W3C Trace Context dla systemów rozproszonych:

W3C Trace Context
// Żądanie zawiera kontekst śledzenia
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
tracestate: dd=s:0
// ID Śledzenia: 4bf92f3577b34da6a3ce929d0e0e4736
// ID Zakresu: 00f067aa0ba902b7
// Próbkowane: true (01)

Monitorowanie SLA

Cele Poziomu Usług

Plan	SLA Czasu Dostępności	Czas Odpowiedzi	Wsparcie
Bezpłatne	99%	Najlepsze starania	Społeczność
Trader	99.5%	<200ms p95	Email
Pro	99.95%	<100ms p95	Priorytet
Enterprise	99.99%	<50ms p95	Dedykowane

Kredyty SLA

Jeśli czas dostępności spadnie poniżej SLA, otrzymaj kredyty na usługi:

99.0% - 99.5%: 10% miesięcznego kredytu
95.0% - 99.0%: 25% miesięcznego kredytu
< 95.0%: 100% miesięcznego kredytu

Panele Monitorowania

Wbudowany Panel

Dostęp do panelu wydajności: https://status.smartmoney.io

Konfiguracja Niestandardowego Panelu

Zapytanie Prometheus
// Zapytaj o wskaźnik żądań API
rate(api_requests_total[5m])
// Zapytaj o wskaźnik błędów
rate(api_requests_total{status=~"5.."}[5m])
// Zapytaj o percentyl opóźnienia
histogram_quantile(0.95, api_request_duration_ms)

Integracja Narzędzi Monitorowania

Obsługiwane Platformy

Narzędzie	Integracja	Funkcje
Prometheus	Natywny endpoint /metrics	Skrapowanie metryk
Grafana	Wtyczka źródła danych	Niestandardowe panele
Datadog	Integracja API	Śledzenie APM
New Relic	Integracja agenta	Pełna obserwowalność
PagerDuty	Alerty webhook	Zarządzanie incydentami

Najlepsze Praktyki Monitorowania

1. Monitoruj Kluczowe Metryki

Skup się na metrykach, które bezpośrednio wpływają na Twój biznes: czas dostępności, opóźnienie, wskaźnik błędów.

2. Ustaw Odpowiednie Alerty

Alertuj na podstawie symptomów, nie tylko progów. Kieruj alerty według ważności.

3. Używaj ID Żądań

Zawsze koreluj żądania z unikalnymi ID dla śledzenia end-to-end.

4. Wprowadź Śledzenie Rozproszone

Użyj W3C Trace Context dla widoczności w mikroserwisach.

5. Regularne Testy Alertów

Testuj kanały alertów co miesiąc, aby upewnić się, że eskalacja działa.

6. Dokumentuj Odpowiedź na Alerty

Twórz podręczniki dla typowych alertów z krokami rozwiązywania.

Zapewnij 99.9% Czasu Dostępności

Monitoruj Smart Money API z kompleksowymi kontrolami zdrowia, metrykami i alertami. Utrzymuj zgodność z SLA za pomocą wbudowanych narzędzi obserwowalności.

Rozpocznij

Plany Pro i Enterprise obejmują dedykowane wsparcie i monitorowanie SLA.