openstack/monasca-agent
Code Issues Proposed changes

Change template/example of Libvirt config file

Browse Source 
Some of parameters which can be configured for Libvirt monitoring are
missing from the template file and example of documentation.
This commit adds the parameter examples.

Change-Id: I98e9a928179d22373c658894a82d64df9dc7d043
Story: 2001137
Task: 4853
This commit is contained in:
Haruki Yamanashi 2017-08-01 14:32:08 +09:00
parent 5d53a29e40
commit 2e5c6475e7
2 changed files with 35 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
conf.d/libvirt.yaml.example
View File

@ -6,6 +6,7 @@ init_config:
project_name: service
username: nova
auth_url: 'http://192.168.10.5/identity'
region_name: 'region1'
# Options to specify endpoint type, default to 'publicURL', other choices:
# 'internalURL' and 'adminURL'
endpoint_type: 'publicURL'
@ -20,6 +21,8 @@ init_config:
# The word 'NAMESPACE' is automatically replaced by the appropriate network
# namespace for each VM being monitored.
ping_check: sudo -n /sbin/ip exec NAMESPACE /usr/bin/fping -n -c1 -t250 -q
# Number of ping command processes that will be run concurrently.
max_ping_concurrency: 8
# Suppress all per-VM metrics aside from host_alive_status, including all
# I/O, network, memory, ping, and CPU metrics.
alive_only: false
@ -31,6 +34,26 @@ init_config:
# Include scale group dimension for customer metrics.
customer_metadata:
- scale_group
# Submit network metrics in bits rather than bytes.
network_use_bits: false
# Configuration parameters used to control which metrics are reported
# by libvirt plugin.
vm_cpu_check_enable: True
vm_disks_check_enable: True
vm_network_check_enable: True
vm_ping_check_enable: True
vm_extended_disks_check_enable: False
# Specify a regular expression with which to match nova host aggregate names.
# If this hypervisor is a member of a host aggregate matching this regular
# expression, an additional dimension of host_aggregate will be published
# for the operations metrics (with a value of the host aggregate name).
host_aggregate_re: None
# Interval between disk metric collections in seconds. If this is less than
# the agent collection period, it will be ignored.
disk_collection_period: 0
# Interval between vnic metric collections in seconds. If this is less than
# the agent collection period, it will be ignored.
vnic_collection_period: 0
instances:
# Instances are automatically detected through queries to the Nova API,
# and therefore do not need to be listed here, so this remains empty.

16
docs/Libvirt.md
View File

@ -79,7 +79,7 @@ If the owner of the VM is in a different tenant the Agent Cross-Tenant Metric Su
`vm_ping_check_enable` enable host alive ping check (Default True). Please see "Mapping Metrics to Configuration Parameters" section below for what metrics are controlled by this flag.
`vm_extended_disks_check_enable` enable collecting of extended Disk metrics (Default True). Please see "Mapping Metrics to Configuration Parameters" section below for what metrics are controlled by this flag.
`vm_extended_disks_check_enable` enable collecting of extended Disk metrics (Default False). Please see "Mapping Metrics to Configuration Parameters" section below for what metrics are controlled by this flag.
`host_aggregate_re` can be used to specify a regular expression with which to match nova host aggregate names. If this hypervisor is a member of a host aggregate matching this regular expression, an additional dimension of `host_aggregate` will be published for the operations metrics (with a value of the host aggregate name).
@ -101,9 +101,17 @@ init_config:
vm_probation: 300
ping_check: /opt/stack/venv/monasca_agent-20160224T213950Z/bin/ip netns exec NAMESPACE
/bin/ping -n -c1 -w1 -q
max_ping_concurrency: 8
alive_only: false
network_use_bits: false
host_aggregate_re: M[34]
vm_cpu_check_enable: True
vm_disks_check_enable: True
vm_network_check_enable: True
vm_ping_check_enable: True
vm_extended_disks_check_enable: False
host_aggregate_re: None
disk_collection_period: 0
vnic_collection_period: 0
instances:
- {}
```
@ -393,11 +401,11 @@ Configuration parameters can be used to control which metrics are reported by li
| | vm.net.out_packets | net.out_packets |
| | vm.net.out_packets_sec | net.out_packets_sec |
| vm_ping_check_enable (default: True) | vm.ping_status | ping_status |
| vm_extended_disks_check_enable (default: True) | vm.disk.allocation | disk.allocation |
| vm_extended_disks_check_enable (default: False) | vm.disk.allocation | disk.allocation |
| | vm.disk.capacity | disk.capacity |
| | vm.disk.physical | disk.physical |
| | vm.disk.allocation_total | disk.allocation_total |
|vm_disks_check_enable(default: True) and vm_extended_disks_check_enable(default: True) | vm.io.errors_total | io.errors_total |
|vm_disks_check_enable(default: True) and vm_extended_disks_check_enable(default: False) | vm.io.errors_total | io.errors_total |
| | vm.io.errors_total_sec | io.errors_total_sec |
| | vm.io.read_bytes_total | io.read_bytes_total |
| | vm.io.read_bytes_total_sec | io.read_bytes_total_sec |