In order to use this feature , we need to use customized Grafana(v7.1.0) uploaded here .
...
| Info |
|---|
Note : Please check the grafana configurations before starting the Grafana and modify it if any changes. |
...
Prerequisites:
Start the Grafana
configure datasource.
Name - PDF_ENDPOINT
url - http://localhost:8080/PlatformService/datasource/exportPDF/getDashboardAsPDF(Note: if App is configured with domain name use that to configure)
No Auth is required. Click on Save and Test.
Make sure you have workflow and report jar are running to receive mails.
Configure your mail id in Grafana → Preference → email. ( For this you need admin permission)
Configure work type in INSIGHTS_WORKFLOW_TYPE - > GRAFANADASHBOARDPDFREPORT.
Configure work flow task in INSIGHS_WORKFLOW_TASK as below
Code Block language json { "description":"GRAFANA_PDF_Execute", "mqChannel":"WORKFLOW.TASK.GRAFANAPDF.EXCECUTION", "componentName":"com.cognizant.devops.platformreports.assessment.core.GrafanaPDFExecutionSubscriber", "dependency":"0", "workflowType":"GRAFANADASHBOARDPDFREPORT" }Code Block language json { "description":"Grafana Email_Exeute", "mqChannel":"WORKFLOW.TASK.EMAIL.EXCECUTION", "componentName":"com.cognizant.devops.platformreports.assessment.core.ReportEmailSubscriber", "dependency":"1", "workflowType":"GRAFANADASHBOARDPDFREPORT" }
...
Check your smtp configurations in server-config.json .
For more details on SMTP config, please see here Server-Config.json Components
Give grafana admin user and password in “userId”: <GrafanaAdminUser>, and “password”:<Grafanaadminpassword>
Start the Grafana using below commands or configure service with respect to OS.
Windows - .\bin\windows-amd64\grafana-server --homepath=.
Linux - .\bin\linux-amd64\grafana-server --homepath=.
...
Usage:
Grafana PDF Download Options:
...
| View file | ||
|---|---|---|
|
...
UI for creating and scheduling customized reports:
From the menu select Dashboard Report Download:
Configuring Report
Click the plus icon and select the Organization and dashboard you want to create a report.
PdfType has 2 options
Dashboard View - Provides snapshot of entire dashboard as PDF.
Printable View - Provides PDF with panels arranged in A4 format that can be used for printing the PDF.
Once Dashboard is selected and if it has template variables configured it will list you the variables for selection as below.
Now select the required filters such as Portfolio, Product, Team.
Select the Frequency based on below requirements
ONETIME - Only for this frequency Absolute time range can be chosen in the next dropdown
DAILY, WEEKLY, MONTHLY, YEARLY - Both Relative and Other time range will work.
Once Everything is selected , user can click on Preview dashboard and see how the report will be received based the selected filters and time range as below. This popup is non-interactable.
If the Preview is as per the need , click ok which will enable Save button. File the necessary information in mailing details and save the report.
