Skip to content

Commit

Permalink
Merge branch 'MON-13587-document-centreon-reports' of github.com:cent…
Browse files Browse the repository at this point in the history
…reon/centreon-documentation into MON-13587-document-centreon-reports
  • Loading branch information
cg-tw committed Jul 17, 2024
2 parents 57e939a + c97030d commit 7fa778e
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 1 deletion.
59 changes: 59 additions & 0 deletions cloud/reporting/reports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: reports
title: Centreon Reports Beta
---

Centreon Reports is a reporting solution available as a beta feature for Cloud users. You can create reports from the Centreon interface and view data directly in Grafana. Access to the Grafana instance is handled by Centreon and requires no installation. The resulting report is also ready to use and requires no configuration.

## Creating a report

1. In Centreon, go to **Reporting > Reports** to display the **Report list** page.

2. Click **Create a Report** to display the creation form.

3. Select a **Report template**:
- SLA_Template
- Metric_Template

### Set the report properties

1. In the **Report properties section**, fill in the **Name** field. You can also add a description.

2. Set the **Calculations based on time period**:
- 24x7

3. Set the **Aggregation period**:
- Hourly
- Daily

### Set the report scope

1. In the **Report scope** section, select a type of resource and refine your filter by selecting one or several resources.
2. Select the **Metrics** you want to display (only for the **Metric_Tempalte** template).

> The **Resources preview** displays the resources you have selected. This is not a preview of your report.
3. Once the configuration is done, click **Create**.

> If the **Create** button is not available, this means you have not configured your report correctly.
4. Your report appears in the **Report list** in a new card, with the status **In progress**.

> The report takes a few minutes to generate. If it takes too long, refresh the page.
Your report is now created and available to be displayed.

## Viewing reports in Grafana

1. Go to the **Report list** page that displays all the reports that have been created.

2. Click on the card corresponding to the report you want to display. It opens a new tab and displays your report in the Grafana interface.
> Authentication to Grafana and data processing are managed by the [CCIAM](../ciam/ciam.md#what-is-centreon-ciam).
*[Add a screenshot of a beautiful report in Grafana]*

## Delete a report

You can delete a report from the **Report list** page.

- Click the **trash** button at the bottom left of the card, then confirm the deletion.
12 changes: 11 additions & 1 deletion cloud/sidebarsCloud.js
Original file line number Diff line number Diff line change
Expand Up @@ -504,10 +504,20 @@ module.exports = {
},
{
"type": "category",
"label": "Administration",
"label": "Reporting",
"link": {
"type": "generated-index",
},
"items": [
{
"type": "doc",
"id": "reporting/reports"
}
]
},
{
"type": "category",
"label": "Administration",
"items": [
{
"type": "doc",
Expand Down

0 comments on commit 7fa778e

Please sign in to comment.