Add Application Logs documentation to Dashboard guide#3311
Add Application Logs documentation to Dashboard guide#3311
Conversation
Adds a new "Logs" section under Clerk Dashboard with an Application Logs overview and a supported events reference page covering all ~100+ event types.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collapse the Application Logs sub-tree into a single page so each log type lives at one nesting level under Logs, with Supported events as an in-page section. Prepares the structure for Email, SMS, and Admin logs without duplicated reference pages. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
- Point the Dashboard link at the actual Logs page (`/~/logs`). - Use the repo's relative `/pricing` convention. - Name Production and Development explicitly in the retention note. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
Pushed some changes directly in 29b4de6.
I'll leave the rest as inline comments. |
|
|
||
| Retention periods apply equally to Production and Development instances. | ||
|
|
||
| ## Supported events |
There was a problem hiding this comment.
I'm guessing these 100+ events transcribed by hand. What's the plan to keep it in sync with the Dashboard's Event Catalog?
There was a problem hiding this comment.
I think it could be good to have a script at least to perform these updates, something like:
- Add a new event (or update/remove a current one)
- Run the script
- Copy the output to the docs repo
It stills manually, but could work so far.
There was a problem hiding this comment.
We have other scripts to keep things in sync that we could borrow inspiration from.
This can be a follow up PR(s). I just want us keeping longer-term maintenance in mind.
Can you link me to the repo/source files where these originate from?
There was a problem hiding this comment.
They originate from this proto file:
https://github.com/clerk/clerk_go/blob/main/api/shared/event_stream/payloads.proto
We are using the ones that have only option tag called system_log for this application logs.
There was a problem hiding this comment.
Task for creating the sync script → https://linear.app/clerk/issue/DOCS-11699/add-a-sync-for-application-log-events
There was a problem hiding this comment.
Thanks! I see that you have it assigned, I could also take it on, just in case.
There was a problem hiding this comment.
@Jibaru you're welcome to take a stab at it. I assigned it because I didn't want to lose track of it.
Distinguishes a public breach database match (`pwned`) from an admin- or policy-triggered mandatory reset (`compromised`) so folks filtering logs know which signal they're looking at. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Correct the retention periods for Business (60 → 30 days) and Enterprise (120 → 30 days) plans to match the actual values.
Remove duplicate user-scoped email address and phone number event sections (user.email_address.* and user.phone_number.*) and add missing verified events (email_address.verified, phone_number.verified) to the standalone event tables.
Update web3 wallet event types to match the proto system_log definitions by removing the `user.` prefix.
Two thoughts:
|
Add a beta warning callout at the top of the Application Logs page and a (Beta) tag to the navigation entry in the manifest.
The note about payloads being omitted from the list view exposed backend implementation details not relevant to users.
|
Updated with all of your feedback. Only missing the url we are going to use to redirect to the Logs Dashboard. @brunol95 @manovotny |
Move the web3 wallet subsection alongside Email address and Phone number at the top level so its placement matches its prefix-less identifiers, and tighten the descriptions to match the generic phrasing those sibling sections use. Mark the page title as beta. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
The (Beta) manifest tag and the beta WARNING callout added in fc3530f already signal beta status, so keep the page title clean. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
Pushed some changes directly in 1acbfdf.
|
|
|
|
All we're waiting on is the final url, correct? |
Yes, and an approval from project leader |
The Enterprise plan offers custom retention periods rather than a fixed 30-day limit. Update the retention table to reflect this.
Adds a new "Logs" section under Clerk Dashboard with an Application Logs overview and a supported events reference page covering all ~100+ event types.
🔎 Previews:
Screenshots
What does this solve? What changed?
Deadline
Probably this week.
Other resources
https://linear.app/clerk/issue/USER-5222/add-system-logs-documentation