Add docs for moesif - #6181
Merged
Merged
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe pull request adds Asgardeo Insights documentation and navigation, expands Asgardeo analytics data-residency details, and adds shared Moesif setup and event-reference guides for WSO2 Identity Server. ChangesAsgardeo analytics documentation
WSO2 Identity Server Moesif analytics
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (2)
en/asgardeo/docs/guides/insights.md (1)
23-23: ⚡ Quick winKeep “Moesif” and add it to Vale accepted vocabulary if needed.
“Moesif” appears to be the intended product name. If Vale still flags it, add it to
.vale/styles/config/vocabularies/vocab/accept.txtinstead of changing the product name in docs.
As per coding guidelines: use official product names exactly as defined and add valid technical/product terms to the accepted vocabulary.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/asgardeo/docs/guides/insights.md` at line 23, Keep the product name "Moesif" exactly as shown in the insights.md content (do not modify the product name) and add "Moesif" to Vale's accepted vocabulary by appending it to the Vale accept list (accept.txt) so the linter no longer flags it; ensure you update the vocabulary entry rather than altering the docs text.Sources: Coding guidelines, Linters/SAST tools
en/identity-server/next/docs/guides/analytics/moesif-analytics.md (1)
17-154: ⚡ Quick winAdd explicit outcome confirmation and next steps sections for task completion.
The guide has prerequisites and steps, but it does not explicitly include outcome confirmation and a next steps section, which the task-based documentation standard requires.
As per coding guidelines, task-based documentation must include outcome confirmation and end with next steps when appropriate.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/identity-server/next/docs/guides/analytics/moesif-analytics.md` around lines 17 - 154, Add an "Outcome" section after "Step 4: Build dashboards in Moesif" that explicitly confirms successful task completion (e.g., "You should now see events in your Moesif workspace and the Insights tab in the Console"), and add a "Next steps" section at the end (after "Insights for sub-organizations") that lists recommended follow-ups such as verifying event attributes, configuring tenant-specific collectors, setting data retention/permissions in Moesif, and links to troubleshooting and dashboard examples; update headings "Step 4: Build dashboards in Moesif" and the final section to reference these new sections so readers can easily confirm success and know what to do next.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/asgardeo/docs/guides/insights.md`:
- Line 15: Change the phrase in the sentence "Use the duration selector to
adjust the time period shown in the dashboards." by replacing "time period" with
a shorter term such as "time range" or "duration" so the sentence reads e.g.
"Use the duration selector to adjust the time range shown in the dashboards.";
update the exact sentence where it appears to keep wording concise and plain.
- Line 57: Replace all occurrences of the phrase "sub-organization" on this page
(including the section heading and the table row attribute text currently
listing "sub-organization request indicator") with the repository's canonical
organization terminology (use the repo-preferred spelling/term for
"organization") so the term is consistent across the document; update every
instance (also referenced around the other occurrences noted) to match the repo
style rule.
- Line 17: The markdown in en/asgardeo/docs/guides/insights.md contains a broken
image reference
"{{base_path}}/assets/img/guides/insights/insights-dashboard.png"; locate that
image tag in the file and either update the URL to point to the correct existing
asset path (use the actual filename under en/asgardeo/docs/assets/img/... that
matches the dashboard image) or add the missing PNG file at
en/asgardeo/docs/assets/img/guides/insights/insights-dashboard.png so the
relative path resolves; ensure the updated path keeps the same markup attributes
(width/style) and verify the image renders.
In `@en/asgardeo/docs/guides/organization-insights.md`:
- Line 6: The file en/asgardeo/docs/guides/organization-insights.md fails MD047
(single-trailing-newline); open organization-insights.md and ensure the file
ends with exactly one newline character (remove any extra blank lines or missing
newline at EOF), then re-run the Vale/markdown linter to confirm the MD047
warning is resolved.
In `@en/identity-server/next/docs/guides/analytics/moesif-analytics.md`:
- Line 1: The page title "# Moesif Analytics" should use sentence case; update
the heading text from "# Moesif Analytics" to "# Moesif analytics" so the
document title follows the sentence-case style rule (locate the top-level
heading string "Moesif Analytics" and change only its capitalization).
- Line 69: The image reference markdown line using the path
"{{base_path}}/assets/img/guides/analytics/moesif-analytics/moesif-collector-key.png"
is included but the asset may not exist; verify that this file is present and
reachable in the site build output and that the path/template variable resolves
correctly, or remove/replace the markdown image tags (the line with the Moesif
collector key image and the similar image at lines 86) so the guide does not
reference missing assets; update the markdown to either point to an existing
asset, add the missing image to assets/img/guides/analytics/moesif-analytics/,
or remove the image tags and adjust surrounding text to be self-contained.
- Line 26: Replace the TODO placeholder comment "<!-- TODO: Confirm/replace with
the final, complete set of TOML configurations required to enable the Moesif
integration. -->" in moesif-analytics.md with the finalized, validated TOML
configuration required to enable the Moesif integration (or remove the block
entirely and link to an internal tracking issue if the config cannot be
finalized now); ensure any other TODO placeholder in the same document (the
similar marker noted later) is also removed or replaced with concrete, verified
content and that the guide contains no unverified claims or placeholders before
publishing.
---
Nitpick comments:
In `@en/asgardeo/docs/guides/insights.md`:
- Line 23: Keep the product name "Moesif" exactly as shown in the insights.md
content (do not modify the product name) and add "Moesif" to Vale's accepted
vocabulary by appending it to the Vale accept list (accept.txt) so the linter no
longer flags it; ensure you update the vocabulary entry rather than altering the
docs text.
In `@en/identity-server/next/docs/guides/analytics/moesif-analytics.md`:
- Around line 17-154: Add an "Outcome" section after "Step 4: Build dashboards
in Moesif" that explicitly confirms successful task completion (e.g., "You
should now see events in your Moesif workspace and the Insights tab in the
Console"), and add a "Next steps" section at the end (after "Insights for
sub-organizations") that lists recommended follow-ups such as verifying event
attributes, configuring tenant-specific collectors, setting data
retention/permissions in Moesif, and links to troubleshooting and dashboard
examples; update headings "Step 4: Build dashboards in Moesif" and the final
section to reference these new sections so readers can easily confirm success
and know what to do next.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 685abd2b-19b7-46c4-b591-5b70eb168a6f
📒 Files selected for processing (5)
en/asgardeo/docs/guides/insights.mden/asgardeo/docs/guides/organization-insights.mden/asgardeo/mkdocs.ymlen/identity-server/next/docs/guides/analytics/moesif-analytics.mden/identity-server/next/mkdocs.yml
Contributor
Author
|
Added a commit documenting Moesif analytics data publishing in the Data residency reference ( New Analytics data section covers:
It links to the Insights guide's Data published for insights table for the full end-user attribute list. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 9
🧹 Nitpick comments (2)
en/asgardeo/docs/references/data-residency-in-asgardeo.md (2)
84-84: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse active voice for service actions.
Asgardeo is the known actor. Replace “Analytics data is published” with “Asgardeo publishes analytics data” and “records are removed” with “Asgardeo removes records.”
Also applies to: 107-107
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/asgardeo/docs/references/data-residency-in-asgardeo.md` at line 84, Rewrite the service-action statements in the data residency documentation using active voice: change “Analytics data is published” to “Asgardeo publishes analytics data” and change “records are removed” to “Asgardeo removes records,” including the corresponding statement at the other referenced location.Source: Coding guidelines
92-92: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDefine
NICon first use.Write
national identity card (NIC)or use a plain-language term. The current acronym may be unclear to readers outside the region.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/asgardeo/docs/references/data-residency-in-asgardeo.md` at line 92, In the “Types of data published” statement, expand NIC at its first occurrence to “national identity card (NIC)” while preserving the surrounding login-identifier examples and existing link.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/asgardeo/docs/guides/insights/index.md`:
- Around line 34-35: Define each acronym at its first use: in
en/asgardeo/docs/guides/insights/index.md lines 34-35 and 78-80, use
“machine-to-machine (M2M)” and “business-to-business (B2B)” respectively; in
en/asgardeo/docs/guides/insights/insights-dashboards.md lines 51 and 65, use
“machine-to-machine (M2M)” and “multi-factor authentication (MFA)” respectively.
- Around line 65-66: Update the Advanced Analytics note in the insights guide to
replace the vague “give your organization a little time” wording with a direct
instruction to wait for the organization to generate events before the charts
become useful.
- Line 55: Remove the broken image references or add the missing PNG assets for
all affected sites: en/asgardeo/docs/guides/insights/index.md lines 55, 61, and
76, and en/asgardeo/docs/guides/insights/insights-dashboards.md line 13. Prefer
existing screenshot assets and keep the instructions self-sufficient if removing
the references.
- Around line 1-3: Add the Asgardeo `product_name` assignment before the page
heading in both affected standalone pages:
`en/asgardeo/docs/guides/insights/index.md` lines 1-3 and
`en/asgardeo/docs/guides/insights/insights-dashboards.md` lines 1-3. Ensure each
page defines `product_name` as “Asgardeo” before rendering its content.
In `@en/asgardeo/docs/guides/insights/insights-dashboards.md`:
- Around line 49-57: Reconcile the Overview metric descriptions with the
Free-tier availability statement: update the Free-tier list to include New
Users, Self Sign-Ups, and Total Tokens if they are available, or explicitly mark
those metrics as unavailable in the earlier descriptions. Keep both sections
consistent.
In `@en/asgardeo/docs/references/data-residency-in-asgardeo.md`:
- Around line 82-92: Update the Moesif disclosure in the data-residency
documentation to apply only when administrators enable Advanced Analytics, not
to built-in Basic Insights. Revise the references to Insights, data publication,
regional residency, retention, and published end-user data so they clearly
describe Advanced Analytics while preserving the existing Advanced Analytics
purpose and data details.
In `@en/includes/guides/analytics/moesif/data-published-to-moesif.md`:
- Around line 64-68: Update the privacy disclosure near the “not sent” bullets
and the login payload fields around rolesCommaSeparated so it accurately
reflects the published payload: either explicitly include rolesCommaSeparated
and all user-store details that are sent, or qualify the statement after
verifying the payload fields. Keep the disclosure exhaustive and consistent with
the actual analytics data.
- Around line 100-103: Update the analytics guide’s attribute tables so every
affected timestamp row explicitly states its format or unit: createdTimeStamp,
iat, publishingTime, publishTimestamp, and publishTime. Mark each as ISO-8601 or
epoch milliseconds according to the documented data, including all occurrences
identified by the review, and leave unrelated attribute descriptions unchanged.
In `@en/includes/guides/analytics/moesif/set-up-moesif-analytics.md`:
- Line 3: Define abbreviations at first use in each independently rendered
guide: expand SaaS in
en/includes/guides/analytics/moesif/set-up-moesif-analytics.md lines 3-3,
MFA/M2M/B2B in lines 132-152, MFA in
en/includes/guides/analytics/moesif/data-published-to-moesif.md lines 26-26, B2B
in lines 49-50, and OTP in lines 64-68; retain the abbreviations afterward.
---
Nitpick comments:
In `@en/asgardeo/docs/references/data-residency-in-asgardeo.md`:
- Line 84: Rewrite the service-action statements in the data residency
documentation using active voice: change “Analytics data is published” to
“Asgardeo publishes analytics data” and change “records are removed” to
“Asgardeo removes records,” including the corresponding statement at the other
referenced location.
- Line 92: In the “Types of data published” statement, expand NIC at its first
occurrence to “national identity card (NIC)” while preserving the surrounding
login-identifier examples and existing link.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro Plus
Run ID: 9a3a8d3a-2afb-414a-8b6e-252adff2fcd6
📒 Files selected for processing (11)
en/asgardeo/docs/guides/insights/data-published-to-moesif.mden/asgardeo/docs/guides/insights/index.mden/asgardeo/docs/guides/insights/insights-dashboards.mden/asgardeo/docs/guides/organization-insights.mden/asgardeo/docs/references/data-residency-in-asgardeo.mden/asgardeo/mkdocs.ymlen/identity-server/next/docs/guides/analytics/moesif/data-published-to-moesif.mden/identity-server/next/docs/guides/analytics/moesif/index.mden/identity-server/next/mkdocs.ymlen/includes/guides/analytics/moesif/data-published-to-moesif.mden/includes/guides/analytics/moesif/set-up-moesif-analytics.md
🚧 Files skipped from review as they are similar to previous changes (2)
- en/asgardeo/docs/guides/organization-insights.md
- en/asgardeo/mkdocs.yml
bhagyasakalanka
force-pushed
the
moesif-docs
branch
from
July 31, 2026 11:27
2f15ed5 to
9ae80bb
Compare
bhagyasakalanka
force-pushed
the
moesif-docs
branch
from
July 31, 2026 11:36
9ae80bb to
675ac5d
Compare
himeshsiriwardana
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Document the Moesif-powered analytics for both products.
What's in it
Asgardeo (Guides > Monitoring > Insights)
Identity Server (Guides > Analytics > Moesif Analytics)
deployment.tomlconfiguration, and connecting a tenant from the Console.Shared by both
Also updates the analytics section of the Asgardeo data residency reference.
Notes for reviewers