Skip to main content
  • EN

Greetings, friends! I want to share with you the new Grafana Dashboard for Veeam Backup & Replication, no Enterprise Manager is needed, and it uses 100% VBR API.

Small note: For those familiar with the data protection scene, you might recall that we’ve already got a Grafana Dashboard dedicated to the Veeam Enterprise Manager API since 2020.

 

Grafana Dashboard for Veeam Backup & Replication API

 

When you finish this article, if you follow all the steps, you should have something similar to this. It might be different according to your environment, number of days you select, protected workloads, jobs, etc.

Dashboard – Summary

  • Job Historical Information – The very first graph. The most important one in my opinion. Grouped by 24 hours, get to know the status of your policies per day, on a range in time.
  • Job Historical Information Table – Very similar to the previous panel, but this time with more details about job name, status, date, etc.
  • Job Historical Information Duration – Very similar to previous panels, but this time showing in a bubble way, how much every job has taken to execute. A very cool way to see what jobs are taking the longer, trends, etc.
  • Job Last Result – BIG COLORED PANELS, what everyone I talk about is asking for. Get to know the last status across all jobs, and focus only on the ones are yellow/red.
  • Infrastructure – A few tables that shows some Infrastructure data across the Veeam Backup & Replication. A lot to improve here, but so far the VBR API doesn't give us much more details.
  • Restore Points – More big panels in colors. The more points, the darker the green becomes. This is a list of all your workloads, or the selected workload on top, with the amount of restore points to date.

Topology with all logical components

Very simple way of working, we will use a bash shell script that connects to our Veeam Backup & Replication Servers, using the REST API, and then it will send the metrics to InfluxDB, and visualize them with Grafana. The design would be something similar to this:

 

Download and configure the veeam_backup_and_replication.sh script

We have almost everything ready, we have one last step, the script that will make all this work, we will download the latest version from the Github repository:

You will need jq, so please go ahead and install it first (apt-get install jq, or yum install jq)

This shell script can be downloaded and run from the telegraf server, InfluxDB, or any other Linux. We will have to edit the configuration parameters:

##
# Configurations
##
# Endpoint URL for InfluxDB
veeamInfluxDBURL="http://YOURINFLUXSERVERIP" #Your InfluxDB Server, http://FQDN or https://FQDN if using SSL
veeamInfluxDBPort="8086" #Default Port
veeamInfluxDBBucket="veeam" # InfluxDB bucket name (not ID)
veeamInfluxDBToken="TOKEN" # InfluxDB access token with read/write privileges for the bucket
veeamInfluxDBOrg="ORG NAME" # InfluxDB organisation name (not ID)

# Endpoint URL for login action
veeamJobSessions="1000"
veeamUsername="YOURVBRUSER"
veeamPassword="YOURVBRPASSWORD"
veeamBackupServer="YOURVBRAPIPORT"
veeamBackupPort="9419" #Default Port

Once the changes are done, make the script executable with chmod:

chmod +x veeam_backup_and_replication.sh

The output of the command should be something like the next, without errors:

Writing veeam_vbr_info to InfluxDB
Writing veeam_vbr_sessions to InfluxDB
Writing veeam_vbr_sessions to InfluxDB
Writing veeam_vbr_sessions to InfluxDB
Writing veeam_vbr_sessions to InfluxDB
Writing veeam_vbr_sessions to InfluxDB

If so, please now add this script to your crontab, like for example every 30 minutes:

*/30 * * * * /home/oper/veeam_backup_and_replication.sh >> /var/log/veeam_backup_and_replication.log 2>&1

Grafana Dashboards

I have already spend the time building all the queries, variables etc for you. Just go to Grafana and download it, or use the ID:

Import Grafana Dashboards easily

Knowing the Grafana dashboard ID, we can just import it:18854:

And that’s it. With the menus on the top you can display and adjust the Dashboard to your different choices, like jobs, workloads, etc.:

Please leave your feedback in the comments, or on GitHub.

Replicas should be there, where are you missing them, on what widget/widgets? Cheers

 

Cannot find (for example) on Job Historical Information (job list panel and graphic panel)...and I’ve a lot of replicas on the time interval.

