Audit & Metrics

Create Audit Event

Create a custom audit event.

cURL

curl -X POST \
  -H "x-api-key: dev-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "transaction",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "eventType": "transaction.created",
    "txId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "550e8400-e29b-41d4-a716-446655440000",
    "payload": {
      "type": "transfer_sol",
      "amount": 1000000
    }
  }' \
  http://localhost:3000/api/v1/audit/events

Request Body

enum

required

Entity type: transaction, wallet, agent, policy, escrow, system

string

required

Entity identifier (UUID or string)

string

required

Event type identifier (e.g., transaction.created, agent.started)

string

Optional transaction UUID for correlation

string

Optional wallet UUID for correlation

string

Optional agent UUID for correlation

string

Optional protocol name for correlation

string

Optional escrow ID for correlation

object

required

Event-specific data (flexible schema)

Response

string

required

Audit event UUID

string

required

Entity type

string

required

Entity ID

string

required

Event type

string

required

ISO 8601 timestamp (server-assigned)

object

required

Event payload

{
  "status": "success",
  "data": {
    "id": "abc123-def456-...",
    "entityType": "transaction",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "eventType": "transaction.created",
    "timestamp": "2026-03-08T12:00:00.000Z",
    "txId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "550e8400-e29b-41d4-a716-446655440000",
    "payload": {
      "type": "transfer_sol",
      "amount": 1000000
    }
  }
}

Most audit events are created automatically by the system. This endpoint is for custom application events.

Query Audit Events

Query audit events with filters.

cURL

curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?txId=123e4567-e89b-12d3-a456-426614174000"

Query Parameters

string

Filter by transaction UUID

string

Filter by wallet UUID

string

Filter by agent UUID

string

Filter by protocol name

string

Filter by escrow ID

enum

Filter by entity type: transaction, wallet, agent, policy, escrow, system

string

Filter by event type (e.g., transaction.created)

number

default:"50"

Maximum events to return (max: 100)

number

default:"0"

Number of events to skip

string

Filter events after timestamp (ISO 8601)

string

Filter events before timestamp (ISO 8601)

Response

{
  "status": "success",
  "data": {
    "events": [
      {
        "id": "abc123-def456-...",
        "entityType": "transaction",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "eventType": "transaction.stage_change",
        "timestamp": "2026-03-08T12:00:01.000Z",
        "txId": "123e4567-e89b-12d3-a456-426614174000",
        "payload": {
          "from": "pending",
          "to": "simulating"
        }
      }
    ],
    "total": 15,
    "limit": 50,
    "offset": 0
  }
}

Common Event Types

Event Type	Description
`transaction.created`	Transaction created
`transaction.stage_change`	Stage changed
`transaction.policy_evaluated`	Policy evaluation completed
`transaction.approved`	Manually approved
`transaction.rejected`	Manually rejected
`transaction.signed`	Transaction signed
`transaction.submitted`	Submitted to network
`transaction.confirmed`	Confirmed on-chain
`transaction.failed`	Transaction failed
`transaction.retried`	Retry attempted

Event Type	Description
`wallet.created`	Wallet created
`wallet.balance_checked`	Balance queried
`wallet.tokens_queried`	Token balances queried
`wallet.signed`	Message/transaction signed
`wallet.disabled`	Wallet disabled

Event Type	Description
`agent.created`	Agent created
`agent.started`	Agent started
`agent.stopped`	Agent stopped
`agent.paused`	Agent paused
`agent.resumed`	Agent resumed
`agent.capabilities_updated`	Capabilities changed
`agent.budget_allocated`	Budget allocated
`agent.budget_exceeded`	Budget limit exceeded
`agent.manifest_issued`	Capability manifest issued
`agent.executed_intent`	Intent executed

Event Type	Description
`policy.created`	Policy created
`policy.updated`	Policy updated
`policy.version_created`	New version created
`policy.evaluated`	Policy evaluation
`policy.allowed`	Operation allowed
`policy.denied`	Operation denied
`policy.approval_required`	Approval required
`policy.migrated`	Policy migrated

Event Type	Description
`escrow.created`	Escrow created
`escrow.accepted`	Escrow accepted
`escrow.released`	Funds released
`escrow.refunded`	Funds refunded
`escrow.disputed`	Dispute raised
`escrow.resolved`	Dispute resolved

Event Type	Description
`system.started`	Service started
`system.shutdown`	Service shutdown
`system.health_check`	Health check performed
`system.rpc_failover`	RPC endpoint failover
`system.chaos_enabled`	Chaos mode enabled
`system.chaos_disabled`	Chaos mode disabled

Increment Metric

Increment a named metric counter.

cURL

curl -X POST \
  -H "x-api-key: dev-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "transactions.confirmed",
    "value": 1
  }' \
  http://localhost:3000/api/v1/metrics/inc

Request Body

string

required

Metric name (dot-notation recommended)

number

default:1

Value to increment (default: 1)

Response

