TraceFlux

RESOURCES · TECHNICAL

Quickstart Guide

From telemetry ingestion to deterministic incident validation in under 15 minutes.

What you'll accomplish

Progress checklist

  • ☐ API key created
  • ☐ Sample telemetry ingested
  • ☐ Incident visible
  • ☐ Governance policy applied
  • ☐ Replay executed

In this guide you will ingest sample telemetry, observe deterministic incident formation, apply a governance policy, and validate execution using replay.

Prerequisites

  • • Access to a TraceFlux tenant
  • • API key with write permissions
  • • curl installed locally
Need access? Request Early Access →

Step 1 — Create an API key

Authenticate requests against your tenant.

COMMAND

curl -X POST https://api.traceflux.io/v1/api-keys \
  -H "Authorization: Bearer <admin_key>"

EXPECTED RESPONSE

{
  "key": "tf_live_xxxxxxxxx",
  "scope": "tenant"
}

Step 2 — Send sample telemetry

Ingest an event into the deterministic engine.

COMMAND

curl -X POST https://api.traceflux.io/v1/ingest/events \
  -H "Authorization: Bearer tf_live_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "checkout",
    "metric": "latency_ms",
    "value": 1800,
    "region": "us-east-1"
  }'

EXPECTED RESPONSE

{
  "status": "accepted",
  "event_id": "evt_123"
}

Step 3 — Verify deterministic incident formation

Confirm the engine created or updated an incident.

COMMAND

curl https://api.traceflux.io/v1/incidents \
  -H "Authorization: Bearer tf_live_xxxxxxxxx"

EXPECTED RESPONSE

{
  "data": [
    {
      "id": "inc_001",
      "severity": "high",
      "state": "open",
      "source": "deterministic_engine"
    }
  ]
}

Step 4 — Configure governance policy

Enforce execution boundaries before automation.

COMMAND

curl -X POST https://api.traceflux.io/v1/policies \
  -H "Authorization: Bearer tf_live_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "High Severity Approval",
    "requires_approval": true
  }'

EXPECTED RESPONSE

{
  "policy_id": "pol_789",
  "status": "active"
}

Step 5 — Run replay validation

Validate automation path on historical telemetry.

COMMAND

curl -X POST https://api.traceflux.io/v1/replay \
  -H "Authorization: Bearer tf_live_xxxxxxxxx" \
  -d '{"incident_id":"inc_001"}'

EXPECTED RESPONSE

{
  "replay_id": "rep_456",
  "status": "queued"
}

Next steps