-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
kube-state-metrics initial code #1
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
kube-state-metrics | ||
|
||
# Created by https://www.gitignore.io/api/go | ||
|
||
### Go ### | ||
# Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
*.o | ||
*.a | ||
*.so | ||
|
||
# Folders | ||
_obj | ||
_test | ||
|
||
# Architecture specific extensions/prefixes | ||
*.[568vq] | ||
[568vq].out | ||
|
||
*.cgo1.go | ||
*.cgo2.c | ||
_cgo_defun.c | ||
_cgo_gotypes.go | ||
_cgo_export.* | ||
|
||
_testmain.go | ||
|
||
*.exe | ||
*.test | ||
*.prof | ||
|
||
*.iml | ||
.idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
# kube-state-metrics | ||
Add-on agent to export cluster metrics to monitoring systems. | ||
# Overview | ||
|
||
kube-state-metrics generates metrics about the state of the object inside of a | ||
Kubernetes cluster. It is not focused on the health of the Kubernetes | ||
components individually, but rather on the health of the various objects | ||
inside, such as deployments, nodes and pods. | ||
|
||
*Requires Kubernetes 1.2+* | ||
|
||
# Usage | ||
|
||
Simply build and run kube-state-metrics inside a Kubernetes pod which has a | ||
service account token that has read-only access to the Kubernetes cluster. | ||
|
||
## Metrics | ||
|
||
There are many more metrics we could report, but this first pass is focused on | ||
those that could result in actionable alerts. Please contribute PR's for | ||
additional metrics! | ||
|
||
### WARNING: THESE METRIC/TAG NAMES ARE UNSTABLE AND MAY CHANGE IN A FUTURE RELEASE. | ||
|
||
* nodes ready=<true|false> | ||
* deployment_replicas name=<deployment-name> namespace=<deployment-namespace> | ||
* deployment_replicas_available name=<deployment-name> namespace=<deployment-namespace> | ||
* container_restarts name=<container-name> namespace=<pod-namespace> pod_name=<pod-name> | ||
|
||
# Development | ||
|
||
When developing, test a metric dump against your local Kubernetes cluster by running: | ||
|
||
``` | ||
go run main.go --apiserver=<APISERVER-HERE> --in-cluster=false --port=<APISERVER-PORT> --dry-run | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!