zabbix-rails 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 473ef7cc7bbe32ffacd45ff386a02bdd239f6986a6cac0b5ce46197ad6f9d48c
-  data.tar.gz: 53283376f84df42a8d2801177ef66d7d4af06fda72d0614e74af7ae0f935937c
+  metadata.gz: 57a01f1a90fa92149ff18d714662c27729794976268f1d8b74beb0a2e9acaba5
+  data.tar.gz: 7331a58248988f77994103d9be4dd5e0d33f65c2a8319e48549ac988b08a6ce7
 SHA512:
-  metadata.gz: 8829c2d957801e949914a38b5028341e78c0e8e6a67811658eef126b9aaf44fb4d79daad85ebdd507d86b72fb9c6a894dcd62bfcb69f588bc883c0d209d2efe2
-  data.tar.gz: 56139e405343d7541c0d01af8d963322554b9716fccf6dbc59f62739fad2972061eb170e9c23f389c0823839d9c7605e65d41d0b8b30bfbd2aba1ccf8d3b207e
+  metadata.gz: 9b7cce1c75bc1dcc16206d522bef8b96975f242ad68cbb272ac4fd06144436eec293a27f21539d89dc08cca9b7fc2c784dea3a44dce2005b8bcedead0f730c8c
+  data.tar.gz: 0a9eaf9aea738353c907607b36a90df624e12b14272adde4b50569d78b188410929b30d63373beb5a28854edfa3f766a23ffafefacc90f6b44a498c80c503d44

data/README.md

@@ -1,10 +1,17 @@
-# Zabbix
-Short description and motivation.
+# Zabbix-Rails
+主要实现 zabbix_connector 对象缓存，加速 API 交互效率。 依赖 zabbix_manager 作为后端请求模块
 
 ## Usage
-How to use my plugin.
+```
+1、include Zabbix::Connector 到模块或者类对象；
+2、调用 zabbix_connector 方法自动实现后端鉴权，当前前提是配置好 'zabbix_rails.rb in config/initializers'
+3、调用 Zabbix::HostMonitor 实现自动维护监控对象
+4、调用 Zabbix::ItemTrigger 实现自动维护触发器对象
+5、调用 Zabbix::Dns 实现自动维护 DNS 监控
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +19,30 @@ gem "zabbix-rails"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install zabbix-rails
 ```
 
+add zabbix_rails.rb in config/initializers
+
+```
+# Zabbix.configure do |config|
+# c.url      = Rails.application.credentials.zabbix.url
+# c.user     = Rails.application.credentials.zabbix.username
+# c.password = Rails.application.credentials.zabbix.password
+# c.debug    = false
+# end
+```
+
 ## 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/lib/tasks/zabbix_tasks.rake

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

data/lib/zabbix/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Zabbix
+  class Config
+    class << self
+      attr_accessor :url, :user, :password, :debug
+
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/zabbix/connector.rb

@@ -1,21 +1,18 @@
+# frozen_string_literal: true
 
 require "active_support/concern"
 
 module Zabbix
-  module Connector
-    extend ActiveSupport::Concern
+  extend ::ActiveSupport::Concern
 
+  module Connector
     # 开发测试环境需要单独开启缓存功能：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)
+        ZabbixManager.connect(url: Config.url, user: Config.user, password: Config.password, debug: Config.debug)
       rescue => e
         Rails.logger.warn("登录 ZABBIX 异常，请检查网络或登录凭证。原始报错信息: #{e}")
       end

data/lib/zabbix/dns_monitor.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
+  extend ::ActiveSupport::Concern
+
   module DnsMonitor
-    include ActiveSupport::Concern
+    include Zabbix::Connector
 
     # 生成 DNS 触发器表达式
     def dns_trigger_expression(name)

data/lib/zabbix/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zabbix
   class Engine < ::Rails::Engine
     isolate_namespace Zabbix
@@ -8,4 +10,4 @@ module Zabbix
       end
     end
   end
-end
+end

data/lib/zabbix/host_monitor.rb

@@ -1,49 +1,48 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
+  extend ::ActiveSupport::Concern
+
   module HostMonitor
-    extend ActiveSupport::Concern
-    include ZabbixConnectConcern
+    include Zabbix::Connector
 
-    class << self
-      # 创建或更新 zabbix-rails 主机监控对象
-      def refresh_zabbix_host(item)
-        if zabbix_connector.present? && (zabbix_connector.is_a? ZabbixManager)
-          # 查询已关联的 hostid
-          hostid = item[:hostid]
+    # 创建或更新 HostMonitor主机监控对象
+    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
+        # 封装数据之前确保设备属组已经存在
+        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}")
+            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
+          Rails.logger.warn("正在新增监控对象: #{item.sn} - #{item.name}")
+          zabbix_connector.hosts.create_or_update(item.host_params)
         end
-      rescue => e
-        Rails.logger.warn("无法执行创建或更新监控主机: #{item.name} #{item.sn} #{e}")
-      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

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
+  extend ::ActiveSupport::Concern
+
   module ItemTrigger
-    include ActiveSupport::Concern
+    include Zabbix::Connector
 
     # 创建或新增触发器，返回触发器ID | 触发器的 DATA_STRUCTURE
     def refresh_trigger(data)

data/lib/zabbix/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zabbix
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

data/lib/zabbix-rails.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require "zabbix/version"
+require "zabbix/config"
 require "zabbix/connector"
 require "zabbix/host_monitor"
 require "zabbix/item_trigger"
 require "zabbix/dns_monitor"
-require "zabbix/railtie"
-require "active_support/concern"
 
 # 加载外部依赖
+require "active_support/concern"
 require "zabbix_manager"
 
 module Zabbix
-  extend ActiveSupport::Concern
+  extend ::ActiveSupport::Concern
 
   class << self
     attr_accessor :url, :user, :password, :debug

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '0'
 description: Description of Zabbix-rails.
 email:
 - careline@foxmail.com
@@ -35,12 +35,12 @@ files:
 - Rakefile
 - lib/tasks/zabbix_tasks.rake
 - lib/zabbix-rails.rb
+- lib/zabbix/config.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: []

data/lib/zabbix/railtie.rb

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