A Splunk add-on for Octopus Deploy
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
TA-Octopus-Idx/default
TA-Octopus-Sh
TA-OctopusNIX-Fwd
TA-OctopusNT-Fwd
CHANGELOG.md
LICENSE
README.md

README.md

Splunk Add-on for Octopus

The Splunk Add-On for Octopus is a technology add-on for retrieving data from a Octopus Deployment installation. This Add-On only provides input related configuration files. Dashboards and reports are build in the app "Octopus for Splunk".

Getting Started

You must have an installed and configured Octopus application to complete the setup process of this app. If you have any questions regarding this app please contact me.

Install Prerequisites

Too make sure everything works correctly make sure the following is available and working:

  1. A working Octopus application
  2. Access to the REST API port on the Octopus server from a Heavy Forwarder or Splunk single instance (port 80 for HTTP and port 443 for HTTP or else if configured differently)
  3. An API key to retrieve data from Octopus. See Octopus Wiki.
  4. A Splunk Heavy Forwarder or Single Instance with Splunk 6.0.x or higher running on Linux or Unix or OS X.

Install instructions

The Splunk Add-On for Octopus contains three apps:

  • TA-Octopus-Idx > Contains index configuration and index-time configurations
  • TA-OctopusNT-Fwd > Contains all the inputs which retrieve the data if you run Splunk on Windows
  • TA-OctopusNIX-Fwd > Contains all the inputs which retrieve the data if you run Splunk on NIX-systems
  • TA-Octopus-Sh > Contains all search-time configurations

Installation of the apps can be done using the Splunk UI as explained below. If you have an index cluster please install TA-Octopus-Idx using the following instructions on Splunk Docs. For search-head cluster please install TA-Octopus-Sh using the following instruction on Splunk Docs.

Install using Splunk UI:

  1. Select "Manage Apps" from the Apps dropdown.
  2. Select the "Install app from file" button.
  3. Select the generated TA-Octopus-<Idx|Fwd|Sh>.spl package.
  4. Splunk will walk you through all required setup.

Data Imported

Data is automatically imported to a custom octopus index once the app is enabled.

The following sourcetypes are available:

  • octopus:machines
  • octopus:projects
  • octopus:releases
  • octopus:deployments
  • octopus:events
  • octopus:environments
  • octopus:users
  • octopus:tasks

ChangeLog

See CHANGELOG for details.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

TODO

  • Convert Add-On to Modular Input
  • Create one Fwd app for both NIX and Windows

Copyright

Copyright (c) 2016 Coen Meerbeek. See LICENSE for details.