zabbix-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c08d62e412a270dbcc25ff8c0fbed71b448217dfd461c0c14290d53b75aa155d
+  data.tar.gz: 9012f1824fee422931f7f464ccfd1bb567bc6c8f501cd7343ea406002073b4ff
+SHA512:
+  metadata.gz: 9c1f62a5f09290006d51d2211061d89201303719f87836542d4d6e1af9e4e346cdece9d88cd91dc9f99c1c9ecc42408fb5c2ce868a7ecb585a19f83f8137ba24
+  data.tar.gz: ec142fb5c24d488157982a6a71c22475a67928a32ee1ebdc01a64682d5a9b5992c025a9b9f3945f16a3773307a146130b8735861600f2fb90bc24ec3d25b99ea

data/README.md

@@ -0,0 +1,28 @@
+# Zabbix
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "zabbix-rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install zabbix-rails
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/zabbix_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :zabbix-rails do
+#   # Task goes here
+# end

data/lib/zabbix/connector.rb

@@ -0,0 +1,46 @@
+module Zabbix
+  module Connector
+    include ActiveSupport::Concern
+
+    # 开发测试环境需要单独开启缓存功能：bin/rails dev:cache
+    # 将鉴权后的 zabbix-rails 对象缓存到 Rails，减少不必要的认证动作加速执行
+    # https://guides.rubyonrails.org/caching_with_rails.html
+    def zabbix_connector
+      url      = "http://zabbix-rails.local/api_jsonrpc.php"
+      user     = "Admin"
+      password = "zabbix-rails"
+
+      Rails.cache.fetch("zabbix_connector", expires_in: 4.hours) do
+        Rails.logger.warn("Zabbix 正在请求 API 鉴权")
+        ZabbixManager.connect(url: url, user: user, password: password, debug: false)
+      rescue => e
+        Rails.logger.warn("登录 ZABBIX 异常，请检查网络或登录凭证。原始报错信息: #{e}")
+      end
+    end
+
+    # 删除主机监控
+    def delete_host_monitor(name)
+      id = zabbix_connector.hosts.get_host_id(name)
+      if id.present?
+        zabbix_connector.hosts.delete(id)
+        Rails.logger.warn("执行 delete_host_monitor 接口成功：#{name} - #{id}")
+      else
+        Rails.logger.warn("调用 delete_host_monitor 接口异常：#{name} - #{id}")
+      end
+    rescue => e
+      Rails.logger.warn("调用 delete_host_monitor 接口异常，原始报错信息: #{e}")
+    end
+
+    # 删除监控触发器
+    def delete_trigger_monitor(id)
+      if id.present?
+        zabbix_connector.triggers.delete(id)
+        Rails.logger.warn("执行 delete_trigger_monitor 接口成功：#{id}")
+      else
+        Rails.logger.warn("调用 delete_trigger_monitor 接口异常：#{id}")
+      end
+    rescue => e
+      Rails.logger.warn("调用 delete_trigger_monitor 接口异常，原始报错信息: #{e}")
+    end
+  end
+end

data/lib/zabbix/dns_monitor.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zabbix
+  module DnsMonitor
+    include ActiveSupport::Concern
+
+    # 生成 DNS 触发器表达式
+    def dns_trigger_expression(name)
+      # 定义告警规则
+      expression = "{dns_query_with_localdns:net.dns.record[,#{name},A,2,2].diff()}=1 or {dns_query_with_localdns:net.dns.record[,#{name},A,2,2].nodata(5m)}=1"
+
+      # 定义告警恢复规则
+      recovery_expression = "{dns_query_with_localdns:net.dns.record[,#{name},A,2,2].diff()}=0 and {dns_query_with_localdns:net.dns.record[,#{name},A,2,2].nodata(5m)}= 0"
+      # 返回计算结果
+      [expression, recovery_expression]
+    end
+  end
+end

data/lib/zabbix/engine.rb

@@ -0,0 +1,11 @@
+module Zabbix
+  class Engine < ::Rails::Engine
+    isolate_namespace Zabbix
+
+    initializer("zabbix-rails", after: :load_config_initializers) do |app|
+      Rails.application.routes.prepend do
+        mount Zabbix::Engine, at: "/zabbix-rails"
+      end
+    end
+  end
+end

