Docs Using Kumo.io
Using Kumo.io
Reports
Generate an evidence-backed report on a workspace (inventory, security, compliance, change, cost and more) and download it as PDF, HTML, Markdown, JSON or CSV. Schedule a report to run on a timetable and deliver it by email, Slack, webhook or object storage.
What a Kumo.io report is
A report answers one question about one workspace, from the state Kumo.io holds when it runs. Every report:
- Cites its evidence. Every count and finding links to the evidence behind it, collected in an evidence appendix at the end.
- Says what's missing. If a kind of data isn't available (no cost data yet, for example), the section says so rather than showing zero, and the report lists the gap in its diagnostics.
- Is reproducible. The same workspace state produces the same report.
Open Reports in the sidebar and pick a Workspace. The page has three tabs: Runs, Schedules and Templates.
Kinds of report
The Templates tab describes each kind of report; choose Generate Report on one to start it. The main kinds are:
| Kind | What it covers |
|---|---|
| Environment Summary | A high-level snapshot of your workspace: regions, providers, resource counts, identity and access, security findings, cost and credential health. |
| Inventory | An itemised list of resources with their types, providers and key attributes. |
| Security | Network exposure, security findings, and identity and access. |
| Compliance | An evidence packet with architecture diagrams and compliance findings. |
| Change | What changed between snapshots: added, removed and modified resources. |
| Cost | Actual and estimated spend, allocation and waste. |
| Credential Health | Which provider connections are working, degraded or failing. |
The Report Kind list also offers Workspace Summary, Drift, Source Health, Executive Summary and Custom.
What a report can show depends on your data and plan. A cost section needs cost data, and a change section needs analysed changes. See What does my infrastructure cost? and What changed in my estate?
Generate a report
- On the Runs tab, choose a Report Kind and select Generate Report.
- The run appears under Recent Runs with its status. Select a run to view the report on the page.
- Download it with one of the format buttons: JSON, CSV, MARKDOWN, HTML or PDF. The file is named
kumo-report-<run-id>with the format's extension (.mdfor Markdown).
PDF exports draw diagrams into the document. The other formats link to the diagrams instead.
A report shows only what your role can see. Anything you can't see appears as a redacted placeholder rather than disappearing silently.
Schedule a report
On the Schedules tab, choose a Report kind, set when it runs, and select Schedule:
- Repeats: Daily, Weekly (choose the day under On), Monthly (choose the Day of Month, 1 to 28) or Custom cron (enter a Cron Expression).
- At: the hour it runs.
Kumo.io previews the next three run times. Times are in your browser's time zone, and the schedule runs at those local times.
Choose the Formats to produce, and where to send them under Deliver To. You can change both later with Edit.
| Option | What you enter |
|---|---|
| Generate only (history) | Nothing. Runs appear in the report history. |
| Recipients (comma-separated). | |
| Slack channel | The Channel id. Needs Slack connected to your account. See How do I connect Slack? |
| Webhook | A Webhook id: the name of a webhook destination configured on the installation (see below). |
| Object storage | A Prefix in the installation's object storage. |
If a delivery can't be made (for example, its destination isn't configured), the run is still generated and kept in the history.
Each schedule in the list has Pause (or Resume), Edit and Cancel. Cancelling a schedule stops future runs; past runs stay in the history.
Delivery on a self-hosted installation
- Email uses the installation's email relay. See How do I configure email?
- Webhook ids are defined by
KUMO_REPORT_WEBHOOK_URLS, a JSON object that maps each id to an HTTPS URL, for example{"ops":"https://hooks.example.com/kumo"}. If the value isn't valid JSON, the installation refuses to start, so a typo can't silently stop every delivery. - Object storage delivery needs object storage configured for the installation.
Through the API
Reports, runs, exports and schedules are all in the API, for use with an API token. See the API reference.
Which plans include reports
Reports are part of the Business and Enterprise plans on kumo.io, and of Enterprise (Licensed) on a self-hosted installation. They aren't part of Team or a trial of it. See What does each plan include?
On a plan without them, the Reports screen shows a lock instead, which explains why and opens the plan options.