Guide to the Zabbix Plugin

version 1.0.0 for Fuel

GuidetotheZabbixPluginversion1.0.0forFuel
Revisionhistory
Documentpurpose
Keyterms,acronymsandabbreviations
ZabbixPlugin
Requirements
InstallationGuide
Zabbixplugininstallation
UserGuide
Environmentconfiguration
ZabbixfrontendUI
Pages
Hostgroupspage
Hostspage
Templatespage
Appendix
Componentslicenses

Revision history

Version

Revisiondate

Editor

Comment

0.1

01.23.2014

IrinaPovolotskaya
(ipovolotskaya@mirantis.com)

Createdthetemplatestructure.

0.2

03.23.2015

PiotrMisiak
(pmisiak@mirantis.com)

Firstrelease.

0.3

03.25.2015

IrinaPovolotskaya
(ipovolotskaya@mirantis.com)

Minorchanges.

0.4

03.30.2015

IrinaPovolotskaya
(ipovolotskaya@mirantis.com)

Added
Documentpurpose
and
Key
terms,acronymsandabbreviations
sections.

0.5

03.31.2015

PiotrMisiak
(pmisiak@mirantis.com)

Installationguidechangedtorpm
package

0.6

04.02.2015

PiotrMisiak
(pmisiak@mirantis.com)

Userguideadded

1.0

04.15.2015

PiotrMisiak
(pmisiak@mirantis.com)

Majorversion

Document purpose

Thisdocumentprovidesinstructionsforinstalling,configuringandusingZabbixpluginforFuel.

Key terms, acronyms and abbreviations

Term/acronym/abbreviation

Definition

Zabbix

An enterprise open source monitoring solution

for networks and applications. It is designed to
monitor and track the status of various network
services,servers,andothernetworkhardware.

VIP

VirtualIPAddress.

Zabbix Plugin

This plugin extends Mirantis OpenStack functionality by adding Zabbix monitoring system. It
installs Zabbix server, frontend and agent components. The plugin configures Zabbix by adding
templatestomonitornodesandOpenStackservicesandAPIs.

Requirements

Requirement
Fuel

Version/Comment
6.1

Installation Guide
Zabbix plugin installation

ToinstallZabbixplugin,followthesesteps:
1. Downloadthepluginfromthe
FuelPluginsCatalog
2. CopythepluginonalreadyinstalledFuelMasternodesshcanbeusedforthat.Ifyoudo
nothavetheFuelMasternodeyet,see
QuickStartGuide
:

# scp zabbix_monitoring-1.0-1.0.0-1.noarch.rpm root@<The_Fuel_Master_node_IP>:/tmp

3. LogintotheFuelMasternode.Installtheplugin:
# cd /tmp
# fuel plugins --install zabbix_monitoring-1.0-1.0.0-1.noarch.rpm

4. Checkifthepluginwasinstalledsuccessfully:

# fuel plugins

id | name
| version | package_version
---|---------------------------|----------|---------------1 | zabbix_monitoring
| 1.0.0
| 2.0.0

Zabbix plugin removal

TouninstallZabbixplugin,followthesesteps:
1. DeleteallEnvironmentsinwhichZabbixpluginhasbeenenabled.
2. Uninstalltheplugin:

# fuel plugins --remove zabbix_monitoring==1.0.0

3. Checkifthepluginwasuninstalledsuccessfully:

# fuel plugins
id | name
| version | package_version
---|---------------------------|----------|----------------

User Guide
Environment configuration

1. Createanenvironment.Formoreinformationaboutenvironmentcreation,
see

MirantisOpenStackUserGuide
.

2. Open
Settings
taboftheFuelwebUIandscrollthepagedown.Selecttheplugincheckbox
andsetcredentialsforZabbixAdministratorandZabbixDatabase:

You could see default passwords by clicking on the eye icon. It is highly recommended to
changedefaultpasswordsforZabbixAdministratorandZabbixDatabase.
3. Adjustotherenvironmentsettingstoyourrequirementsanddeploytheenvironment.

Formoreinformation,see

MirantisOpenStackUserGuide
.

Zabbix frontend UI

After successful deployment you will see a green notification:

Deployment ofenvironment'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
loginpage:

NowlogintoZabbixwiththecredentialssetprovidedonthe
Settings
taboftheFuelwebUI(see
step2inthe
Environmentconfiguration
section).AfterloggingintoZabbix,youwillseethe
Zabbix
Dashboard
page:

The
ZabbixDashboard
pageprovidesinformationonrunningprocessesandtheirstate.
Ifallprocessesarerunningsuccessfullyintheenvironment,youshouldseeonlygreencolour.
Todemonstratethatmonitoringisworkingproperly,theNovaSchedulerprocesshadbeenturned
off.YoucannoticethatZabbixdetectedthehaltedprocessandprovidedtheproblemdescription:
Nova Scheduler process is not running on node-13.domain.tld.
7

Whenyougoto
Monitoring>Screens
page,youwillseethe
OpenStackCluster
screen:

On this screen you have general statistics and graphs presenting resources usage in OpenStack
environment.Thereisalsoalistoflast10eventsrecordedbyZabbix.

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.

Host groups page

This page has a list of host groups with their members. There are separategroupsforControllers
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.1Hostsandhostgroups
chapterintheofficialZabbixDocumentation.

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 particularhosts.Duringinstallation,theplugindetectswhichserviceshave
been installed on a particular node and links appropriate templates to the node to enable
monitoring for those services. There isanZabbixagentavailabilityreportinthelast column.When
Ziconisgreen,theZabbixagentonthisnodeisrunningandavailable.

10

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.6Templates
chapterintheofficialZabbixDocumentation.

Youcanaddanadditionalitems(checks),createtriggersandeventsviaZabbixUI.Formore
informationandinstructions,see
6.2Items
,
6.3Triggers
and
6.4Events
chaptersintheofficial
ZabbixDocumentation.
Bydefault,therearenonotificationsconfigured,butyoucanaddthemintotheZabbixUI.Formore
informationandinstructions,see
6.7Notificationsuponevents
chapterintheofficialZabbix
Documentation.

Appendix

ZabbixOfficialsite
Zabbix2.4documentation
FuelPluginsCLIguide
11

Components licenses

debpackages:
zabbixfrontendphp:GPL2.0
zabbixservermysql:GPL2.0
zabbixagent:GPL2.0
rpmpackages:
zabbixagent:GPLv2+
zabbixserver:GPLv2+
zabbixservermysql:GPLv2+
zabbixweb:GPLv2+
zabbixwebmysql:GPLv2+

12