Configuring Integration

Before you set up the integration, make sure that the machine on which Veeam Service Provider Console Web UI is installed 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.

Configuring Integration for InfluxDB v2.x

To configure integration with Grafana using InfluxDB 2.x database:

  1. Download InfluxDB on the official Download page.
  2. Install InfluxDB as described in the Install InfluxDB section of the InfluxDB documentation.
  3. Configure InfluxDB as described in the Get started with InfluxDB section of the InfluxDB documentation.
  4. Create an InfluxDB organization as described in the Create an organization section of the InfluxDB documentation.
  5. Create an organization bucket as described in the Create a bucket of the InfluxDB documentation.
  6. Create API token as described in the Create a token section of the InfluxDB documentation.
  7. On the machine on which Veeam Service Provider Console Web UI is installed, open the appsettings.json file located in the RestAPI folder of the Veeam Service Provider Console installation directory.
  8. 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,

   "Reporter": "InfluxDb2"

   "InfluxDb2Reporting": {

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

     "Enabled": true,

     "Organization": "<name of an organization that you configured at step 4>",

     "Bucket": "<name of a bucket that you configured at step 5>",

     "Token": "<API token that you created at step 6>"

   }

 },

  1. Save the changes.
  2. Do one of the following:
  • In Task Manager, end the Veeam.AC.WebUI task.
  • In Internet Information Services, recycle the Veeam Service Provider Console Web UI application pool.
  1. Download and install Grafana as described in the Install on Windows section of Grafana documentation.
  2. Access Grafana and add a data source as described in the Getting Started with Grafana section of Grafana documentation.
  3. On the side menu, select Create > Import.
  4. In the Import window, click the Upload .json file button and select the  Veeam VSPC RESTv3 monitoring (InfluxDB) file.
  5. Click the Import button. The dashboard will automatically open.

Configuring Integration for InfluxDB v1.x

Veeam Service Provider Console 8.0 supports accessing InfluxDB using v1.x authentication. If you want to maintain configured integration for previous versions of Veeam Service Provider Console or connect to an already existing InfluxDB v1.x database, do the following:

  1. On the machine on which Veeam Service Provider Console Web UI is installed, open the appsettings.json file located in the RestAPI folder of the Veeam Service Provider Console installation directory.
  2. 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,

   "Reporter": "InfluxDb"

   "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>",

     "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. Follow steps 9-15 of the Configuring Integration for InfluxDB 2.x subsection.