snap collector plugin - kubestate

This plugin collects metrics from Kubernetes about the state of pods, nodes and deployments.

It's used in the snap framework.

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples
• Roadmap

3. Contributing
4. License
5. Acknowledgements

Getting Started

System Requirements

• golang 1.5+ (needed only for building)

Operating systems

All OSs currently supported by snap:

• Linux/amd64
• Darwin/amd64

Installation

This plugin monitors Kubernetes so you need a Kubernetes cluster to monitor. A quick way to get a local test cluster installed is to use Minikube.

This plugin is included in the Raintank Docker image for Kubernetes if you want to see an example of how to easily deploy it as pod to Kubernetes.

This plugin and the above Docker image are used to collect metrics for the Grafana Kubernetes App.

Download kubestate plugin binary:

You can get the pre-built binaries at GitHub Releases page.

To build the plugin binary:

Fork https://github.com/grafana/snap-plugin-collector-kubestate Clone repo into $GOPATH/src/github.com/grafana/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-kubestate.git

Build the plugin by running make within the cloned repo:

$ ./build.sh

This builds the plugin binary in /build/

This plugin uses govendor to manage dependencies. If you want to add a dependency, then:

1. Install govendor with: go get -u github.com/kardianos/govendor
2. govendor fetch <dependency path> e.g. govendor fetch k8s.io/client-go/tools/clientcmd/[email protected] The ... means install all sub dependencies.
3. govendor install to update the vendor.json file.
4. Check in the new dependency that will be in the vendor directory.

Configuration and Usage

• Set up the snap framework

• Ensure $SNAP_PATH is exported export SNAP_PATH=$GOPATH/src/github.com/intelsdi-x/snap/build

• If running the task outside of a kubernetes cluster rather than in a pod, then the following two config variables must be set:

  • incluster expects a boolean, default is true.
  • kubeconfigpath expects a string path to the Kubernetes config file, default is empty string.

  Example of how to configure it in a json task manifest:

  "workflow": {
    "collect": {
      "metrics": {
        "/grafanalabs/kubestate/*":{}
      },
      "config": {
        "/grafanalabs/kubestate": {
          "incluster": false,
          "kubeconfigpath": "/home/user/.kube/config"
        }
      },

Documentation

There are a number of other resources you can review to learn to use this plugin:

• The Kubernetes API spec. All the metrics are fetched via the API.

Collected Metrics

This plugin has the ability to gather the following metrics:

Pods

Nodes

Deployments

Examples

Roadmap

1. Disk capacity for the cluster

Contributing

See our recommended process in CONTRIBUTING.md.

License

This plugin is released under the Apache 2.0 License.

Acknowledgements

• Author: @daniellee