Reporting¶

The reporting feature allows you to define different types of activity reports for analysis purposes

These reports can be generated directly with the Reporting API or from the UI

They can also be sent directly by email from Datasentinel or scheduled at regular intervals

Reports are generated as a PDF file and include graphs and data just like on the UI

Note

A report can contain multiple instances

Warning

Before sending reports by email, you need to configure a smtp server (See SMTP settings)

There are different report types depending on your needs

Session history report PDF
Top queries report PDF
Table report PDF
Instance report PDF
Server report PDF
Data size report PDF
Full report (includes all previous reports) PDF
Detailed report of a query PDF

Note

It is important to note that when creating a report, your current filters and the chosen time window are preserved (except for scheduled reports)

as well as your chosen dimension parameters when available.

1. Getting started¶

Reports are accessible through this icon on the top right on most of screens

You can also go directly to the reporting feature by clicking on the icon

The type of report may not be modifiable depending on the screen from which you come

For example, from the session history dashboard, you can only select a sessions history report type.
You can limit the report to a selected database.(All by default)

Note

The type of report can be chosen on the general screen of the reporting feature or from the PostgreSQL instance metrics visualization screen.

1. Download report¶

If you choose to download the report, it will be generated and downloaded directly to your PC.

2. Email report¶

You can choose to generate and send the report by email.

The email subject is customisable and you can send the report to multiple recipients.

3. Scheduled email¶

You can select this mode if you want to schedule a report and send it by email at regular intervals.

Choose the day and the hour you want the report to be executed

The frequency can be daily or weekly.

The activity time range corresponds to the time window chosen when the report starts

Note

The report starts always 3 minutes after the time chosen to ensure you get the latest representative metrics

4. Scheduled email management¶

You can manage scheduled reports directly from the UI in the reporting section.

Change report properties

Delete a report

View of the execution history by clicking on the desired report

Note

A user with admin privilege can manage all reports

A user with a privilege other than admin can only manage his reports

5. Execution History¶

View execution history of all your reports, the duration and status