Versions Compared

Version Old Version 12 New Version Current
Changes made by

Vijay

Abirami

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In order to use this feature , we need to use customized Grafana(v7.1.0) uploaded here .

Expand
titleLinux

https://infra.cogdevops.com:8443/repository/docroot/insights_install/installationScripts/latest/RHEL/Custom_Grafana/v7.1.0/Grafana/grafana-v7.1.0.tar.gz

Expand
titleWindows

https://infra.cogdevops.com:8443/repository/docroot/insights_install/installationScripts/latest/windows/Custom_Grafana/v7.1.0/Grafana/grafana-v7.1.0.zip

Info

Note : Please check the grafana configurations before starting the Grafana and modify it if any changes.

Prerequisites:

...

Start the Grafana

Prerequisite : PlatformService >= 8.4 and Grafana > 7.1.0

Info

Note : Please check the Grafana configurations before starting the Grafana and modify it if any changes required.

...

Sample Pdf

PDF
nameSprint score card report.pdf

Prerequisites:

Expand
titleInternet connection to the box is necessary .

  • PlatformService >= 8.4 and > Grafana 7.1.0

  • (Optional) Kindly install grafana-image-renderer plugin before starting Grafana. This can’t be bundled as part of package since this is huge in size.

    • cd grafana/bin

    • grafana-cli plugins install grafana-image-renderer

    • If this step is success, there are less chance of skipping step 3 as it will download the chromium browser necessary for this feature.

  • Except windows and ubuntu please refer to below steps for adding the missing libraries for PDF to be downloaded in printable format

    • Linux

      • In general you can use the ldd utility to figure out what shared libraries are not installed in your system:

        Code Block
        cd <grafana-image-render plugin directory>
ldd chrome-linux/chrome
      linux-vdso.so.1 (0x00007fff1bf65000)
      libdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007f2047945000)
      libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007f2047924000)
      librt.so.1 => /lib/x86_64-linux-gnu/librt.so.1 (0x00007f204791a000)
      libX11.so.6 => not found
      libX11-xcb.so.1 => not found
      libxcb.so.1 => not found
      libXcomposite.so.1 => not found

    • Ubuntu >= 18.10

      • libx11-6 libx11-xcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrender1 libxtst6 libglib2.0-0 libnss3 libcups2 libdbus-1-3 libxss1 libxrandr2 libgtk-3-0 libgtk-3-0 libasound2 libxcb-dri3-0 libgbm1

    • Debian 9

      • libx11 libcairo bcairo2 libcairo2 libxtst6 libxcomposite1 libx11-xcb1 libxcursor1 libxdamage1 libnss3 libcups libcups2 libXss libXss1 libxss1 libxrandr2 libasound2 libatk1.0-0 libatk-bridge2.0-0 libpangocairo-1.0-0 libgtk-3-0 libgbm1

    • Debian 10

      • libxdamage1 libxext6 libxi6 libxtst6 libnss3 libnss3 libcups2 libxss1 libxrandr2 libasound2 libatk1.0-0 libatk-bridge2.0-0 libpangocairo-1.0-0 libpango-1.0-0 libcairo2 libatspi2.0-0 libgtk3.0-cil libgdk3.0-cil libx11-xcb-dev libgbm1

    • CentOS

      • libXcomposite libXdamage libXtst cups libXScrnSaver pango atk adwaita-cursor-theme adwaita-icon-theme at at-spi2-atk at-spi2-core cairo-gobject colord-libs dconf desktop-file-utils ed emacs-filesystem gdk-pixbuf2 glib-networking gnutls gsettings-desktop-schemas gtk-update-icon-cache gtk3 hicolor-icon-theme jasper-libs json-glib libappindicator-gtk3 libdbusmenu libdbusmenu-gtk3 libepoxy liberation-fonts liberation-narrow-fonts liberation-sans-fonts liberation-serif-fonts libgusb libindicator-gtk3 libmodman libproxy libsoup libwayland-cursor libwayland-egl libxkbcommon m4 mailx nettle patch psmisc redhat-lsb-core redhat-lsb-submod-security rest spax time trousers xdg-utils xkeyboard-config alsa-lib

  • Start the Grafana

  • Configure datasource.

    • Name - PDF_ENDPOINT

    • url - http<protocol>://localhost:8080<host>/PlatformService/datasourceexternalApi/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)Make sure that you have “dashboardReportTemplate“ folder in INSIGHTS_HOME, click here to download sample files Click here dashboardReportTemplate.zip

  • Configure work type in table INSIGHTS_WORKFLOW_TYPE - > GRAFANADASHBOARDPDFREPORT.

  • Configure work flow task in INSIGHS_WORKFLOW_TASK table as below

    • Code Block
      languagejson
      {
   "description":"GRAFANA_PDF_Execute",
   "mqChannel":"WORKFLOW.TASK.GRAFANAPDF.EXCECUTION",
   "componentName":"com.cognizant.devops.platformreports.assessment.core.GrafanaPDFExecutionSubscriber",
   "dependency":"0",
   "workflowType":"GRAFANADASHBOARDPDFREPORT"
}

    • Code Block
      languagejson
      {
   "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 .

    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:

  • Dashboard

    • Click the below icon dropdown and choose dashboard .On click you will get a message "PDF sent to your inbox!" .

    • This option will print the entire dashboard as PDF format which cannot be printable if the dashboard is huge .

Info

Mail will be received shortly since it is processed offline.

...

Sample pdf for the above dashboard:

View file
name5.Sprint Score Card.pdf

  • Printable

    • Click the below icon dropdown and choose Printable .On click you will get a message "PDF sent to your inbox!" .

    • This option will print the entire dashboard as PDF format which can be printable .

    • Note: Text panels are not supported in printable . Either remove text panels in dashboard or use Dashboard option

Info

Mail will be received shortly since it is processed offline.

Image Removed

Sample PDF for Printable

...

  • Scheduled dashboard reports with mailing preferences as shown in below screens.

...