Skip to content

Home

Jump to bottom
Matthew Erbs edited this page Jul 24, 2015 · 2 revisions

#Welcome to the Octopus Deploy app for Splunk wiki!

A Splunk app to stream events from Octopus Deploy to Splunk.

The application is comprised of two main areas, a modular input and a set of dashboard views.

##Modular Input The modular input that allows data to be integrated from an Octopus Deploy instance. This utilises the NodeJS modular input SDK and provides the following source types.

  • Users : octopus:user
  • Tasks : octopus:task
  • Events : octopus:event
  • Deployments : octopus:deployment
  • Releases : octopus:release
  • Environments : octopus:environment
  • Projects : octopus:project
  • Machines : octopus:machine
  • Teams : octopus:team

##Dashboard The dashboard of the app provides four distinct views of the Octopus Deploy data. This makes use of custom visualisation and saved searches. This utilises newer versions of the D3, NVD3 libraries to those packaged with Splunk Enterprise 6.2.

###Overview The overview provides a quick snapshot of what is happening within an Octopus Deploy instance. This includes a view of active projects, average deployment times for releases and a health check of tentacles. At a glance anyone in the organisation can understand what has moved to what environment over recent releases.

###Deployments The deployment view drills into the detail of deployments, highlighting problem projects with failure rates and long deployments. It also illustrates releases that have taken the longest to make their way from lower environments to production.

###Frequency The frequency view allows an organisation view its deployment rate over the last twelve months.

###Audit The audit view allows visibility into the tasks and significant events occuring in the Octopus Deploy instance. This is included (however not limited to) the creation of new accounts, new projects and releases. The authorised promotion of a deployment to an environment and the backups of the Octopus Deploy data.

#Installation/Configuration

You will need an API Key from your Octopus Server.

The app can be installed via the Manage Apps interface. Once deployed the only configuration of the application is via a data input and its related index. The modular input is configured using the host of the Octopus Server and the API key that can be assigned to an authorised user.

#Test Data Test Data files can be found at https://github.com/merbla/splunk-octopusdeploy-app/tree/master/testdata/

###Resources

Clone this wiki locally