README
¶
Heapster
Heapster enables Container Cluster Monitoring and Performance Analysis.
Heapster currently supports Kubernetes and CoreOS natively. It can be extended to support other cluster management solutions easily. Heapster collects and interprets various signals like compute resource usage, lifecycle events, etc, and exports cluster metrics via REST endpoints. Note: Some of the endpoints are only valid in Kubernetes clusters
Use Kubedash to visualize data exported by Heapster.
Heapster supports multiple sources of data. More information here.
Heapster supports a pluggable storage backend. It supports InfluxDB with Grafana, Google Cloud Monitoring, Google Cloud Logging and Hawkular. We welcome patches that add additional storage backends. Documentation on storage sinks here The current version of Storage Schema is documented here.
Running Heapster on Kubernetes
To run Heapster on a Kubernetes cluster with,
- InfluxDB use this guide.
- Google Cloud Monitoring and Google Cloud Logging use this guide.
Running Heapster on OpenShift
Using Heapster to monitor an OpenShift cluster requires some additional changes to the Kubernetes instructions to allow communication between the Heapster instance and OpenShift's secured endpoints. To run a combination of Heapster and Hawkular-Metrics, follow this guide.
Running Heapster on CoreOS
Heapster communicates with the local fleet server to get cluster information. It expected cAdvisor to be running on all the nodes. Refer to this guide.
Running in other cluster management systems.
Heapster can be used to enable cluster-wide monitoring on other cluster management solutions by running a simple cluster-specific buddy container that will help Heapster with discovery of hosts.
Running in standalone mode.
It is also possible to run Heapster standalone on a host with cAdvisor using this guide.
Troubleshooting guide here
Community
Contributions, questions, and comments are all welcomed and encouraged! Heapster and cAdvisor developers hang out in the #google-containers room on freenode.net. You can also reach us on the google-containers Google Groups mailing list.
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/bitbucket.org/ww/goautoneg
HTTP Content-Type Autonegotiation.
|
HTTP Content-Type Autonegotiation. |
|
_workspace/src/github.com/beorn7/perks/quantile
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds.
|
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds. |
|
_workspace/src/github.com/bigdatadev/goryman
A Riemann client for Go, featuring concurrency, sending events and state updates, queries, and feature parity with the reference implementation written in Ruby.
|
A Riemann client for Go, featuring concurrency, sending events and state updates, queries, and feature parity with the reference implementation written in Ruby. |
|
_workspace/src/github.com/boltdb/bolt
Package bolt implements a low-level key/value store in pure Go.
|
Package bolt implements a low-level key/value store in pure Go. |
|
_workspace/src/github.com/davecgh/go-spew/spew
Package spew implements a deep pretty printer for Go data structures to aid in debugging.
|
Package spew implements a deep pretty printer for Go data structures to aid in debugging. |
|
_workspace/src/github.com/docker/go-units
Package units provides helper function to parse and print size and time units in human-readable format.
|
Package units provides helper function to parse and print size and time units in human-readable format. |
|
_workspace/src/github.com/emicklei/go-restful
Package restful, a lean package for creating REST-style WebServices without magic.
|
Package restful, a lean package for creating REST-style WebServices without magic. |
|
_workspace/src/github.com/emicklei/go-restful/swagger
Package swagger implements the structures of the Swagger https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
|
Package swagger implements the structures of the Swagger https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md |
|
_workspace/src/github.com/gogo/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/github.com/golang/glog
Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.
|
Package glog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup. |
|
_workspace/src/github.com/golang/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/github.com/golang/snappy
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
|
_workspace/src/github.com/google/gofuzz
Package fuzz is a library for populating go objects with random values.
|
Package fuzz is a library for populating go objects with random values. |
|
_workspace/src/github.com/hashicorp/go-msgpack/codec
High Performance, Feature-Rich Idiomatic Go encoding library for msgpack and binc .
|
High Performance, Feature-Rich Idiomatic Go encoding library for msgpack and binc . |
|
_workspace/src/github.com/imdario/mergo
Package mergo merges same-type structs and maps by setting default values in zero-value fields.
|
Package mergo merges same-type structs and maps by setting default values in zero-value fields. |
|
_workspace/src/github.com/influxdb/influxdb/influxql
Package influxql implements a parser for the InfluxDB query language.
|
Package influxql implements a parser for the InfluxDB query language. |
|
_workspace/src/github.com/influxdb/influxdb/meta/internal
Package internal is a generated protocol buffer package.
|
Package internal is a generated protocol buffer package. |
|
_workspace/src/github.com/influxdb/influxdb/tsdb
Package tsdb implements a durable time series database.
|
Package tsdb implements a durable time series database. |
|
_workspace/src/github.com/influxdb/influxdb/tsdb/internal
Package internal is a generated protocol buffer package.
|
Package internal is a generated protocol buffer package. |
|
_workspace/src/github.com/juju/ratelimit
The ratelimit package provides an efficient token bucket implementation that can be used to limit the rate of arbitrary things.
|
The ratelimit package provides an efficient token bucket implementation that can be used to limit the rate of arbitrary things. |
|
_workspace/src/github.com/matttproud/golang_protobuf_extensions/pbutil
Package pbutil provides record length-delimited Protocol Buffer streaming.
|
Package pbutil provides record length-delimited Protocol Buffer streaming. |
|
_workspace/src/github.com/optiopay/kafka
Package kafka a provides high level client API for Apache Kafka.
|
Package kafka a provides high level client API for Apache Kafka. |
|
_workspace/src/github.com/optiopay/kafka/proto
Package proto provides kafka binary protocol implementation.
|
Package proto provides kafka binary protocol implementation. |
|
_workspace/src/github.com/pborman/uuid
The uuid package generates and inspects UUIDs.
|
The uuid package generates and inspects UUIDs. |
|
_workspace/src/github.com/prometheus/client_golang/model
Package model contains core representation of Prometheus client primitives.
|
Package model contains core representation of Prometheus client primitives. |
|
_workspace/src/github.com/prometheus/client_golang/prometheus
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface.
|
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface. |
|
_workspace/src/github.com/prometheus/client_golang/text
Package text contains helper functions to parse and create text-based exchange formats.
|
Package text contains helper functions to parse and create text-based exchange formats. |
|
_workspace/src/github.com/prometheus/client_model/go
Package io_prometheus_client is a generated protocol buffer package.
|
Package io_prometheus_client is a generated protocol buffer package. |
|
_workspace/src/github.com/prometheus/procfs
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.
|
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc. |
|
_workspace/src/github.com/spf13/pflag
Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
|
Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags. |
|
_workspace/src/github.com/stretchr/testify/assert
A set of comprehensive testing tools for use with the normal Go testing system.
|
A set of comprehensive testing tools for use with the normal Go testing system. |
|
_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
|
Alternative testing tools which stop test execution if test failed. |
|
_workspace/src/github.com/ugorji/go/codec
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json.
|
High Performance, Feature-Rich Idiomatic Go codec/encoding library for binc, msgpack, cbor, json. |
|
_workspace/src/golang.org/x/crypto/bcrypt
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.
|
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm. |
|
_workspace/src/golang.org/x/crypto/blowfish
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
|
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm. |
|
_workspace/src/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/golang.org/x/net/context/ctxhttp
Package ctxhttp provides helper functions for performing context-aware HTTP requests.
|
Package ctxhttp provides helper functions for performing context-aware HTTP requests. |
|
_workspace/src/golang.org/x/oauth2
Package oauth2 provides support for making OAuth2 authorized and authenticated HTTP requests.
|
Package oauth2 provides support for making OAuth2 authorized and authenticated HTTP requests. |
|
_workspace/src/golang.org/x/oauth2/google
Package google provides support for making OAuth2 authorized and authenticated HTTP requests to Google APIs.
|
Package google provides support for making OAuth2 authorized and authenticated HTTP requests to Google APIs. |
|
_workspace/src/golang.org/x/oauth2/internal
Package internal contains support packages for oauth2 package.
|
Package internal contains support packages for oauth2 package. |
|
_workspace/src/golang.org/x/oauth2/jws
Package jws provides encoding and decoding utilities for signed JWS messages.
|
Package jws provides encoding and decoding utilities for signed JWS messages. |
|
_workspace/src/golang.org/x/oauth2/jwt
Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly known as "two-legged OAuth 2.0".
|
Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly known as "two-legged OAuth 2.0". |
|
_workspace/src/google.golang.org/api/cloudmonitoring/v2beta2
Package cloudmonitoring provides access to the Cloud Monitoring API.
|
Package cloudmonitoring provides access to the Cloud Monitoring API. |
|
_workspace/src/google.golang.org/api/gensupport
Package gensupport is an internal implementation detail used by code generated by the google-api-go-generator tool.
|
Package gensupport is an internal implementation detail used by code generated by the google-api-go-generator tool. |
|
_workspace/src/google.golang.org/api/googleapi
Package googleapi contains the common code shared by all Google API libraries.
|
Package googleapi contains the common code shared by all Google API libraries. |
|
_workspace/src/google.golang.org/api/googleapi/internal/uritemplates
Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).
|
Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570). |
|
_workspace/src/google.golang.org/api/logging/v2beta1
Package logging provides access to the Google Cloud Logging API.
|
Package logging provides access to the Google Cloud Logging API. |
|
_workspace/src/google.golang.org/appengine
Package appengine provides basic functionality for Google App Engine.
|
Package appengine provides basic functionality for Google App Engine. |
|
_workspace/src/google.golang.org/appengine/internal
Package internal provides support for package appengine.
|
Package internal provides support for package appengine. |
|
_workspace/src/google.golang.org/appengine/internal/app_identity
Package app_identity is a generated protocol buffer package.
|
Package app_identity is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/appengine/internal/base
Package base is a generated protocol buffer package.
|
Package base is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/appengine/internal/datastore
Package datastore is a generated protocol buffer package.
|
Package datastore is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/appengine/internal/log
Package log is a generated protocol buffer package.
|
Package log is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/appengine/internal/modules
Package modules is a generated protocol buffer package.
|
Package modules is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/appengine/internal/remote_api
Package remote_api is a generated protocol buffer package.
|
Package remote_api is a generated protocol buffer package. |
|
_workspace/src/google.golang.org/cloud/compute/metadata
Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts.
|
Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts. |
|
_workspace/src/google.golang.org/cloud/internal
Package internal provides support for the cloud packages.
|
Package internal provides support for the cloud packages. |
|
_workspace/src/gopkg.in/v2/yaml
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
|
_workspace/src/k8s.io/kubernetes/pkg/api
Package api contains the latest (or "internal") version of the Kubernetes API objects.
|
Package api contains the latest (or "internal") version of the Kubernetes API objects. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/errors
Package errors provides detailed error types for api field validation.
|
Package errors provides detailed error types for api field validation. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/install
Package install installs the v1 monolithic api, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the v1 monolithic api, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/meta
Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API
|
Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API |
|
_workspace/src/k8s.io/kubernetes/pkg/api/unversioned
Package unversioned contains API types that are common to all versions.
|
Package unversioned contains API types that are common to all versions. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/util
TODO: This GetVersion/GetGroup arrangement is temporary and will be replaced with a GroupAndVersion type.
|
TODO: This GetVersion/GetGroup arrangement is temporary and will be replaced with a GroupAndVersion type. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
_workspace/src/k8s.io/kubernetes/pkg/api/validation
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.
|
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid. |
|
_workspace/src/k8s.io/kubernetes/pkg/apimachinery
Package apimachinery contains the generic API machinery code that is common to both server and clients.
|
Package apimachinery contains the generic API machinery code that is common to both server and clients. |
|
_workspace/src/k8s.io/kubernetes/pkg/apimachinery/registered
Package to keep track of API Versions that can be registered and are enabled in api.Scheme.
|
Package to keep track of API Versions that can be registered and are enabled in api.Scheme. |
|
_workspace/src/k8s.io/kubernetes/pkg/apis/authorization/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/apis/autoscaling/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/apis/componentconfig/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/apis/extensions/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/apis/metrics/install
Package install installs the metrics API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the metrics API group, making it available as an option to all of the API encoding/decoding machinery. |
|
_workspace/src/k8s.io/kubernetes/pkg/auth/user
Package user contains utilities for dealing with simple user exchange in the auth packages.
|
Package user contains utilities for dealing with simple user exchange in the auth packages. |
|
_workspace/src/k8s.io/kubernetes/pkg/capabilities
package capbabilities manages system level capabilities
|
package capbabilities manages system level capabilities |
|
_workspace/src/k8s.io/kubernetes/pkg/client/cache
Package cache is a client-side caching mechanism.
|
Package cache is a client-side caching mechanism. |
|
_workspace/src/k8s.io/kubernetes/pkg/client/metrics
Package metrics provides utilities for registering client metrics to Prometheus.
|
Package metrics provides utilities for registering client metrics to Prometheus. |
|
_workspace/src/k8s.io/kubernetes/pkg/client/unversioned
Package unversioned contains the implementation of the client side communication with the Kubernetes master.
|
Package unversioned contains the implementation of the client side communication with the Kubernetes master. |
|
_workspace/src/k8s.io/kubernetes/pkg/client/unversioned/auth
Package auth defines a file format for holding authentication information needed by clients of Kubernetes.
|
Package auth defines a file format for holding authentication information needed by clients of Kubernetes. |
|
_workspace/src/k8s.io/kubernetes/pkg/client/unversioned/clientcmd
Package clientcmd provides one stop shopping for building a working client from a fixed config, from a .kubeconfig file, from command line flags, or from any merged combination.
|
Package clientcmd provides one stop shopping for building a working client from a fixed config, from a .kubeconfig file, from command line flags, or from any merged combination. |
|
_workspace/src/k8s.io/kubernetes/pkg/conversion
Package conversion provides go object versioning.
|
Package conversion provides go object versioning. |
|
_workspace/src/k8s.io/kubernetes/pkg/conversion/queryparams
Package queryparams provides conversion from versioned runtime objects to URL query values
|
Package queryparams provides conversion from versioned runtime objects to URL query values |
|
_workspace/src/k8s.io/kubernetes/pkg/fields
Package fields implements a simple field system, parsing and matching selectors with sets of fields.
|
Package fields implements a simple field system, parsing and matching selectors with sets of fields. |
|
_workspace/src/k8s.io/kubernetes/pkg/kubelet/qos
package qos contains helper functions for quality of service.
|
package qos contains helper functions for quality of service. |
|
_workspace/src/k8s.io/kubernetes/pkg/labels
Package labels implements a simple label system, parsing and matching selectors with sets of labels.
|
Package labels implements a simple label system, parsing and matching selectors with sets of labels. |
|
_workspace/src/k8s.io/kubernetes/pkg/master/ports
Package ports defines ports used by various pieces of the kubernetes infrastructure.
|
Package ports defines ports used by various pieces of the kubernetes infrastructure. |
|
_workspace/src/k8s.io/kubernetes/pkg/runtime
Defines conversions between generic types and structs to map query strings to struct objects.
|
Defines conversions between generic types and structs to map query strings to struct objects. |
|
_workspace/src/k8s.io/kubernetes/pkg/types
Package types implements various generic types used throughout kubernetes.
|
Package types implements various generic types used throughout kubernetes. |
|
_workspace/src/k8s.io/kubernetes/pkg/util
Package util implements various utility functions used in both testing and implementation of Kubernetes.
|
Package util implements various utility functions used in both testing and implementation of Kubernetes. |
|
_workspace/src/k8s.io/kubernetes/pkg/util/errors
Package errors implements various utility functions and types around errors.
|
Package errors implements various utility functions and types around errors. |
|
_workspace/src/k8s.io/kubernetes/pkg/util/rand
Package rand provides utilities related to randomization.
|
Package rand provides utilities related to randomization. |
|
_workspace/src/k8s.io/kubernetes/pkg/util/sets
Package sets has auto-generated set types.
|
Package sets has auto-generated set types. |
|
_workspace/src/k8s.io/kubernetes/pkg/util/wait
Package wait provides tools for polling or listening for changes to a condition.
|
Package wait provides tools for polling or listening for changes to a condition. |
|
_workspace/src/k8s.io/kubernetes/pkg/version
Package version supplies version information collected at build time to kubernetes components.
|
Package version supplies version information collected at build time to kubernetes components. |
|
_workspace/src/k8s.io/kubernetes/pkg/watch
Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface.
|
Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface. |
|
_workspace/src/k8s.io/kubernetes/pkg/watch/json
Package json implements a simple encoder and decoder for streams of watch events over io.Writer/Readers
|
Package json implements a simple encoder and decoder for streams of watch events over io.Writer/Readers |
|
_workspace/src/k8s.io/kubernetes/plugin/pkg/auth/authenticator/request/x509
Package x509 provides a request authenticator that validates and extracts user information from client certificates
|
Package x509 provides a request authenticator that validates and extracts user information from client certificates |
|
_workspace/src/k8s.io/kubernetes/third_party/forked/reflect
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined.
|
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined. |
|
_workspace/src/speter.net/go/exp/math/dec/inf
Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic.
|
Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic. |
|
common
|
|
Click to show internal directories.
Click to hide internal directories.