Search
K

Traceability

Traceability is essential for debugging and support. Every AgentSync API response includes a unique request identifier that allows you to track and correlate requests across systems.

Request Identifier

The identified is returend in the X-Trace-ID response header:

X-Trace-ID: <trace-id>

Why It Matters

  • Debugging: Helps pinpoint issues in logs and trace the lifecycle of a request.
  • Support: Speeds up resolution when you provide the trace ID to AgentSync’s support team.
  • Correlation: Enables linking API calls with internal monitoring or distributed tracing tools.

Best Practices

  • Log the trace ID: Capture the X-Trace-ID in your application logs for every API call.
  • Include in error reports: When exceptions occur, attach the trace ID to error messages.
  • Provide to support: Always share the trace ID when opening a support ticket to expedite troubleshooting.
  • Use in monitoring tools: Integrate the trace ID with observability platforms (e.g., Datadog, Splunk) for end‑to‑end request tracking.