Document new dashboard logs functionality and capabilities#462
Document new dashboard logs functionality and capabilities#462bean1352 wants to merge 5 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| You can manage logs with the following options: | ||
|
|
||
| * **Filter Options**: Filter logs by level (`Note`, `Error`, `Warning`, `Debug`) and by date range. | ||
| * **Log Type**: Switch between **API logs** (Service) and **Replication logs**. |
There was a problem hiding this comment.
Are replication logs not also produced by the Service? Kobie and I actually also just spoke about "API logs" being a bit of a very broad name, though it does seem to have some technical accuracy - i.e. it looks like you only get access to the diagnostics API when the API container runs. This definition in our docs makes sense: "The API container handles streaming sync connections, as well as any other API calls.". Maybe we can say "API logs (sync connection and other API calls)". @rkistner keen to hear your thoughts.
|
|
||
| #### Field Filters | ||
|
|
||
| Use `alias:value` to filter on a structured field. Repeating an alias matches any of the listed values (OR within a field, AND across fields): |
There was a problem hiding this comment.
| Use `alias:value` to filter on a structured field. Repeating an alias matches any of the listed values (OR within a field, AND across fields): | |
| Use `alias:value` to filter on a structured field. Repeating an alias matches any of the listed values (i.e. they match as OR; different aliases match as AND in the query): |
|
|
||
| Only one numeric comparison is allowed per field. Combining `lag:>5 lag:<10` is rejected. | ||
|
|
||
| #### Unknown Fields |
There was a problem hiding this comment.
Maybe we should rather call this "Filtering on other Metadata Fields" and then explain it like:
The "Add filter" dropdown lists common fields shared across most log types. But log entries can contain many additional fields depending on the service — you can filter on any of them using alias:value syntax directly in the search bar. For example...
|
We should also add updated instructions to usage troubleshooting instructions around searching logs - the current page still refers to using browser search, e.g. https://docs.powersync.com/resources/usage-and-billing/usage-and-billing-faq#diagnose-data-synced-spikes |
2 participants
Summary
Expands the Instance Logs section in
maintenance-ops/monitoring-and-alerting.mdxto cover the new search input grammar and CSV export in the dashboard.Changes
alias:valuefield filters, numeric comparisons (>,>=,<,<=,=), and pass-through for unknown fields.