zabbixapi 0.1.4 → 0.1.5a1

data/README.rdoc

@@ -1,11 +1,15 @@
 = Ruby Zabbix Api Module.
 
-Simple and lightweight ruby module for work with zabbix api version 1.8.2
+Simple and lightweight ruby module for work with zabbix api version 1.8.x
 
 You can:
 * Create host/template/application/items/triggers and screens;
 * Get info about all zabbix essences;
 
+== Installation
+
+    gem install zabbixapi
+
 == Get Start.
 
 * Get hostid from zabbix api:
@@ -21,8 +25,17 @@ You can:
 * net/https
 * json
 
+== Use examples
+
+* zabbix_la - LoadAverage template
+
+    cd examples
+    ruby zabbix_la -E development -g Templates
+
+* -E - env from examples/config.yml (like RAILS_ENV)
+* -g - group in zabbix for templates
+
 == Zabbix documentation
 
 * Zabbix Project Homepage -> http://zabbix.com/
-* Zabbix Api Draft docs -> http://www.zabbix.com/documentation/1.8/api
-
+* Zabbix Api docs -> http://www.zabbix.com/documentation/1.8/api

data/examples/config.yml

@@ -0,0 +1,4 @@
+development:
+  api_url: "http://zabbix.local/api_jsonrpc.php"
+  api_login: admin
+  api_password: zabbix

