Configuring Integration

Before you set up the integration, make sure that the machine on which the Veeam Service Provider Console Web UI component 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. Note that only InfluxDB v2 or later is supported.

To view the predefined dashboards in Grafana, you must first download JSON files that contain dashboard configuration. To do that:

1. Log in to Veeam Service Provider Console.

For details, see Accessing Veeam Service Provider Console.

2. At the top right corner of the Veeam Service Provider Console window, click Configuration.
3. In the configuration menu on the left, click Plugin Library.
4. Click the Grafana Labs plugin tile. The integration instruction window will open.
5. Under the step 5 of the instruction, click the links to download dashboard configuration files.

Configuring InfluxDB Integration

To configure integration with Grafana using InfluxDB 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 an API token as described in the Create a token section of the InfluxDB documentation.

Configuring Dashboard Containing REST API Metrics

To view Veeam Service Provider Console RESTful APIs Dashboard that visually represents real time statistics of REST API requests sent to a Veeam Service Provider Console server:

1. On the machine on which the Veeam Service Provider Console Web UI component 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 the result looks like the following:

3. Save the changes.
4. 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.

5. Download and install Grafana as described in the Install Grafana on Windows section of Grafana documentation.
6. Access Grafana and add a data source as described in the Getting Started with Grafana and InfluxDB section of Grafana documentation.

7. On the side menu, select Create > Import.
8. In the Import window, click the Upload .json file button and select the grafana-v11-web-dashboard.json file.
9. Click the Import button. The dashboard will automatically open.

Configuring Dashboard Containing Veeam Service Provider Console Server Metrics

To view dashboards that visually represent Veeam Service Provider Console server metrics:

1. On the machine on which the Veeam Service Provider Console Server component is installed, open the configuration.overrides.json file located in the \Veeam\Veeam Availability Console\Configuration\Service folder.
2. In the file, change property values in the GeneratedConfiguration section so that the result looks like the following:

where:

• Service_InfluxDb2_Organization is the name of the organization that you created at step 4 of the Configuring InfluxDB Integration section.
• Service_InfluxDb2_Bucket is the name of the organization bucket that you created at step 5 of the Configuring InfluxDB Integration section.
• Service_InfluxDb2_Token is the API key that you created at step 6 of the Configuring InfluxDB Integration section.

3. Save the changes.
4. Restart the VeeamManagementPortalSvc service.
5. Download and install Grafana as described in the Install Grafana on Windows section of Grafana documentation.
6. Access Grafana and add a data source as described in the Getting Started with Grafana and InfluxDB section of Grafana documentation.
7. On the side menu, select Create > Import.
8. In the Import window, click the Upload .json file button and select one of the JSON files that you downloaded from the Grafana plugin page in Veeam Service Provider Console.
9. Click the Import button. The dashboard will automatically open.
10. Repeat steps 7-9 for each downloaded JSON file.