# Reporting

Reports are conveniently generated through the [Reporting API](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/reporting) or the UI. You can also schedule automated email delivery or generate them manually. These reports, available in PDF format, mirror the UI with graphs and data.

{% hint style="info" %}
Tags filtering enables a single report to encompass multiple instances
{% endhint %}

## Getting Started

> Various report types correspond to specific Datasentinel features, catering to diverse requirements

You can select the Full Report option to gain a holistic overview of the entire workload.

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2F55Ot25pYAgzkDgvFLZoo%2Ffull_report.pdf?alt=media&token=792fe27d-3fa6-44da-b15b-65eee9cd7249>" %}
Complete Feature Analysis in Full Report
{% endfile %}

Alternatively, you can choose to focus on a single specific feature

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FO3ncdBBzxO4lflP5AFLZ%2Fworkload_sessions_report.pdf?alt=media&token=1ad9397d-2905-4b4f-b58f-e4d84867fad3>" %}
Session History
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FFwcZ5MqVOtHyoeNM0yER%2Ftop_queries_report.pdf?alt=media&token=b2a6f668-5564-4040-b170-eca020d0d37e>" %}
Top Queries
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FpzZMCIWn6alA8fOD1hpq%2Ftable_report.pdf?alt=media&token=a53848b9-f896-430c-b49d-159eabee775f>" %}
Top Tables
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FN2evhuqgKvcxt9twKCPX%2Finstance_report.pdf?alt=media&token=48ef6da3-5a7b-4c23-9dbf-29c3e4c3273b>" %}
PostgreSQL Cluster Metrics
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2Ft7DrafwUGrJxCbomLtNg%2Fserver_report.pdf?alt=media&token=2e3e7082-c71d-4769-88f2-a44fde1c5e7b>" %}
System Metrics
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FQQD5fp1yDSKLJI0FkDR3%2Fdata_size_report.pdf?alt=media&token=adeb5621-7ee0-4b94-b1e1-1b5e33760f03>" %}
Data Size
{% endfile %}

{% file src="<https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FGngvzVNMJWiSX3oHIRWW%2Fquery_report.pdf?alt=media&token=92e15c48-3aa8-4c1c-942c-aeaa50ae5537>" %}
Comprehensive Query Analysis Report
{% endfile %}

It's worth highlighting that during report creation, your existing filters and selected time window remain intact, unless it's a scheduled report. \
This applies similarly to your chosen dimension parameters when applicable.

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

<div align="left"><figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FixXvTXLNE6kFPxeqYBl5%2Freporting.png?alt=media&#x26;token=5a2d6440-2735-4cd4-85be-760203a8bdec" alt=""><figcaption></figcaption></figure></div>

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

<div align="left"><figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FvFfTtUx2BCCVSgarG6La%2Freporting_toolbar.png?alt=media&#x26;token=2412af4d-8423-47a9-90b2-63050028828c" alt=""><figcaption><p>Reporting Icon</p></figcaption></figure></div>

* The report type might be non-modifiable based on the originating screen. For instance, when accessing the session history dashboard, you're restricted to selecting only the session history report type.
* The report can be restricted to a specific database, with the default option being **All databases.**

<figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2Fh1iuezEgc9FAjq7F3a5Y%2Freporting-download.png?alt=media&#x26;token=3339d801-b932-4b66-9b5d-281168674fce" alt=""><figcaption><p>Report Creation</p></figcaption></figure>

## Creating Reporting Choices

### Download Report

Opting to download the report results in its direct generation and download to your PC.

### Email Report

Prior to email report delivery, configuring an [SMTP server](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/smtp) is necessary.

{% hint style="info" %}
You have the ability to customize the email subject and send the report to multiple recipients.
{% endhint %}

<figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FoHbV2eOJmtuSk2uIyvx3%2Freporting-email.png?alt=media&#x26;token=bc59c457-97cd-4a7f-80bf-a9af3fb30abb" alt=""><figcaption><p>Email Reporting Options</p></figcaption></figure>

### Scheduled Email

> If you wish to schedule a report and have it sent via email at consistent intervals, you can opt for this mode.

* 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

<figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2FHQPSb2thNXeOFsHbU1Vw%2Freporting-scheduled.png?alt=media&#x26;token=1c21758b-d382-418a-bfb8-6d1c6c42fa97" alt=""><figcaption><p>Scheduler Options</p></figcaption></figure>

{% hint style="info" %}
The report starts always 3 minutes after the time chosen to ensure you get the latest representative metrics
{% endhint %}

### 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

{% hint style="info" %}
An administrator-level user has the capability to oversee all reports, whereas a user with privileges lower than administrator can solely manage their own reports.
{% endhint %}

<figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2Fcl0YM6LM5AJXDNzVDogv%2Fscheduled-reports.png?alt=media&#x26;token=b3b9acd2-9d8d-4c45-9d09-f111268a663a" alt=""><figcaption><p>Scheduled Reports</p></figcaption></figure>

## Execution History

> You can access the execution history of all your reports, including information about their duration and current status.

<figure><img src="https://1072624949-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlcWi6G1jtNuyGT9C0pkc%2Fuploads%2Fnc2RtbBvPCHDsDFxDmrM%2Fexecution-history.png?alt=media&#x26;token=154b947e-39a5-4a8d-940f-0ba7325dd4fa" alt=""><figcaption><p>Execution History</p></figcaption></figure>