Maybe it’s related to the fact that I’m using veeam 11? (maybe some missing APIs?)

Hello,

Most likely yes, I can see much less types on 1.1 rev0:

https://helpcenter.veeam.com/docs/backup/vbr_rest/reference/vbr-rest-v1-1-rev0.html?ver=120#tag/Sessions/operation/GetAllSessions

Than on current one:

https://helpcenter.veeam.com/docs/backup/vbr_rest/reference/vbr-rest-v1-1-rev2.html?ver=120#tag/Sessions/operation/GetAllSessions

Would totally recommend to upgrading when you have some time.

Thanks!

Last question, I promise….

How can I delete all the data from the influx database?

Need to start from scratch with empty database.

The easyest way without re-creating a database….

 

Many thanks!

Last question, I promise….

How can I delete all the data from the influx database?

Need to start from scratch with empty database.

The easyest way without re-creating a database….

 

Many thanks!

Hello, following these steps: https://docs.influxdata.com/influxdb/cloud/write-data/delete-data/ but pointing to your influxdb server.

Hello

Influxdb and Grafana run on two different Ubuntu servers. Veeam runs on a Windows 2022 server. Telegraf is also installed and running there.

I have started the .sh script on the influxdb Linux server, now I get this error message with it

Writing veeam_vbr_repositories to InfluxDB
Error: failed to write data: 400 Bad Request: unable to parse 'veeam_vbr_repositories,veeamVBR=192.168.0.9,veeamVBRRepoName=Backupserver\ Repository,veeamVBRRepotype=WinLocal,veeamVBRMSDescription=Backup\ auf\ die\ Lokale\ Disk\ G:,veeamVBRRepopath=G:\,veeamVBRRepoPerVM=true veeamVBRRepoMaxtasks=12,veeamVBRRepoCapacity=59994894919270,veeamVBRRepoFree=49574123143168,veeamVBRRepoUsed=16203300995072': invalid tag format
Writing veeam_vbr_repositories to InfluxDB
Writing veeam_vbr_repositories to InfluxDB

Does anyone have any idea what could be causing this?

I am sure ​@jorge.delacruz can help here.

Customers are very happy with their macro view of the backup environment. Grafana is an ally in their day-to-day work

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

 

I’ve just updated to the new grafana json and script, they’ve been updated on the repo on github. Almost everything is ok now except for one job (Malware Detection give an error during the script).

 

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

 

I’ve just updated to the new grafana json and script, they’ve been updated on the repo on github. Almost everything is ok now except for one job (Malware Detection give an error during the script).

 

Me too, and after uploading and checking, that I see this two issues I’ve mentioned:

 

 

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

 

I’ve just updated to the new grafana json and script, they’ve been updated on the repo on github. Almost everything is ok now except for one job (Malware Detection give an error during the script).

 

Me too, and after uploading and checking, that I see this two issues I’ve mentioned:

 

 

You’ve to upgrade Veeam to 12.3.0.310 too

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

 

I’ve just updated to the new grafana json and script, they’ve been updated on the repo on github. Almost everything is ok now except for one job (Malware Detection give an error during the script).

 

Me too, and after uploading and checking, that I see this two issues I’ve mentioned:

 

 

You’ve to upgrade Veeam to 12.3.0.310 too

Oh, yeah, I see.

 

Well, I have it scheduled for after christmas, as now we can’t perform any changes.

 

Thanks,

Hi,

I’m having issues with the dashboard, as the Backup repository - Usage capacity is empy, and the “Backup repositories” shows the same size 2Tb for Capacity,  Used Space and Free Space. 

Any ideas what could be the issue?

 

Thanks

 

I’ve just updated to the new grafana json and script, they’ve been updated on the repo on github. Almost everything is ok now except for one job (Malware Detection give an error during the script).

 

Me too, and after uploading and checking, that I see this two issues I’ve mentioned:

 

 

You’ve to upgrade Veeam to 12.3.0.310 too

Oh, yeah, I see.

 

Well, I have it scheduled for after christmas, as now we can’t perform any changes.

 

Thanks,

You’re welcome! Finally I can help someone 🙂 🙂 :)

Comment


Terms & Conditions