
Automatic Axiom dashboard generated for Convex log streams
This page explains how to connecting with Convex can enhance your Axiom experience. For instructions on streaming data from Convex to Axiom, see Send data from Convex.
Convex and log streams
Convex is the backend platform that keeps your app in sync. It’s the open source, reactive database where queries are TypeScript code running right in the database. Just like React components react to state changes, Convex queries react to database changes. Convex provides a database, a place to write your server functions, and client libraries. It makes it easy to build and scale dynamic live-updating apps. Log streams enable streaming of events such as function executions andconsole.log
s from your Convex deployment to supported destinations like Axiom, Datadog, or custom webhooks.
Log streams require a Convex Professional plan. Learn more about Convex pricing plans or upgrade your account.
Benefits of connecting Axiom with Convex
Convex’s built-in features allow you to see the most recent logs produced by your deployment. Additionally, log streaming to Axiom provides comprehensive observability for your backend operations.- Historical log storage beyond the recent logs view.
- Powerful querying with Axiom Processing Language (APL).
- Advanced data visualization and custom dashboards.
- Integration with monitoring tools like PagerDuty, Slack, and more.
- Real-time alerting based on function performance and errors.
Analyze function performance
Convex log streams send structured data to Axiom that includes the following key fields:Log data structure
Log data structure
['data.topic']
: Event type['data.status']
: Execution status['data.function.path']
: Full function path['data.function.type']
: Function type['data.function.component_path']
: Component path['data.execution_time_ms']
: Function execution time in milliseconds['data.usage.database_read_documents']
: Number of documents read['data.usage.database_read_bytes']
: Bytes of data read['data.function.cached']
: Cache hit indicator for queries['convex.project_slug']
: Convex project identifier['convex.deployment_name']
: Deployment name['convex.deployment_type']
: Deployment type
Track function execution times
Track function execution times
Identify slow-performing functions by analyzing execution times:
Track function errors
Track function errors
Track functions that are experiencing failures:
Analyze function types
Analyze function types
Compare performance across different function types (queries, mutations, actions):
Track database usage
Track database usage
Track database read patterns and identify resource-intensive functions:
Track cache performance
Track cache performance
Track query cache hit rates for optimization:
Track scheduled job performance
Track scheduled job performance
Track scheduled job lag and performance:
Set up monitoring and alerting
Create monitors to get notified about issues in your Convex deployment.Function failure rate alerts
Function failure rate alerts
Monitor functions with high error rates:
Slow function alerts
Slow function alerts
Set up alerts for functions exceeding execution time thresholds:
Prebuilt dashboard
When you configure a Convex dataset in Axiom, a dashboard is automatically created in the Integrations section of the Dashboards tab. This prebuilt dashboard provides immediate insights into your Convex function performance and errors. The dashboard includes:- Function execution metrics: Success rates, error counts, and performance trends.
- Database operation insights: Query patterns, mutation frequencies, and subscription activity.
- Error analysis: Error types, frequency, and affected functions.
- Performance monitoring: Response times, throughput, and resource utilization.
Next steps
- Explore your Convex data in Axiom and learn APL to query your Convex logs.
- Create custom dashboards for your team.
- Set up monitors to get alerted about issues.