data/lib/zabbix/host_monitor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Zabbix
+  module HostMonitor
+    extend ActiveSupport::Concern
+    include ZabbixConnectConcern
+
+    # 创建或更新 zabbix-rails 主机监控对象
+    def refresh_zabbix_host(item)
+      if zabbix_connector.present? && (zabbix_connector.is_a? ZabbixManager)
+        # 查询已关联的 hostid
+        hostid = item[:hostid]
+
+        # 封装数据之前确保设备属组已经存在
+        search_id = zabbix_connector.hosts.get_id(host: item.sn)
+        # 构建 zabbix-rails 监控对象数据结构，创建或者更新数据
+        if hostid.present?
+          if search_id.blank?
+            Rails.logger.warn("监控主机信息发生变化，正在创建监控对象: #{item}.inspect")
+            Zabbix::DeleteMonitor.perform_now(item.sn)
+            zabbix_connector.hosts.create_or_update(item.host_params)
+          elsif hostid != search_id
+            Rails.logger.warn("ZABBIX已有监控项，正在刷新数据 #{hostid} - #{search_id}")
+            search_id
+          else
+            Rails.logger.warn("正在更新监控对象: #{item.sn} - #{item.name}")
+            zabbix_connector.hosts.create_or_update(item.host_params)
+          end
+        else
+          Rails.logger.warn("正在新增监控对象: #{item.sn} - #{item.name}")
+          zabbix_connector.hosts.create_or_update(item.host_params)
+        end
+
+        # 返回监控对象的 host_id
+        Rails.logger.warn("成功执行创建或更新监控主机: #{item.name} #{item.sn}")
+        zabbix_connector.hosts.get_id(host: item.sn).presence || nil
+      else
+        Rails.logger.warn("未获取 ZABBIX_MGMT 对象，无法执行创建或更新监控主机: #{item.name} #{item.sn}")
+        nil
+      end
+    rescue => e
+      Rails.logger.warn("无法执行创建或更新监控主机: #{item.name} #{item.sn} #{e}")
+    end
+  end
+end

data/lib/zabbix/item_trigger.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Zabbix
+  module ItemTrigger
+    include ActiveSupport::Concern
+
+    # 创建或新增触发器，返回触发器ID | 触发器的 DATA_STRUCTURE
+    def refresh_trigger(data)
+      # Rails.logger.debug("打印入参: #{data}")
+      unless data.present?
+        Rails.logger.warn("创建或新增监控触发器异常: 请确保 #{data} 数据完整性")
+        return
+      end
+
+      # 比对记录的数据和数据库查询到的数据是否一致
+      triggerid = data["triggerid"]
+      if triggerid.present?
+        # 比对记录的数据和API查询的数据
+        search_id = zabbix_connector.triggers.get_id(triggerids: triggerid, description: data["description"]).to_i
+
+        if search_id == 0
+          Rails.logger.warn("触发器信息发生变化，正在创建触发器: #{data["description"]}")
+          Zabbix::DeleteTrigger.perform_now(triggerid)
+          zabbix_connector.triggers.create_trigger(data)[0]
+        elsif triggerid != search_id
+          Rails.logger.warn("ZABBIX已有监控项，正在刷新触发器: #{triggerid} - #{data["description"]}")
+          Zabbix::DeleteTrigger.perform_now(triggerid)
+          search_id
+        else
+          Rails.logger.warn("正在刷新触发器: #{triggerid} - #{data["description"]}")
+          zabbix_connector.triggers.update_trigger(triggerid, data)[0]
+        end
+      else
+        Rails.logger.warn("正在创建触发器: #{data["description"]}")
+        zabbix_connector.triggers.create_trigger(data)[0]
+      end
+
+    rescue => e
+      Rails.logger.warn("更新或创建异常: #{e}")
+    end
+
+    # 添加触发器依赖
+    def add_trigger_dependency(triggerid, depend_on_trigger_id)
+      logger.warn("准备添加触发器依赖：#{triggerid} - #{depend_on_trigger_id}")
+      zabbix_connector.triggers.add_trigger_dependency(triggerid, depend_on_trigger_id)
+    rescue => e
+      logger.warn("创建触发器依赖对象期间捕捉异常：#{e}")
+    end
+  end
+end

data/lib/zabbix/railtie.rb

@@ -0,0 +1,4 @@
+module Zabbix
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/zabbix/version.rb

@@ -0,0 +1,3 @@
+module Zabbix
+  VERSION = "0.1.1"
+end

data/lib/zabbix-rails.rb

@@ -0,0 +1,21 @@
+require "zabbix/version"
+require "zabbix/connector"
+require "zabbix/host_monitor"
+require "zabbix/item_trigger"
+require "zabbix/dns_monitor"
+require "zabbix/railtie"
+
+# 加载外部依赖
+require "zabbix_manager"
+
+module Zabbix
+  include ActiveSupport::Concern
+
+  class << self
+    attr_accessor :url, :user, :password, :debug
+
+    def configure(&block)
+      Config.configure(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: zabbix-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- WENWU.YAN
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+description: Description of Zabbix-rails.
+email:
+- careline@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/tasks/zabbix_tasks.rake
+- lib/zabbix-rails.rb
+- lib/zabbix/connector.rb
+- lib/zabbix/dns_monitor.rb
+- lib/zabbix/engine.rb
+- lib/zabbix/host_monitor.rb
+- lib/zabbix/item_trigger.rb
+- lib/zabbix/railtie.rb
+- lib/zabbix/version.rb
+homepage: https://rubygem.org
+licenses: []
+metadata:
+  homepage_uri: https://rubygem.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Summary of Zabbix-rails.
+test_files: []