DEVELOPER DOCUMENTATION
Send production events to TrafficWar.
Start with the published Node.js server SDK, then use the same canonical event contract across live maps, metrics, traces, alerts, and queries.
Capture your first TrafficWar event with Node.js.
Install @trafficwar/node, configure a server API key, capture an event, and close the client during graceful shutdown.
Use stable event identities that stay useful at scale.
Reference for TrafficWar event categories, labels, sources, operation types, traces, HTTP fields, timestamps, and properties.
Send events over the TrafficWar ingest API.
TrafficWar capture and batch endpoints, Bearer authentication, JSON and MessagePack bodies, batch limits, quotas, and durable acknowledgement.
Connect spans with one trace ID and route label.
Model TrafficWar traces across HTTP, database, Redis, and S3 tiers using trace_id, label, source, span_kind, and operation_type.
Scrape service-scoped hot metrics.
Configure Prometheus to scrape TrafficWar lifetime in-memory hot event counters and latency histograms with a service API key.
Turn metric conditions into incidents and notifications.
Create TrafficWar alert rules and deliver incidents through email, Telegram, or verified webhooks with plan-aware quotas and cooldowns.
Query service-scoped events programmatically.
Use the TrafficWar query API with a Bearer service key to retrieve filtered event rows without exposing object storage.
Start here
- Getting started: install the SDK, configure a key, and capture the first event.
- Event schema: choose stable event, label, source, and operation identities.
- Ingest API: send bare JSON or MessagePack arrays directly when an SDK is not a fit.
Investigate and integrate
- Traces: connect spans with trace_id and a shared label.
- Prometheus: scrape service-scoped lifetime hot metrics.
- Alerts: route incidents to email, Telegram, or webhooks.
- Query API: retrieve service-scoped event rows with a Bearer key.