Reports

Overview of the Reporting section of the console, including report creation, review, download and printing.

All About Spyderbat Reports

Spyderbat provides robust reporting capabilities to help monitor and analyze the operations and security of monitored Linux machines and Kubernetes clusters.

The reporting features are accessible via the "Reports" menu of the portal.

The Reports section contains two submenus:

• Generated: Review and manage reports generated based on your input parameters.

• Create: Create new reports based on a predefined inventory of available report types.

Reports can be customized with a variety of input parameters and exported in multiple formats, including JSON, YAML and PDF. Once generated, reports are stored in the "Generated" section for review, export, and printing.

Creating a Report

To create a report:

1. Navigate to the Reports section of the portal and click on the Create menu item.

2. You will see a list of available report templates that you can select from.

Review the descriptions of the reports, and use the preview button to preview a sample of the report type.

3. Select the desired report type from the list.

4. Each report type has specific input parameters you must provide to customize the report for your environment, and specific UI controls to select them.

Enter or select the required parameters, such as:

• Cluster: The Kubernetes cluster for which the report is generated.

• Start Time and End Time: Defines the reporting period (e.g., last 24 hours or specific time range).

You can give your report a specific name to make it easier to locate it later.

Other report types may have other selectors, such as machine selectors.

5. Click Create to initiate the report generation process.

Reports may take several minutes to generate, depending on the size of the system and the selected time range. The UI will display a popup at the bottom of the page titled 'Creating report,' with a 'View' link that directs you to the 'Generated' section.

Viewing Generated Reports

All created reports will appear immediately in the Generated Reports section. Some reports take a while to process and render, and will not yet be available to view. When they are ready, the 'published' column will change from 'Scheduled' to the time and date when they were published, and a 'View' button will be available to allow the user to view the report.

Select the report you want to access and click on its 'View' button. The report will render in a pop-up, like so:

From here you can

1. Inspect the report: Scroll down to see the full report contents if needed

2. Download Report: Export the report in any of the available formats (e.g., JSON, YAML). By clicking on the 'Download' button in the bottom right corner.

3. Export to PDF and print: Use the print to PDF button to export and/or print the report in PDF format using your browser capabilities and preferred settings.