Skip to content

DOCS-128: add Usage Reports page and CLI get-analytics-data reference#260

Open
harrison-akeyless wants to merge 12 commits into
v1.0from
v1.0_DOCS-128-usage-reports
Open

DOCS-128: add Usage Reports page and CLI get-analytics-data reference#260
harrison-akeyless wants to merge 12 commits into
v1.0from
v1.0_DOCS-128-usage-reports

Conversation

@harrison-akeyless
Copy link
Copy Markdown
Collaborator

@harrison-akeyless harrison-akeyless commented May 21, 2026

Summary

  • add a new Usage Reports documentation page under Advanced Functionality
  • include web console and CLI workflows for usage reports
  • add CLI filtering and export examples
  • add get-analytics-data command section to CLI Reference for anchor linking
  • update Advanced Functionality navigation order to include Usage Reports

Summary by CodeRabbit

Documentation

  • Added comprehensive Usage Reports documentation covering access methods via Web Console and CLI, report exports, key metrics, filtering options, RBAC requirements, Event Center integration, and specialized reports
  • Added get-analytics-data CLI command documentation with output fields and usage guidance

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Warning

Review limit reached

@harrison-akeyless, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 12 minutes and 34 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e1bd7926-982a-4f6b-a218-719b9074a63d

📥 Commits

Reviewing files that changed from the base of the PR and between 6855a69 and 09b2f3b.

📒 Files selected for processing (2)
  • docs/Advanced Functionality/usage-reports.md
  • docs/Integrations & Plugins/cli-reference/index.md
📝 Walkthrough

Walkthrough

This PR introduces complete documentation for Akeyless Usage Reports, including navigation updates, a comprehensive feature guide covering data access and configuration, and CLI command reference documentation for the new get-analytics-data command used to retrieve usage analytics.

Changes

Usage Reports Feature Documentation

Layer / File(s) Summary
Navigation and feature metadata
docs/Advanced Functionality/_order.yaml, docs/Advanced Functionality/usage-reports.md
Adds usage-reports to the documentation navigation order and establishes front matter metadata (title, excerpt, visibility) for the new Usage Reports documentation page.
Usage Reports comprehensive guide
docs/Advanced Functionality/usage-reports.md
Documents the complete Usage Reports feature: data scope and retention window, access methods via Web Console and CLI (get-analytics-data command with JSON output examples), JSON export procedures, key metrics with CLI/JQ filtering examples, RBAC requirements for access control, Event Center integration for threshold-based notifications, specialized organizational and password manager reports, troubleshooting guidance for common issues, and links to related features.
CLI command reference
docs/Integrations & Plugins/cli-reference/index.md
Adds reference documentation for the get-analytics-data CLI command, describing its output fields (date_updated, analytics_data, usage_reports, clients_usage_reports) and noting standard profile and output flag usage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • akeylesslabs/technical-documentation#277: Expands CLI reference documentation with additional command documentation including analytics-related changes, directly related to the get-analytics-data CLI reference section in this PR.

Suggested reviewers

  • EldadH89
  • Avi-Akeyless

Poem

🐰 A rabbit hops through docs with glee,
Usage reports now flow so free,
Analytics data, metrics bright,
CLI commands set things right!
The feature guide, complete and clear,
Makes all the data crystalizing here!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly reflects the main changes: adding a Usage Reports documentation page and a CLI get-analytics-data command reference. It is concise, specific, and accurately summarizes the primary objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_DOCS-128-usage-reports

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless changed the title docs: add Usage Reports page and CLI get-analytics-data reference DOCS-128: add Usage Reports page and CLI get-analytics-data reference May 21, 2026
coderabbitai[bot]

This comment was marked as outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants