CloudCheckr Custom Report Builder allows you to build specific searches and filter parameters for EC2, S3 and WorkSpaces resources. Instead of having to recreate the search and filter parameters, you can save these and reload them later. The parameters of your Custom Reports are saved and a new custom report will be built each day with the most up-to-date data from your AWS Deployment.
To create a Custom Report, first choose an AWS Service using the Report type dropdown. CloudCheckr will populate the report options based on this selection. The Filters, Columns, and Sort By options will all change depending on the AWS Service.
Name your report in Report Name field. A name must be given to the report before it can be saved.
First, choose your Filter options for the report by clicking on the ‘Plus’ symbol (+). You’ll be presented with a pop-up box with three sections.
The first is the Filter Type. This is where you will choose the type of data used to filter your report. EC2 Custom Report, for example, has 26 different filter options including Instance Status, Size, Cost, Age, Tag, VPC, and CPU Utilization.
The second option is how to filter the data based on that selection. These options vary by the filter type. You can choose:
- is equal to – this finds exact matches. Example: Instance Status is equal to Running to find all of your Running EC2 instances.
- is not equal to – this finds everything except this exact match. Example: Region is not equal to EU (Ireland) to find all resources not in that region.
- contains – finds resources that contain your selection. This includes partial matches. Example: Tag contains Product, to find all resources tagged with Key = Product.
- does not contain – finds resources that do not contain your selection. This includes partial matches. Example: Availability Zone does not contain 1c, to find all resources in the other Availability Zones.
- is greater than – finds resources with values higher than the selection. Example: Cost is greater than $500, to find all resources that cost more than $500.
- is less than – finds resources with values lower than the selection. Example, CPU Utilization is less than 25%, to find all resources whose CPU Utilization is lower than 25%.
The third option is a text box where you will enter the details of what you would like to filter on. Many of the filter types provide suggestions as you type (see screenshot above showing Availability Zone suggestions). If you are choosing to filter on something that ‘is equal to’, for example, your report will return anything that is an exact match with whatever you enter in this text box. If you are choosing ‘contains‘ you can enter as many or as few characters as you’d like. ‘Less than‘ and ‘greater than‘ require a number.
Once you are satisfied with your selections, click the Apply button to apply your filter to the custom report. You can add additional filter options by clicking on the ‘Plus’ symbol (+) next to Filters again.
MATCH ALL FILTERS
When setting up multiple filters within your Custom Report you have the option to match all filters, or match any filters. Match all filters (which is enabled by default) will only return results that match every filter option you have selected. If Match all filters is not checked, the report will contain results that contain any filter option selected.
For example, we have one running Windows EC2 instance and I use the following two filter options:
- Instance Status is equal to Stopped
- Instance Platform is equal to Windows
Match all filters
- checked – Will NOT return this EC2 instance because it does not match the “Instance Status is equal to Stopped” filter.
- not checked – Will return this EC2 instance because it matches one of the criteria: Instance Platform is equal to Windows.
This allows you to choose which columns will display in the Custom Report. Open the column options by clicking on the ‘Plus’ symbol (+). You’ll be presented with a pop-up box a list of columns. Simply check the columns you would like to display and click Apply.
NOTE: The data from all columns will also be available within the details of the resources when viewing the custom report. If you do not select Platform, for example, the platform will not show as a column in the report but you can see the platform of the resource when looking at its details within the report.
RESULTS TO SHOW & SORT BY
You can sort the results from your Custom Report by any of the available column options and further sort by Ascending or Descending order.
- Sort By: You can also choose to sort on something that you did not select when choosing your columns. However, a column will be created for your Sort By selection in this scenario.
- Results to Show: This will allow you to dictate how many results you would like in your report. For example you can focus on ‘Top 25’ or ‘Top 100’. Just enter the number of results you would like to view in the text box. The results the report returns will be dependent on your Sort By selection.
NOTE: If you leave Results to Show empty, the report will return ALL matching results.
SAVING CUSTOM REPORTS
Once you have your Filters, Columns, and Sort By selections made, you can save your custom report. Click the Save Filter button on the bottom of the builder to save your report. Once the report is saved you will see a notification at the top of the page.
As reminder to save the report you must have entered Report Name, if this is blank you will receive an error.
VIEWING CUSTOM REPORTS
You can view your saved custom reports at any time by opening the Custom Reports menu and clicking on the AWS service of the report you want to view and select the your report.
EDITING CUSTOM REPORTS
If, for any reason, you need to make a modification to your custom report, you can easily do so.
First, load the report you want to modify. Then, make your desired changes by updating the Filters, Columns, or Sort By options and click the Filter button.
The report will reload, updating the results according to your changes. If you are satisfied with these results you can click the Update Current Filter button. This will overwrite the parameters of your Custom Report.
Alternatively, you can save these parameters as an entirely new Custom Report by clicking on the Save To Custom Reports button. Give your new report a name and save.
DELETING CUSTOM REPORTS
If you would like to delete one of your saved custom reports, load the report you want to delete. Then, simply click the Delete Filter button. You will get a popup asking you to confirm your delete request. Click Delete. Your report has now been removed from your list of saved custom reports.
NOTE: This action cannot be reversed.
Here are some example uses cases for Custom Reports showing how to use the filter options to obtain targeted results.
Report to locate all running Windows instances that cost more than $100 per month in US West (Oregon) which have averaged less than 50% CPU Utilization over the past 90 days.
- Status is Equal To Running
- Platform is Equal To Windows
- Instance Cost is Greater Than 100
- Region is Equal To US West (Oregon)
- 90 Day Avg CPU is Less Than 50
Report to show all S3 buckets that have more than 1 million objects, that are not located in the US.
- Objects is Greater Than 1000000000
- Region Does Not Contain US
Report to show non-Linux m1.xlarge Reserved Instances running in Availability Zone us-east-1b.
- Pricing Type is Equal To Reserved
- Platform is not Equal to Linux
- Type (Size) is Equal to m1.xlarge
- Availability Zone is Equal to us-east-1b
Report to show all instances within a specific VPC that cost less than $200 and whose CPU never spiked above 50%.
- VPC is Equal To [enter the name of your VPC]
- Cost is Less Than 200
- Peak Utilization is Less Than 50