GithubHelp home page GithubHelp logo

isabella232 / splunk-addon-for-cloud-foundry Goto Github PK

View Code? Open in Web Editor NEW

This project forked from splunk/splunk-addon-for-cloud-foundry

0.0 0.0 0.0 305 KB

Splunk Add-on for Cloud Foundry

License: Apache License 2.0

splunk-addon-for-cloud-foundry's Introduction

Splunk® Add-on for Cloud Foundry®

https://github.com/splunk/splunk-addon-for-cloud-foundry

Splunk Add-on for Cloud Foundry is used to parse, analyze & visualize Cloud Foundry Firehose data which includes metrics from all Cloud Foundry system components, in addition to logs and metrics from all applications. It provides several prebuilt panels targeted for Cloud Foundry operators to help them easily build rich & interactive dashboards and gain operational visibility over their Cloud Foundry deployments.

alt text

Prerequisites

Splunk Add-on for Cloud Foundry is a Supporting Add-on, and as such, it does not contain any inputs. It is used in conjunction with Splunk Firehose Nozzle which collects data from Cloud Foundry Firehose and forwards it to a Splunk deployment.

For BOSH-managed deployment of Splunk Firehose Nozzle, refer to Splunk Firehose Nozzle BOSH release which deploys the nozzle along with a co-located pre-configured Splunk forwarder to forward to one or more Splunk indexers in a reliable, secure & scalable manner.

Installing Splunk Add-on for Cloud Foundry

Splunk Add-on for Cloud Foundry is installed on Splunk search head(s). Download the Add-on from Splunkbase then upload the .spl file either directly via Splunk UI or Splunk CLI in case of a single instance Splunk deployment. For a distributed Splunk deployment, you may want to install it via Splunk deployment server or Splunk search head cluster deployer (in case of a search head cluster), or your favorite 3rd party configuration management tool.

Alternatively, for development purposes, you can clone this repo and copy/symlink it under etc/apps/ directory of your Splunk installation.

Using Splunk Add-on for Cloud Foundry

Sourcetypes

Splunk Add-on for Cloud Foundry expects the following data sourcetypes which are automatically assigned by Splunk Firehose Nozzle to each streaming Firehose event based on its type before forwarding it to Splunk. For detailed descriptions of each Firehose event type and their fields, refer to underlying dropsonde protocol.

Splunk sourcetype Firehose event type Description
cf:error Error An Error event represents an error in the originating process
cf:httpstartstop HttpStartStop An HttpStartStop event represents the whole lifecycle of an HTTP request
cf:logmessage LogMessage A LogMessage contains a "log line" and associated metadata
cf:containermetric ContainerMetric A ContainerMetric records resource usage of an app in a container
cf:counterevent CounterEvent A CounterEvent represents the increment of a counter
cf:valuemetric ValueMetric A ValueMetric indicates the value of a metric at an instant in time

In addition, logs from the nozzle itself are of sourcetype cf:splunknozzle.

Prebuilt Panels

Splunk Add-on for Cloud Foundry provides several prebuilt panels that you can immediately add to your own Cloud Foundry operational dashboards. Refer to Add panels to dashboards in Splunk Docs for more information.

Resources

Splunk Firehose Nozzle

Cloud Foundry Loggregator & Nozzles

Support

This is a community supported Add-on. As such, please post questions in Splunk Answers and reference it. Someone should be with you shortly. Pull requests via github are welcome!

License and Authors

Splunk Add-on for Cloud Foundry is licensed under the Apache License 2.0.

Details can be found in the LICENSE file.

splunk-addon-for-cloud-foundry's People

Contributors

rarsan avatar cholick avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.