diff --git a/installation/quickstart-guide.mdx b/installation/quickstart-guide.mdx index 6b6a53ae..e98107da 100644 --- a/installation/quickstart-guide.mdx +++ b/installation/quickstart-guide.mdx @@ -44,8 +44,8 @@ The following outlines our recommended steps to implement PowerSync in your proj Generate a [Development Token](/installation/authentication-setup/development-tokens) so you can get up and running quickly, without implementing full authentication integration yet. - - Use our hosted [Diagnostics App](https://diagnostics-app.powersync.com) to validate that your backend source database is syncing into SQLite as expected based on your Sync Rules. + + Use our hosted [Sync Diagnostics Client](https://diagnostics-app.powersync.com) to validate that your backend source database is syncing into SQLite as expected based on your Sync Rules. Implement PowerSync in your app using one of our Client SDKs: diff --git a/resources/troubleshooting.mdx b/resources/troubleshooting.mdx index 751aa80e..86d6ef97 100644 --- a/resources/troubleshooting.mdx +++ b/resources/troubleshooting.mdx @@ -24,9 +24,9 @@ Troubleshooting techniques depend on the type of issue: 4. **Writes to the backend database are failing:** PowerSync is not actively involved: use normal debugging techniques (server-side logging; client and server-side error tracking). 5. **Updates are slow to sync, or queries run slow**: See [Performance](/resources/troubleshooting#performance) -### Diagnostics app +### Sync Diagnostics Client -Access the diagnostics app here: [https://diagnostics-app.powersync.com](https://diagnostics-app.powersync.com) +Access the Sync Diagnostics Client here: [https://diagnostics-app.powersync.com](https://diagnostics-app.powersync.com) This is a standalone web app that presents data from the perspective of a specific user. It can be used to: @@ -63,7 +63,7 @@ Essentially, run the following to grab the SQLite file: -Our [diagnostics app](/resources/troubleshooting#diagnostics-app) and several of our [demo apps](/resources/demo-apps-example-projects) also contain a SQL console view to inspect the local database contents. Consider implementing similar functionality in your app. See a React example [here](https://github.com/powersync-ja/powersync-js/blob/main/tools/diagnostics-app/src/app/views/sql-console.tsx). +Our [Sync Diagnostics Client](/resources/troubleshooting#sync-diagnostics-client) and several of our [demo apps](/resources/demo-apps-example-projects) also contain a SQL console view to inspect the local database contents. Consider implementing similar functionality in your app. See a React example [here](https://github.com/powersync-ja/powersync-js/blob/main/tools/diagnostics-app/src/app/views/sql-console.tsx). ### Client-side Logging diff --git a/resources/usage-and-billing/usage-and-billing-faq.mdx b/resources/usage-and-billing/usage-and-billing-faq.mdx index fd93062f..ac14d73a 100644 --- a/resources/usage-and-billing/usage-and-billing-faq.mdx +++ b/resources/usage-and-billing/usage-and-billing-faq.mdx @@ -196,7 +196,7 @@ Data hosted can temporarily spike during Sync Rule deployments and defragmentati ![](/images/resources/instance-logs-sync-stream-complete.png) ## 3. **Compare Metrics** - Use the [Diagnostics app](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) to compare total rows vs. operations synced to the user device. If you are seeing a much higher number of operations, you might benefit from [defragmentation](/usage/lifecycle-maintenance/compacting-buckets#defragmenting). + Use the [Sync Diagnostics Client](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) to compare total rows vs. operations synced to the user device. If you are seeing a much higher number of operations, you might benefit from [defragmentation](/usage/lifecycle-maintenance/compacting-buckets#defragmenting). ## 4. **Detailed Sync Operations** - Use the [test-client](https://github.com/powersync-ja/powersync-service/blob/main/test-client/src/bin.ts)'s `fetch-operations` command with the `--raw` flag: diff --git a/self-hosting/installation/client-side-setup.mdx b/self-hosting/installation/client-side-setup.mdx index 27db4a1e..1871c66f 100644 --- a/self-hosting/installation/client-side-setup.mdx +++ b/self-hosting/installation/client-side-setup.mdx @@ -7,7 +7,7 @@ We recommend splitting up your client-side implementation into four phases: - + @@ -70,9 +70,9 @@ const token = await new jose.SignJWT({}) console.log(token); ``` -## 2. Run the Diagnostics app using a development token +## 2. Run the Sync Diagnostics Client using a development token -With the [Diagnostics web app](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) you can quickly inspect a user's local database. By using this you can confirm that the PowerSync Service configuration and sync rules behave as expected without needing to set up authentication or app UI. +With the [Sync Diagnostics Client](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) you can quickly inspect a user's local database. By using this you can confirm that the PowerSync Service configuration and Sync Rules behave as expected without needing to set up authentication or app UI. The app is currently available at [https://diagnostics-app.powersync.com](https://diagnostics-app.powersync.com/) @@ -87,7 +87,7 @@ Enter your PowerSync Service endpoint (see the port number specified in your con **Checkpoint:** - Inspect your global bucket and synced table (from the [PowerSync Service Setup](/self-hosting/installation/powersync-service-setup) section) in the diagnostics app — these should match the sync rules you [defined previously](/self-hosting/installation/powersync-service-setup#1.sync-rules). + Inspect your global bucket and synced table (from the [PowerSync Service Setup](/self-hosting/installation/powersync-service-setup) section) in the Sync Diagnostics Client — these should match the sync rules you [defined previously](/self-hosting/installation/powersync-service-setup#1.sync-rules). ## 3. Use the Client SDK with a development token diff --git a/tutorials/self-host/generate-dev-token.mdx b/tutorials/self-host/generate-dev-token.mdx index ce0b5a1a..08a456b1 100644 --- a/tutorials/self-host/generate-dev-token.mdx +++ b/tutorials/self-host/generate-dev-token.mdx @@ -14,7 +14,7 @@ Development tokens are useful for: Development tokens can be used either with the - [test-client](https://github.com/powersync-ja/powersync-service/tree/main/test-client), or -- [the diagnostics app](/resources/troubleshooting#diagnostics-app) +- [Sync Diagnostics Client](/resources/troubleshooting#sync-diagnostics-client) # Generate a Development Token Development tokens can be generated via either diff --git a/usage/lifecycle-maintenance/compacting-buckets.mdx b/usage/lifecycle-maintenance/compacting-buckets.mdx index be58dcbb..e3416ee6 100644 --- a/usage/lifecycle-maintenance/compacting-buckets.mdx +++ b/usage/lifecycle-maintenance/compacting-buckets.mdx @@ -138,7 +138,7 @@ Note: All rows in the bucket must be updated for this to be effective. If some r You should consider defragmenting your buckets when: -1. **High Operations-to-Rows Ratio**: If you notice that the number of operations significantly exceeds the number of rows in a bucket. You can inspect this using the [Diagnostics app](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app). +1. **High Operations-to-Rows Ratio**: If you notice that the number of operations significantly exceeds the number of rows in a bucket. You can inspect this using the [Sync Diagnostics Client](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app). 2. **Frequent Updates**: Tables that are frequently updated (e.g., status fields, counters, or audit logs) 3. **Large Data Churn**: Tables where you frequently insert and delete many rows @@ -173,7 +173,7 @@ Defragmenting + compacting as described above can significantly reduce the numbe Key considerations: 1. **Frequency**: More frequent defragmentation means fewer operations per sync but more frequent re-syncs 2. **Scope**: Defragmenting all rows at once is more efficient but causes a larger sync cycle -3. **Monitoring**: Use the [Diagnostics app](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) to track operations-to-rows ratio +3. **Monitoring**: Use the [Sync Diagnostics Client](https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app) to track operations-to-rows ratio ## Sync Rule deployments diff --git a/usage/tools.mdx b/usage/tools.mdx index e403c531..efdb228a 100644 --- a/usage/tools.mdx +++ b/usage/tools.mdx @@ -7,7 +7,7 @@ mode: wide - + diff --git a/usage/tools/diagnostic-app.mdx b/usage/tools/diagnostic-app.mdx index c012742e..2ff11916 100644 --- a/usage/tools/diagnostic-app.mdx +++ b/usage/tools/diagnostic-app.mdx @@ -1,4 +1,4 @@ --- -title: Diagnostics App +title: Sync Diagnostics Client url: https://github.com/powersync-ja/powersync-js/tree/main/tools/diagnostics-app ---