Skip to content

docs: add cost report documentation for FinOps use cases#591

Merged
joshrotenberg merged 2 commits intomainfrom
docs/cost-report-guide
Jan 23, 2026
Merged

docs: add cost report documentation for FinOps use cases#591
joshrotenberg merged 2 commits intomainfrom
docs/cost-report-guide

Conversation

@joshrotenberg
Copy link
Copy Markdown
Collaborator

Summary

Adds comprehensive documentation for the redisctl cloud cost-report commands, targeting FinOps teams and finance analysts.

Changes

Command Reference (cloud/commands/cost-report.md)

  • Full documentation of generate and download commands
  • All filter options explained (subscription, database, region, tags, subscription-type)
  • FOCUS format explanation with key column descriptions
  • Practical workflows for monthly reports and team allocation
  • Troubleshooting section

Cookbook Entry (cookbook/cloud/cost-reports.md)

  • Step-by-step guides written for non-technical users
  • JMESPath recipes for JSON analysis:
    • Total cost calculation
    • Top-N expensive resources
    • Filter by region/type
    • Group-by aggregations
  • Automation scripts:
    • Monthly cost report script
    • Team chargeback/allocation script
  • Integration guidance for spreadsheets and FinOps platforms
  • Cron scheduling examples

Why FOCUS + JMESPath?

FOCUS is the FinOps industry standard for billing data. Combined with our JMESPath support, users can do powerful cost analysis directly in the CLI without needing external tools:

# Top 5 most expensive resources
redisctl cloud cost-report download $ID --format json \
  -q 'sort_by(@, &BilledCost) | reverse(@) | [:5].{name: ResourceName, cost: BilledCost}'

Closes #588

Adds comprehensive documentation for the cost-report command:

- Command reference page (cloud/commands/cost-report.md):
  - Generate and download commands with all options
  - FOCUS format explanation with key columns
  - Practical workflows for monthly reports and team allocation
  - Troubleshooting section

- Cookbook entry (cookbook/cloud/cost-reports.md):
  - Step-by-step guides for non-technical users
  - JMESPath recipes for JSON analysis (sum, filter, top-N, group-by)
  - Automation scripts for monthly reports and team chargeback
  - Integration guidance for spreadsheets and FinOps tools

Closes #588
…ples

- Fix response.resourceId -> response.resource.costReportId
- Add working group_by + items pattern for aggregations
- Add examples for aggregating by ResourceName, RegionName, ChargeCategory
- Update all scripts with correct path
@joshrotenberg joshrotenberg merged commit a0393ff into main Jan 23, 2026
22 checks passed
@joshrotenberg joshrotenberg deleted the docs/cost-report-guide branch January 23, 2026 22:27
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.

Add cost report documentation for FinOps use cases

1 participant