Skip to main content

Generating and Obtaining Reports

You can use Key Manager to obtain summary reports about the managed environment, such as statistics about the cryptographic qualities of user keys, and information about policy violations. Key Manager can be configured to automatically email reports to specified recipients.

Reports are configured on the Reports→Configure reports page.

note

To obtain reports via email, Key Manager email-server settings must be correctly configured.

Email-server settings are configured on the Settings→General→E-mail server page. For more information about the relevant settings, see Email-Server Settings.

Updating Report Data​

Information that goes into reports is updated automatically in accordance to the global setting How often to calculate reporting data (reporting_data_interval). By default, report data is updated once per day. For more information about the setting, see Global Settings.

You can manually update report data in any of the following ways:

  • Via the GUI, navigate to the Reports→View reports page, then click Refresh reporting data.

  • Via the command-line client: Run the following command

    $ ssh-mgr-client calculate-reporting-data

  • Via the API, issue a request to the following API endpoint:

    POST /api/v3/reporting-data/calculate/

Generating PDF Reports​

To generate a PDF report, navigate to the Reports→View reports page, then click Download on the target report entry.

note

When you click Download, the latest report data is used to generate the PDF, not the current state of the managed environment. For more information about updating report data, see Updating Report Data.

Report Types​

The following types of reports are available in Key Manager:

Report typeDescription
Managed-environment reportProvide statistical information about the user keys in the managed environment.
Policy reportProvide statistical information and trends about policy violations related to selected policies. Policy reports can also be configured to provide statistical information about the user keys in the managed environment.
Application reportSummary of policy violations within the selected applications.
Application owner reportSummary of policy violations within the selected applications, intended for application owners.