Skip to content
This repository was archived by the owner on Dec 1, 2018. It is now read-only.

[EOL] Compute Resource Usage Analysis and Monitoring of Container Clusters

License

Notifications You must be signed in to change notification settings

kubernetes-retired/heapster

Folders and files

NameName
Last commit message
Last commit date
Feb 6, 2018
Mar 26, 2018
Nov 29, 2018
Jul 26, 2018
Sep 1, 2018
Nov 29, 2018
Jul 17, 2018
Feb 21, 2017
Jul 9, 2018
Mar 26, 2018
Nov 29, 2018
Mar 26, 2018
Nov 29, 2016
Jan 5, 2017
Aug 8, 2017
Aug 20, 2014
Nov 29, 2018
Apr 9, 2018
Nov 26, 2018
Dec 20, 2017

Repository files navigation

Heapster

RETIRED: Heapster is now retired. See the deprecation timeline for more information on support. We will not be making changes to Heapster.

The following are potential migration paths for Heapster functionality:

  • For basic CPU/memory HPA metrics: Use metrics-server.

  • For general monitoring: Consider a third-party monitoring pipeline that can gather Prometheus-formatted metrics. The kubelet exposes all the metrics exported by Heapster in Prometheus format. One such monitoring pipeline can be set up using the Prometheus Operator, which deploys Prometheus itself for this purpose.

  • For event transfer: Several third-party tools exist to transfer/archive Kubernetes events, depending on your sink. heptiolabs/eventrouter has been suggested as a general alternative.

GoDoc Build Status Go Report Card

Heapster enables Container Cluster Monitoring and Performance Analysis for Kubernetes (versions v1.0.6 and higher), and platforms which include it.

Heapster collects and interprets various signals like compute resource usage, lifecycle events, etc. Note that the model API, formerly used provide REST access to its collected metrics, is now deprecated. Please see the model documentation for more details.

Heapster supports multiple sources of data. More information here.

Heapster supports the pluggable storage backends described here. 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

Heapster can run on a Kubernetes cluster using a number of backends. Some common choices:

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 standalone Heapster or a combination of Heapster and Hawkular-Metrics in OpenShift, follow this guide.

Troubleshooting guide here

Community

Contributions, questions, and comments are all welcomed and encouraged! Developers hang out on Slack in the #sig-instrumentation channel (get an invitation here). We also have the kubernetes-dev Google Groups mailing list. If you are posting to the list please prefix your subject with "heapster: ".