{
  "status": "success",
  "data": {
    "name": "transactions.confirmed",
    "value": 42
  }
}

Get Metrics

Retrieve all metric counters.

cURL

curl -H "x-api-key: dev-api-key" \
     http://localhost:3000/api/v1/metrics

Response

{
  "status": "success",
  "data": {
    "metrics": {
      "transactions.created": 150,
      "transactions.confirmed": 142,
      "transactions.failed": 8,
      "wallets.created": 25,
      "agents.created": 5,
      "policies.evaluated": 200,
      "policies.allowed": 195,
      "policies.denied": 5
    },
    "timestamp": "2026-03-08T12:00:00.000Z"
  }
}

Observability Patterns

Transaction Tracing

Trace a complete transaction lifecycle:

# Get all events for a transaction
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?txId=123e4567-e89b-12d3-a456-426614174000"

Expected event sequence:

transaction.created
transaction.stage_change (pending -> simulating)
transaction.stage_change (simulating -> policy_eval)
transaction.policy_evaluated
transaction.stage_change (policy_eval -> signing)
transaction.signed
transaction.stage_change (signing -> submitting)
transaction.submitted
transaction.stage_change (submitting -> confirmed)
transaction.confirmed

Agent Activity Monitoring

Monitor agent behavior:

# Get all agent events
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?agentId=agent-id&limit=100"

Key metrics:

Execution frequency
Success/failure ratio
Policy violations
Budget usage

Policy Effectiveness

Analyze policy decisions:

# Get policy evaluation events
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?eventType=policy.evaluated&limit=100"

Analyze:

Allow/deny ratios
Most common denial reasons
Approval queue depth
Policy version effectiveness

Error Analysis

Identify failure patterns:

# Get failed transactions
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?eventType=transaction.failed&limit=50"

Group by:

Error code
Failed stage
Protocol
Wallet/agent

Metric Categories

Transaction Metrics

transactions.created
transactions.confirmed
transactions.failed
transactions.retried
transactions.approved
transactions.rejected
transactions.by_type.{type}
transactions.by_protocol.{protocol}

Policy Metrics

policies.evaluated
policies.allowed
policies.denied
policies.approval_required
policies.by_rule.{rule_type}

Agent Metrics

agents.created
agents.started
agents.stopped
agents.paused
agents.executed
agents.budget_exceeded

Error Metrics

errors.validation
errors.policy_violation
errors.pipeline_error
errors.confirmation_failed
errors.by_stage.{stage}

Best Practices

Use structured event types with dot notation (e.g., transaction.created)

Include correlation IDs (txId, walletId, agentId) in all events

Query with time bounds for large event volumes

Monitor metric trends over time, not just absolute values

Set up alerts on critical metrics (error rates, budget exceeded)

Use audit events for compliance and post-incident analysis

Example: Performance Dashboard

# Transaction success rate
curl -H "x-api-key: dev-api-key" http://localhost:3000/api/v1/metrics

# Recent failures
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?eventType=transaction.failed&limit=10"

# Policy denial rate
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?eventType=policy.denied&since=2026-03-08T00:00:00.000Z"

# Agent activity
curl -H "x-api-key: dev-api-key" \
     "http://localhost:3000/api/v1/audit/events?entityType=agent&limit=50"

Retention and Storage

Audit events are stored in SQLite by default:

AUDIT_OBSERVABILITY_DB_PATH=/path/to/audit.db

For production deployments with high event volume, consider migrating to PostgreSQL or a dedicated logging service.

Regularly export audit events for long-term archival and compliance requirements.

Overview

Endpoints

Create Audit Event

Request Body

Response

Query Audit Events

Query Parameters

Response

Common Event Types

Increment Metric

Request Body

Response

Get Metrics

Response

Observability Patterns

Transaction Tracing

Agent Activity Monitoring

Policy Effectiveness

Error Analysis

Metric Categories

Transaction Metrics

Policy Metrics

Agent Metrics

Error Metrics

Best Practices

Example: Performance Dashboard

Retention and Storage

​Create Audit Event

​Request Body

​Response

​Query Audit Events

​Query Parameters

​Response

​Common Event Types

​Increment Metric

​Request Body

​Response

​Get Metrics

​Response

​Observability Patterns

​Transaction Tracing

​Agent Activity Monitoring

​Policy Effectiveness

​Error Analysis

​Metric Categories

​Transaction Metrics

​Policy Metrics

​Agent Metrics

​Error Metrics

​Best Practices

​Example: Performance Dashboard

​Retention and Storage

Create Audit Event

Request Body

Response

Query Audit Events

Query Parameters

Response

Common Event Types

Increment Metric

Request Body

Response

Get Metrics

Response

Observability Patterns

Transaction Tracing

Agent Activity Monitoring

Policy Effectiveness

Error Analysis

Metric Categories

Transaction Metrics

Policy Metrics

Agent Metrics

Error Metrics

Best Practices

Example: Performance Dashboard

Retention and Storage