data/examples/zabbix_availability

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_Availability"
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.get_group_id(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_template(options)
+
+# Create application #{app_name}
+app_name = "Availability"
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+a_id = zbx.add_application(application)
+
+# 'Ping.'
+options = {
+  'description' => "Ping",
+  'key_' => "agent.ping",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 60,
+  'value_type' => 0,
+  'type' => '0'
+}
+p " ** Add 'Ping' to #{template_name}."
+i_id = zbx.add_item(options)
+
+# TRIGGERS
+options = {
+  'description' => "Host availability",
+  'expression' => "{#{template_name}:agent.ping.nodata(61)}=1",
+  'priority' => 5, #disaster
+  'templateid' => 0,
+  'comments' => "Host availability",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Host availability disaster trigger'"
+tr_id = zbx.add_trigger(options)

data/examples/zabbix_disk_io

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("d:g:E:")
+
+group_name = opt["g"]
+disk_name  = opt["d"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_Disk_" + disk_name.gsub(/\//, "_")
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+zbx.debug = true
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.get_group_id(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_template(options)
+
+# Create application #{app_name}
+app_name = "Disk_" + disk_name.gsub(/\//, "_")
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+a_id = zbx.add_application(application)
+
+# 'IOPS Read on #{disk_name} avg5'
+options = {
+  'description' => "IOPS Read on #{disk_name} avg5",
+  'key_' => "vfs.dev.read[#{disk_name}, ops, avg5]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => 'ops',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 300,
+  'value_type' => 0,
+}
+p " ** Add 'IOPS Read on #{disk_name} avg5' to #{template_name}."
+
+i_id = zbx.add_item(options)
+
+# 'IOPS Write on #{disk_name} avg5'
+options = {
+  'description' => "IOPS Write on #{disk_name} avg5",
+  'key_' => "vfs.dev.write[#{disk_name}, ops, avg5]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => 'ops',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 300,
+  'value_type' => 0,
+}
+p " ** Add 'IOPS Write on #{disk_name} avg5' to #{template_name}."
+
+i_id = zbx.add_item(options)
+
+# 'BPS Read on #{disk_name} avg5'
+options = {
+  'description' => "BPS Read on #{disk_name} avg5",
+  'key_' => "vfs.dev.read[#{disk_name}, sps, avg5]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+
+# convert sectors to bytes
+  'multiplier' => 1,
+  'formula' => 512,
+
+  'value_type' => 0,
+  'units' => 'Bps',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 300,
+}
+p " ** Add 'BPS Read on #{disk_name} avg5' to #{template_name}."
+
+bps_r_avg5_id = zbx.add_item(options)
+
+# 'BPS Write on #{disk_name}'
+options = {
+  'description' => "BPS Write on #{disk_name} avg5",
+  'key_' => "vfs.dev.write[#{disk_name}, sps, avg5]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+
+# convert sectors to bytes
+  'multiplier' => 1,
+  'formula' => 512,
+
+  'value_type' => 0,
+  'units' => 'Bps',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 300
+}
+p " ** Add 'BPS Write on #{disk_name} avg5' to #{template_name}."
+
+bps_w_avg5_id = zbx.add_item(options)
+
+# Create graph 'Disk usage #{disk_name}'
+options = { 
+  'gitems' => [
+    {   
+      "itemid" => bps_w_avg5_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "AA0000",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5" 
+    },  
+    {   
+      "itemid" => bps_r_avg5_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "009900",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5" 
+    }   
+  ],  
+  "show_triggers" => "1",
+  "name" => "Disk usage #{disk_name}",
+  "width" => "900",
+  "height" => "200",
+  "templateid" =>  "0" 
+}
+p " ** Add 'Disk usage #{disk_name} graph'"
+g_id = zbx.add_graph(options)

data/examples/zabbix_filesystem

@@ -0,0 +1,249 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("m:g:E:")
+
+mount_point = opt["m"]
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+if ( mount_point == "/" )
+  template_name = "TMPL_Filesystem_root"
+  app_name = "Filesystem_root"
+else
+  mount_point = mount_point.sub(/\/$/, "")
+  template_name = "TMPL_Filesystem" + mount_point.gsub(/\//, "_")
+  app_name = "Filesystem" + mount_point.gsub(/\//, "_")
+end
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.get_group_id(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_template(options)
+
+# Create application #{app_name}
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+
+a_id = zbx.add_application(application)
+
+# Total disk space on #{mount_point}
+options = {
+  'description' => "Total disk space on #{mount_point}",
+  'key_' => "vfs.fs.size[#{mount_point},total]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => 'B',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 600, 
+  'value_type' => 0
+}
+
+p " ** Add 'Total disk space on #{mount_point}' to #{template_name}."
+total_in_b_item_id = zbx.add_item(options)
+
+# Used disk space on #{mount_point}
+options = {
+  'description' => "Used disk space on #{mount_point}",
+  'key_' => "vfs.fs.size[#{mount_point},used]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => 'B',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+p " ** Add 'Used disk space on #{mount_point}' to #{template_name}."
+used_in_b_item_id = zbx.add_item(options)
+
+# Use disk space on #{mount_point} in %
+options = {
+  'description' => "Used disk space on #{mount_point} in %",
+  'key_' => "vfs.fs.size[#{mount_point},pused]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+p " ** Add 'Used disk space on #{mount_point} in %' to #{template_name}."
+i_id = zbx.add_item(options)
+
+# Free disk space on #{mount_point}
+options = {
+  'description' => "Free disk space on #{mount_point}",
+  'type' => '15', # calculated
+  'key_' => "vfs.fs.size[#{mount_point},free]",
+  'params' => "last(\"vfs.fs.size[#{mount_point},total]\") - last(\"vfs.fs.size[#{mount_point},used]\")",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => 'B',
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 60,
+  'value_type' => 0
+}
+
+p " ** Add 'Free disk space on #{mount_point}' to #{template_name}."
+i_id = zbx.add_item(options)
+
+# Free disk space on #{mount_point} in %
+options = {
+  'description' => "Free disk space on #{mount_point} in %",
+  'type' => '15', # calculated
+  'key_' => "vfs.fs.size[#{mount_point},pfree]",
+  'params' => "100 - last(\"vfs.fs.size[#{mount_point},pused]\")",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+p " ** Add 'Free disk space on #{mount_point} in %' to #{template_name}."
+i_id = zbx.add_item(options)
+
+# Free number of inodes on #{mount_point}
+options = {
+  'description' => "Free number of inodes on #{mount_point}",
+  'key_' => "vfs.fs.inode[#{mount_point},free]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'units' => '',
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+p " ** Add 'Free number of inodes on #{mount_point}' to #{template_name}."
+i_id = zbx.add_item(options)
+
+# Free number of inodes on #{mount_point} in %
+options = {
+  'description' => "Free number of inodes on #{mount_point} in %",
+  'key_' => "vfs.fs.inode[#{mount_point},pfree]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+p " ** Add 'Free number of inodes on #{mount_point} in %' to #{template_name}."
+i_id = zbx.add_item(options)
+
+## TRIGGERS
+options = {
+  'description' => "Free disk space on #{mount_point}",
+  'expression' => "{#{template_name}:vfs.fs.size[#{mount_point},pfree].last(0)}<15",
+  'priority' => 2, # warning
+  'templateid' => 0,
+  'comments' => "Free disk space on #{mount_point} (warning)",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Free disk space on #{mount_point} warning trigger'"
+tr_id = zbx.add_trigger(options)
+
+options = {
+  'description' => "Free disk space on #{mount_point}",
+  'expression' => "{#{template_name}:vfs.fs.size[#{mount_point},pfree].last(0)}<10",
+  'priority' => 5, # Disaster
+  'templateid' => 0,
+  'comments' => "Free disk space on #{mount_point} (disaster)",
+  'type' => 0,
+  'status' => 0
+}
+
+p " ** Add 'Free disk space on #{mount_point} disaster trigger'"
+tr_id = zbx.add_trigger(options)
+
+options = {
+  'description' => "Free inodes on #{mount_point}",
+  'expression' => "{#{template_name}:vfs.fs.inode[#{mount_point},pfree].last(0)}<15",
+  'priority' => 2, # warning
+  'templateid' => '0',
+  'comments' => "Free disk inodes on #{mount_point} (warning)",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Free inodes on #{mount_point} warning trigger'"
+tr_id = zbx.add_trigger(options)
+
+options = {
+  'description' => "Free inodes on #{mount_point}",
+  'expression' => "{#{template_name}:vfs.fs.inode[#{mount_point},pfree].last(0)}<10",
+  'priority' => 5, #disaster
+  'templateid' => '0',
+  'comments' => "Free disk inodes on #{mount_point} (disaster)",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Free inodes on #{mount_point} disaster trigger'"
+tr_id = zbx.add_trigger(options)
+
+options = {
+  'gitems' => [
+    {
+      "itemid" => total_in_b_item_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "AA0000",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5"
+    },
+    {
+      "itemid" => used_in_b_item_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "009900",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5"
+    }
+  ],
+  "show_triggers" => "1",
+  "name" => "Disk space on #{mount_point}",
+  "width" => "900",
+  "height" => "200",
+  "templateid" =>  "0"
+}
+p " ** Add 'Disk space on #{mount_point} graph'"
+g_id = zbx.add_graph(options)

data/examples/zabbix_la

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'yaml'
+require 'getopt/std'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_Load_average"
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.get_group_id(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_template(options)
+
+# Create application #{app_name}
+app_name = "Load_average"
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+a_id = zbx.add_application(application)
+
+# 'Load Average 1'
+options = {
+  'description' => "Load Average 1",
+  'key_' => "system.cpu.load[,avg1]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 60,
+  'value_type' => 0
+}
+p " ** Add 'Load Average 1' to #{template_name}."
+
+i_id = zbx.add_item(options)
+
+# 'Load Average 5'
+options = {
+  'description' => "Load Average 5",
+  'key_' => "system.cpu.load[,avg5]",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 300,
+  'value_type' => 0
+}
+p " ** Add 'Load Average 5' to #{template_name}."
+
+i_id = zbx.add_item(options)
+
+# TRIGGERS
+
+options = {
+  'description' => "Load Average",
+  'expression' => "{#{template_name}:system.cpu.load[,avg5].last(0)}>5",
+  'priority' => 2, # warning
+  'templateid' => 0,
+  'comments' => "Load Average (warning)",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Load Average warning trigger'"
+tr_id = zbx.add_trigger(options)
+
+options = {
+  'description' => "Load Average",
+  'expression' => "{#{template_name}:system.cpu.load[,avg5].last(0)}>10",
+  'priority' => 5, # disaster
+  'templateid' => 0,
+  'comments' => "Load Average (disaster)",
+  'type' => 0,
+  'status' => '0'
+}
+
+p " ** Add 'Load Average disaster trigger'"
+tr_id = zbx.add_trigger(options)