Provenance Documentation

Welcome to the Provenance documentation. Provenance is a tracking and analytics platform that records, analyzes, and acts on resource interactions across distributed systems.

Getting started

New to Provenance? Start here:

1. Introduction — What Provenance is and why you need it
2. Quick Start — Sign up and record your first interaction
3. Configuration — API base URL, authentication, and rate limits
4. First Interaction — Detailed walkthrough of the interaction model

Core concepts

Understand the building blocks:

• Resource Types — Categories of things you're tracking
• Actions — Operations that can be performed
• Origins — Source systems where interactions originate
• Interactions — The core event model
• Unit of Work — Correlate related interactions

Authentication

Secure your API access:

• API Keys — Simple key-based authentication
• OAuth (Client Credentials) — Machine-to-machine auth with scoped tokens

Dashboard UI

The Provenance management dashboard:

• Overview — Layout, navigation, themes, and permissions
• Home — Real-time system overview
• Configuration — Manage resource types, actions, and origins
• Interactions — Browse and inspect interactions
• Activity Search — Advanced search with JSON path filtering
• Traces — Visualize interaction flows
• Dashboards & Widgets — Build analytics dashboards
• Metrics & Alerts — Define metrics and threshold alerts
• Notifications — Subscribers, subscriptions, and queue
• Inbound Webhooks — Manage sources and mappings
• Settings — Adapter settings, global config, and secrets

Notifications

Event-driven notifications:

• Subscriptions — Subscribe to events
• Template Engine — Variable substitution, functions, and secrets in templates
• Adapters — Built-in notification adapters
• Custom Adapters — Build your own
• Queue — Queue processing and retry logic

Inbound Webhooks

Receive external events and convert them to interactions:

• Overview — How inbound webhooks work
• Sources — Configure external services and signature verification
• Mappings — Define payload-to-interaction transformations
• Processing Pipeline — Validation, matching, and creation flow

Secrets

Secure credential management:

• Secrets — Store and manage sensitive values for use in templates
• Secret Providers — Connect to AWS SM, Azure KV, GCP SM, or HashiCorp Vault

Analytics

Dashboards and data:

• Dashboards — Create analytics dashboards
• Widgets — Build custom visualizations
• Query API — Ad-hoc analytics queries

Ecosystem

Tools and integrations:

• SDKs — Native client libraries (Node.js, TypeScript, Python, C#, Java)
• Auto-Instrumentation — Zero-code tracking for Node.js
• CLI — Command-line interface
• MCP Server — AI agent integration
• UI — Angular web application