Skip to content

Commit

Permalink
Merge pull request #769 from shalvah/patch-1
Browse files Browse the repository at this point in the history
Add note on costing to README
  • Loading branch information
k8s-ci-robot authored May 28, 2019
2 parents b01b72c + 106653f commit ddce907
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ the raw metrics.
- [Metrics Documentation](#metrics-documentation)
- [Kube-state-metrics self metrics](#kube-state-metrics-self-metrics)
- [Resource recommendation](#resource-recommendation)
- [A note on costing](#a-note-on-costing)
- [kube-state-metrics vs. metrics-server](#kube-state-metrics-vs-metrics-server)
- [Setup](#setup)
- [Building the Docker container](#building-the-docker-container)
Expand Down Expand Up @@ -124,6 +125,9 @@ These numbers are based on [scalability tests](https://github.com/kubernetes/kub

Note that if CPU limits are set too low, kube-state-metrics' internal queues will not be able to be worked off quickly enough, resulting in increased memory consumption as the queue length grows. If you experience problems resulting from high memory allocation, try increasing the CPU limits.

### A note on costing
By default, kube-state-metrics exposes several metrics for events across your cluster. If you have a large number of frequently-updating resources on your cluster, you may find that a lot of data is ingested into these metrics. This can incur high costs on some cloud providers. Please take a moment to [configure what metrics you'd like to expose](docs/cli-arguments.md), as well as consult the documentation for your Kubernetes environment in order to avoid unexpectedly high costs.

### kube-state-metrics vs. metrics-server

The [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
Expand Down

0 comments on commit ddce907

Please sign in to comment.