Configuring Integration

Before you set up the integration, make sure that your Veeam Service Provider Console server meets the Grafana requirements.

To collect data, Grafana requires Veeam Service Provider Console to store information about received API requests in the InfluxDB database. Make sure that the machine on which you install InfluxDB meets the Hardware sizing guidelines.

To use Veeam Service Provider Console dashboard in Grafana, you must first download a JSON file that contains dashboard configuration. To do that:

  1. Log in to Veeam Service Provider Console.

For details, see Accessing Veeam Service Provider Console.

  1. At the top right corner of the Veeam Service Provider Console window, click Configuration.
  2. In the configuration menu on the left, click Plugin Library.
  3. Click the Grafana Labs plugin tile. The integration instruction window will open.
  4. Under step 7 of the instruction, click the Download JSON file link and download the Veeam VSPC RESTv3 monitoring (InfluxDB) dashboard configuration file.

Now you can proceed to configuring integration. To do that:

  1. Download the latest stable version of InfluxDB on the official Download page.
  2. Install InfluxDB as described in the Installing section of the InfluxDB documentation.
  3. Create a database as described in the Creating a database subsection of the InfluxDB documentation.
  4. On the Veeam Service Provider Console server, open the appsettings.json file located in the RestAPI folder of the Veeam Service Provider Console installation directory.
  5. In the file, change property values in the MetricsOptions section so that result looks like the following:

 "MetricsOptions": {

   "DefaultContextLabel": "VAC_REST",

   "Enabled": true,

   "ReportingEnabled": true,

   "InfluxDbReporting": {

     "Url": "http://<IP-address of the server on which InfluxDB is installed>:<TCP port for InfluxDB client-server communication>",

     "Enabled": true,

     "DatabaseName": "<name of a database that you configured at step 3>",

     "Login": "<login that will be used in Grafana for accessing the database>",

     "Password": "<password that will be used in Grafana for accessing the database>"

  1. Save the changes.
  2. End the Veeam.AC.Web.REST process if it is running.
  3. Download and install Grafana as described in the Install on Windows section of Grafana documentation.
  4. Download and install the Pie Chart plugin as described on the plugin page.
  5. Access Grafana and add a data source as described in the Getting Started section of Grafana documentation.
  6. On the side menu, select Create > Import.
  7. In the Import window, click the Upload .json file button and select the  Veeam VSPC RESTv3 monitoring (InfluxDB) file.
  8. Click the Import button. The dashboard will automatically open.
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.