From 79fde06e51381c1181e0dd7a8964e715453450db Mon Sep 17 00:00:00 2001 From: Jacob Cody Wimer Date: Tue, 24 Nov 2020 18:37:32 -0500 Subject: [PATCH] Pretty up metrics chart on README --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ebff689..06cc416 100644 --- a/README.md +++ b/README.md @@ -36,22 +36,22 @@ openstack_api_status{api_name="horizon",cloud_name="CLOUD_NAME"} # Information ### Standard Metrics Provided | Metric | Description| -|--------------------------|----------| -| openstack_api_response_seconds{api_name="API_NAME",cloud_name="CLOUD_NAME"} | Seconds for the api to respond via openstack sdk. nova, neutron, and cinder are currently recorded. | -| openstack_api_status{api_name="API_NAME",cloud_name="CLOUD_NAME"} | Status of the openstack api. 1 = up 0 = down. nova, neutron, and cinder are currently recorded. | -| openstack_hypervisor_running_vms{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Number of running VMs on every hypervisor in the region. | -| openstack_hypervisor_used_ram_mb{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Amount of RAM in MB used (as reported by nova-compute) for every hypervisor in the region. | -| openstack_hypervisor_total_ram_mb{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Amount of RAM in MB in total (as reported by nova-compute) for every hypervisor in the region. | -| openstack_hypervisor_used_cpus{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Number of vcpus used (as reported by nova-compute) for every hypervisor in the region. | -| openstack_hypervisor_total_cpus{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Number of vcpus in total (as reported by nova-compute) for every hypervisor in the region. | -| openstack_hypervisor_enabled{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | nova-compute status for every hypervisor in the region. 1 = enabled 0 = disabled| -| openstack_hypervisor_up{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | nova-compute state for every hypervisor in the region. 1 = up 0 = down | -| openstack_hypervisor_local_gb_total{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Total local disk in GB (as reported by nova-compute) for every hypervisor in the region. | -| openstack_hypervisor_local_gb_used{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Total local disk used in GB (as reported by nova-compute) for every hypervisor in the region. | +|--------------------------|--------------------------| +| `openstack_api_response_seconds{api_name="API_NAME",cloud_name="CLOUD_NAME"}` | Seconds for the api to respond via openstack sdk. nova, neutron, and cinder are currently recorded. | +| `openstack_api_status{api_name="API_NAME",cloud_name="CLOUD_NAME"}` | Status of the openstack api. 1 = up 0 = down. nova, neutron, and cinder are currently recorded. | +| `openstack_hypervisor_running_vms{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Number of running VMs on every hypervisor in the region. | +| `openstack_hypervisor_used_ram_mb{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Amount of RAM in MB used (as reported by nova-compute) for every hypervisor in the region. | +| `openstack_hypervisor_total_ram_mb{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Amount of RAM in MB in total (as reported by nova-compute) for every hypervisor in the region. | +| `openstack_hypervisor_used_cpus{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Number of vcpus used (as reported by nova-compute) for every hypervisor in the region. | +| `openstack_hypervisor_total_cpus{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Number of vcpus in total (as reported by nova-compute) for every hypervisor in the region. | +| `openstack_hypervisor_enabled{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | nova-compute status for every hypervisor in the region. 1 = enabled 0 = disabled| +| `openstack_hypervisor_up{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | nova-compute state for every hypervisor in the region. 1 = up 0 = down | +| `openstack_hypervisor_local_gb_total{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}`| Total local disk in GB (as reported by nova-compute) for every hypervisor in the region. | +| `openstack_hypervisor_local_gb_used{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Total local disk used in GB (as reported by nova-compute) for every hypervisor in the region. | ### Optional Metrics (use flags when running) | Metric | Description | |-----|-----| -|openstack_instance_deploy_seconds_to_ping{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"} | Seconds from deploy command to ping when creating an instance for every hypervisor in the region. Requires --flavor, --image, --network, and --instance_deploy flags. The network used needs to have TCP port 22 (uses TCP instead of ICMP to ping) open in the default security group. | -|openstack_horizon_response_seconds{cloud_name="CLOUD_NAME"} | Seconds it takes for Chromium to log into Horizon. Requires --horizon_url flag. | -|openstack_horizon_status{cloud_name="CLOUD_NAME"} | Horizon status. 1 = up 0 = down. Requires --horizon_url flag. | \ No newline at end of file +|`openstack_instance_deploy_seconds_to_ping{hypervisor_hostname="HYPERVISOR_NAME",cloud_name="CLOUD_NAME"}` | Seconds from deploy command to ping when creating an instance for every hypervisor in the region. Requires --flavor, --image, --network, and --instance_deploy flags. The network used needs to have TCP port 22 (uses TCP instead of ICMP to ping) open in the default security group. | +|`openstack_horizon_response_seconds{cloud_name="CLOUD_NAME"}` | Seconds it takes for Chromium to log into Horizon. Requires --horizon_url flag. | +|`openstack_horizon_status{cloud_name="CLOUD_NAME"}` | Horizon status. 1 = up 0 = down. Requires --horizon_url flag. | \ No newline at end of file