Skip to content

📖Add documentation for metrics #1763

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.

Sign up for GitHub

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

Merged
k8s-ci-robot merged 1 commit into from
Nov 13, 2019
Merged

📖Add documentation for metrics #1763

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/book/src/providers/v1alpha2-to-v1alpha3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,21 @@

- Previously examples and tests were setting/checking for the label to be set to `true`.
- The function `util.IsControlPlaneMachine` was previously checking for any value other than empty string, while now we only check if the associated label exists.

## Machine `Status.Phase` field set to `Provisioned` if a NodeRef is set but infrastructure is not ready

- The machine Status.Phase is set back to `Provisioned` if the infrastructure is not ready. This is only applicable if the infrastructure node status does not have any errors set.

## Metrics

- The cluster and machine controllers expose the following prometheus metrics.
- `capi_cluster_control_plane_ready`: Cluster control plane is ready if set to 1 and not if 0.
- `capi_cluster_infrastructure_ready`: Cluster infrastructure is ready if set to 1 and not if 0.
- `capi_cluster_kubeconfig_ready`: Cluster kubeconfig is ready if set to 1 and not if 0.
- `capi_cluster_error_set`: Cluster ErrorMesssage or ErrorReason is set if metric is 1.
- `capi_machine_bootstrap_ready`: Machine Boostrap is ready if set to 1 and not if 0.
- `capi_machine_infrastructure_ready`: Machine InfrastructureRef is ready if set to 1 and not if 0.
- `capi_machine_node_ready`: Machine NodeRef is ready if set to 1 and not if 0.

They can be accessed by default via the `8080` metrics port on the cluster
api controller manager.