fuel-plugin-external-zabbix/doc/plugin-guide/source/guide.rst

User Guide

Environment configuration

1. Create an environment. For more information about environment creation, see Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel /fuel-7.0/user-guide.html#create-a-new-openstack-environment>.

2. Choose in Environments an evironment for which you want to run Zabbix plugin.

3. Open Settings tab and scroll the page down. On the left select Zabbix for Fuel.

4. Set credentials for Zabbix for Fuel:

   

   You could see default passwords by clicking on the eye icon. It is highly recommended to change default passwords for Zabbix Administrator, Zabbix Database and Monitoring user. User 'monitoring' will be added in Openstack for zabbix API checks.

5. Adjust other environment settings to your requirements and deploy the environment. For more information, see Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel /fuel-7.0/user-guide.html#create-a-new-openstack-environment>.

6. If you are using Fuel network-template you should add new roles mapping named 'zabbix'. Here is a sample:

   network_scheme:
       mgmt:
           endpoints:
           - br-mgmt
           roles:
               zabbix: br-mgmt

   For details see Using Networking Templates <https://docs.mirantis.com /openstack/fuel/fuel-7.0/operations.html#using-networking-templates>.

Zabbix frontend UI

1. After successful deployment you will see a green notification: “Deployment of environment 'test' is done. Access the OpenStack dashboard (Horizon) at http://172.16.0.2/”.

   In this example, 172.16.0.2 is a VIP address.

   Zabbix UI will be available at http://172.16.0.2/zabbix (at http://<VIP>/zabbix in general). After opening this address in a browser, you should see Zabbix login page:

   

2. Now log into Zabbix with the credentials set provided on the Settings tab of the Fuel web UI (see step 2 in the Environment configuration section). After logging into Zabbix, you will see the Zabbix Dashboard page:

   

3. The Zabbix Dashboard page provides information on running processes and their state. If all processes are running successfully in the environment, you should see only green color. To demonstrate that monitoring is working properly, the Nova Scheduler process had been turned off. You can notice that Zabbix detected the halted process and provided the problem description: Nova Scheduler process is not running on node-13.domain.tld. When you go to Monitoring->Screens page, you will see the OpenStack Cluster screen:

   

   

   On this screen you have general statistics and graphs presenting resources usage in OpenStack environment. There is also a list of last 10 events recorded by Zabbix.

Pages

Below there are a few screenshots from Zabbix configuration pages to show how it should look after a successful environment deployment. Zabbix UI provides several pages placed under Configuration tab.

1. Host groups page This page has a list of host groups with their members. There are separate groups for Controllers and Computes. These groups are used to join nodes with the same role in OpenStack environment. There is also ManagedByPuppet group which contains all OpenStack nodes. Remaining host groups are created by default in Zabbix. For more information and instructions, see 6.1 Hosts and host groups <https://www.zabbix.com/documentation/2.4/manual/config /hosts> chapter in the official Zabbix Documentation.

   

2. Hosts page This page contains a list of all monitored OpenStack nodes and, additionally one OpenStackCluster virtual host which represents OpenStack API. There are also lists of linked monitoring templates to particular hosts. During installation, the plugin detects which services have been installed on a particular node and links appropriate templates to the node to enable monitoring for those services. There is an Zabbix agent availability report in the last column. When ‘Z’ icon is green, the Zabbix agent on this node is running and available.

   

   

3. Templates page This page contains a list of all monitoring templates and list of hosts to which they are linked. A monitoring template is a way to group items, graphs and thresholds which monitor a particular resource type, for example an OpenStack service like Nova Compute. For more information and instructions, see 6.6 Templates chapter <https://www.zabbix.com/documentation/2.4/manual /config/templates> in the official Zabbix Documentation.

   

   

   You can add an additional items (checks), create triggers and events via Zabbix UI. For more information and instructions, see 6.2 Items, 6.3 Triggers and 6.4 Events chapters <https://www.zabbix.com/documentation/2.4/manual /config/events> in the official Zabbix Documentation. By default, there are no notifications configured, but you can add them into the Zabbix UI. For more information and instructions, see 6.7 Notifications upon events chapter in the official Zabbix Documentation.

Ceph

When Ceph is deployed the plugin configures:

• A Host 'CephCluster' with 2 triggers:

  

• A Screen 'Ceph':

  

• Metrics collection:

  • monitor_count
  • quorum_count
  • pg_bytes_used
  • pg_bytes_free
  • pg_bytes_total
  • pg_data_bytes
  • pg_count
  • pg_state_count_backfill
  • pg_state_count_repair
  • pg_state_count_creating
  • pg_state_count_recovering
  • pg_state_count_peered
  • pg_state_count_incomplete
  • pg_state_count_peering
  • pg_state_count_splitting
  • pg_state_count_waitbackfill
  • pg_state_count_down
  • pg_state_count_backfilltoofull
  • pg_state_count_remapped
  • pg_state_count_replay
  • pg_state_count_inconsistent
  • pg_state_count_clean
  • pg_state_count_active
  • pg_state_count_undersized
  • pg_state_count_degraded
  • pg_state_count_stale
  • pg_state_count_scrubbing
  • objects_count
  • pool_count
  • pool_total_bytes_used
  • pool_total_bytes_free
  • pool_total_bytes_total
  • pool_total_percent_used
  • pool_total_percent_free
  • osd_count_up
  • osd_count_down
  • osd_count_in
  • osd_count_out