octopussamples/grafana repository overview

⁠Octopus Deploy Grafana Datasource

This repo⁠ holds the source code to the Octopus Deploy Grafana datasource plugin.

The plugin connects to the reporting⁠ endpoint at http://octopuserver/api/reporting/deployments/xml⁠ and converts the results to a time series that can be displayed in graphs, or as a table to be displayed in a grafana table.

Other entities such as environments, projects, tenants etc. are also exposed as tables.

⁠Download

The plugin can be downloaded from the GitHub Releases⁠ page.

⁠Building

The following tools are required to build the plugin:

• Go⁠
• Mage⁠
• Nodejs⁠
• Yarn⁠

Build the plugin with:

yarn build
mage -v

⁠Docker

The plugin can be run with the Grafana Docker image with the command:

docker run -e "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=octopus-deploy-xmlfeed" -d -p 3000:3000 -v "$(pwd):/var/lib/grafana/plugins" --name=grafana grafana/grafana:7.0.0

A docker image with the plugin already installed and the GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS setting configured can be found in Docker Hub⁠, and run with the command:

docker run -d -p 3000:3000 --name=grafana octopussamples/grafana:latest

⁠Sample Dashboard

A sample dashboard displaying data returned by this plugin can be found on the Grafana Dashboard Gallery⁠.