Reports
Last updated
Was this helpful?
Last updated
Was this helpful?
Reports provide insights into the data you have synced from various cloud services into CloudQuery destination. Use the reports to get a comprehensive view of your cloud resources, security posture, compliance status, and optimization opportunities across multiple dimensions.
Reports are defined as code. You can create your own reports from scratch or customize one of the pre-built report templates.
Open the reports from the main navigation on the left. If you have not created any reports yet, you'll have an option to use a template or build a new report from scratch.
Choosing the Use a template will provide you with a wide selection of report templates.
You can search by integration name or a report category. For example, to find all reports that use the AWS integration, just type 'aws' in the search box.
Select the report report template to see a preview of the report. Click Save to apply the changes and finish your first report.
See the Built-in Report Templates for details about the individual reports you can build with just a few clicks.
From the reports page, click the New Report button and select Build from scratch. A report editor will open with the report code on the right and the report preview on the left.
Edit the yaml code to specify the widget type (on line 14):
Click Preview Changes on top to see the first widget updated to a pie chart.
Add a new widget following an example in the code or see Reports Yaml Documentation with Examples for details and examples on how to build new reports and their widgets.
Reports have a standardized layout. You will find the applicable filters on the top right. Below, you will see a button that shows what integrations are required or recommended to sync with to benefit from the report.
The layout of the widgets is automated and cannot be changed.
Each visualization has a dropdown menu in its header bar providing the ability to open the underlying SQL query in the SQL console or copying the SQL query to clipboard. Use this feature to explore the data and get more details.
Table visualizations additionally provide an individual search feature and a full screen view.
If you do not see any data in the report, first check the Tips for using this report in the top right section of the report. The popup will list the integrations the report requires or recommends to use. Make sure a sync is set up for the recommended integrations.
If only some widgets do not show any data, it may be that there is nothing to show or the data is not being synced. Open the widget query in the SQL Console using the widget's dropdown menu and check what tables are used. Make sure your integration has these table selected for the sync.
If you don't see any widgets in the report, it's likely the report YAML is not structured properly. Make sure the spacing is correct. Try removing individual widgets to see which one may be causing the issues.
Some reports may need to process a large amount of data. This is primarily critical for reports using data from CloudTrail. To improve the performance of these reports, try limiting the sync for CloudTrail events to a shorter time frame or only for events used in the reports by specifying Table Options on the AWS integration.
