diff --git a/images/usage-metrics.png b/images/usage-metrics.png new file mode 100644 index 00000000..ec0d46ad Binary files /dev/null and b/images/usage-metrics.png differ diff --git a/usage/tools/monitoring-and-alerting.mdx b/usage/tools/monitoring-and-alerting.mdx index 4f0a2932..c7413151 100644 --- a/usage/tools/monitoring-and-alerting.mdx +++ b/usage/tools/monitoring-and-alerting.mdx @@ -5,6 +5,7 @@ description: Overview of monitoring and alerting functionality for PowerSync ins You can monitor activity and alert on issues and usage for your PowerSync instance(s): +* **Monitor Usage**: View time-series and aggregated usage data with [Usage Metrics](#usage-metrics) * **Monitor Service and Replication Activity**: Track your PowerSync service and replication logs with [Instance Logs](#instance-logs) * **Configure Alerts**: Set up alerts for connection issues or usage activity \* * Includes [Issue Alerts](#issue-alerts) and/or [Metric Alerts](#metric-alerts) @@ -20,6 +21,7 @@ Monitoring and alerting functionality varies by [PowerSync Cloud plan](https://w | Feature | Free | Pro | Team & Enterprise | |-------------------------|----------------------------------------|----------------------------------------|-----------------------------------------| +| **Usage Metrics** | Available | Available | Available | | **Instance Logs** | Available | Available | Available | | Log retention period | 24 hours | 7 days | 30 days | | **Issue Alerts** | Fatal alerts (Coming soon) | Fatal alerts (Coming soon) | Fully configurable | @@ -37,6 +39,28 @@ We plan to publish alerting APIs for Open Edition users, and an alerting service Until this is available, please chat to us on our [Discord](https://discord.gg/powersync) to discuss your use case or any questions. +## Usage Metrics + +View time-series and aggregated usage data for your PowerSync instance(s), including storage size, concurrent connections, and synced data and operations. This data lets you monitor activity, spot patterns or spikes, and easily budget while tracking your position within our [Cloud pricing plans](https://www.powersync.com/pricing). + +### View Usage Metrics + +Access usage metrics in the [Dashboard](/usage/tools/powersync-dashboard), in the **Metrics** workspace: + + + + + +You have following options: +* **Filter options**: data by time range. +* **Granularity**: See data in a daily or hourly granularity. +* **Aggregates**: View and copy aggregates for each usage metric. +* **CSV**: Download data as CSV for custom calculations. + + +This usage data is also available programatically via APIs. Chat to us on our [Discord](https://discord.gg/powersync) if you require details. + + ## Instance Logs You can review logs for your PowerSync instance(s) to troubleshoot replication or sync issues. Logs capture activity from the PowerSync Service and Replicator processes.