Reporting

This doc applies only to the Vulnerability Management engine, released April 20, 2022. Make sure you are using the correct documentation: Which Scanning Engine to Use

Introduction

Use the Vulnerability Reporting interface to schedule asynchronous reports about detected runtime vulnerabilities along with package and image data. You can schedule reports for runtime (container) scanning and/or host scanning.

Here you can:

  • Create a report definition
  • Schedule its frequency
  • Define notification channel(s) in which to receive the reports (email, Slack, or webhook)
  • Preview how the data will appear (optional)
  • Download the resulting reports in .csv, .json, or .ndjson
  • Optionally, generate a manual (unscheduled) report

NOTE: Regardless of the schedule, reports always include the data from the past 24 hours. Therefore, most users schedule a daily report to avoid having any gaps

Past reports are stored for two weeks. Therefore, if you scheduled a weekly report, the list would only contain two records.

Create a Report Definition

For Runtime Workloads

  1. Access: Log in to Sysdig Secure with Advanced User or higher permissions, and select Vulnerabilities > Reporting.

    The Vulnerabilities Reporting list page is displayed. If you have previously created report definitions, you can click one to see the details.

  2. Create: Click Add Report . The New Report page is displayed.

  3. Basic Info: Define the report basic info:

    • Name
    • Description
    • Export file format: .csv, .json, or .ndjson

    Select Definitions:

    • Entity: Runtime Workloads

    • Scope: Entire infrastructure or subset from the drop-down menu

  4. Conditions: (Optional) Add Conditions from the drop-down if you want to filter the items reported on.

    The available conditions include:

    • Image Name * (only for this Entity)
    • OS Name
    • In Use * (only for this Entity)
    • Package Name
    • Package Path
    • Package Type
    • Package Version
    • Vulnerability ID
    • CVSS Score
    • CVSS Vector
    • Vuln Publish Date
    • Exploitable
    • Fix Available
    • Risk Accepted
    • Severity
    • Vuln Fix Date

    Example 1: You want a report of all vulnerabilities with a Severity >= High, and for which a Fix is Available.

    Example 2: You want a report of all vulnerabilities that are In Use with Accepted Risks.

  5. Schedule: Define the Schedule (frequency and time of day) that the report should be run.

    Note: The schedule determines when the report data collection begins. As soon as evaluation is complete, you will receive a notification in the configured notification channels.

  6. Notification Channel: If you have configured them, you can use email, Slack, or webhook notification channels, and they will appear in the drop-down. Since reports are typically large, the actual data is not sent to the notification channel; you receive a link to download it. You must be a valid Sysdig Secure user (Advanced User+) to access the link.

  7. Data Preview: Click Refresh to apply the configuration you’ve chosen and pull up on the center bar of the Data Preview panel to see sample results.

  8. Click Save.

For Runtime Hosts

All of the steps are the same as for Runtime Workload reports, except:

  1. Basic Info: Select Runtime Hosts as the entity.

  2. Conditions: (Optional) Add Conditions from the drop-down if you want to filter the items reported on.

    The available Conditions include:

    • Architecture * (only for this entity)
    • OS Name
    • Package Name
    • Package Path
    • Package Type
    • Package Version
    • CVSS score
    • CVSS vector
    • Vuln Publish Date
    • Exploitable
    • Fix Available
    • Risk Accepted
    • Severity
    • Vuln Fix Date

Manage Reports

View and Edit Report Definition

  1. Select an entry in the Reporting list to see the detail panel.

  2. Click Edit to change the report definition parameters. You can also access this panel from the kebab (3-dot) menu.

  3. Make your edits, click Refresh to see the Data Preview, and Save.

Download Reports

  1. From the Reporting list, the latest report download link appears in the Download column.

  2. To see older reports, select an entry in the Reports list to open the detail panel and select from the report download list.

  3. The report will be downloaded in the format you defined; the file is zipped (.gz) – double-click to unzip and view.

Generate Report Manually

  1. Select an entry in the Reporting list to see the detail panel.
  2. Click Generate Now. A Scheduled entry will appear. Within 15 minutes or so it will change to Completed and you can download the manually generated report.

Duplicate a Report Definition

  1. Choose the kebab (3-dot) menu for a scheduled report.
  2. Click Duplicate.

Report Definition Retention

The scheduled and manually created reports are retained for 14 days.

Delete a Report Definition

Be sure to download any needed reports before deleting the definition.

  1. Choose the kebab (3-dot) menu for a scheduled report.

  2. Click Delete, click Yes when prompted.

    The report definition and all associated reports are deleted.