Skip to content

Installation Guide

Prerequisites

  • Grafana OSS version 11.3.0 or higher.
  • Data Sources: Datasources relies on the Marcus Olsson JSON API plugin (version 1.3.6) to connect and retrieve data. All data sources used in this project are based on APIREST (API RESTful services), which interact directly with the back-end systems of the solution.
  • Browser: A modern web browser (e.g., Chrome, Firefox).

Steps

Summarized steps. For a detailed guide, refer to the Official documentation

  1. Install Grafana
  2. Install the Marcus Olsson JSON API plugin.
  3. Start Grafana.

  4. Configure Datasources. Add the following data sources in Configuration > Data Sources:

    • NEATSERVICE API CLOUD PRO RICOH JAPON: Connected to "neatService" backend.
    • GRAPHAPISERVICE API CLOUD PRO RICOH JAPON: Connected to "graphapiservice" backend.
    • ALARM SERVICE GRAPH API CLOUD PRO RICOH JAPON: Connected to "alarmsServiceGraphApi" backend.
    • ALARM SERVICE NEAT API CLOUD PRO RICOH JAPON: Connected to "alarmsServiceNeat" backend.

    These Datasource names are used consistently across the dashboards, but you are free to customize them as needed during the data source configuration process. Ensure that any name changes are reflected correctly in both the Grafana configuration and the imported dashboards for seamless integration.

    Datasource configuration example: It is necessary to include the name, the backend URL, and the X-API-KEY.

    Datasource configuration example

  5. Import the dashboards:

    • Navigate to Dashboards > Import in Grafana.
    • Upload the JSON files located in the /src folder.
    • During the import process, select the appropriate data sources configured in the previous step.

  6. Verify Setup:

    • Open the imported dashboards and ensure data is displayed correctly.