zabbix-rails 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72e0a2099b3dd87de6d9a38ec3514bc2e8f6fa7720804a202457a278af39987
-  data.tar.gz: d92f35f0c3497663edc9f50f5a6fbf4815bde298fb50fd2eb2921ffa367077ed
+  metadata.gz: d477e8482d7b336bc91a086a5b17d4623e4e6ecc3cc6e9ef86fc523fa57c97cb
+  data.tar.gz: 20ca6fb13b28defc342218df40a2a69d1b87b6a898bced5239935158659f527f
 SHA512:
-  metadata.gz: 239955a4196412900aad1f05e4b455274355960d3643ef1fc6572f16b16b158f7ec7b856aa069046c857774c284eaf7ef9d2b6a8f60e9727b2a4bbef1dd674c9
-  data.tar.gz: 6d3b8303de360e70c3c590faa7ed39b3b22fab9a198fd552dbe150ebf5a4a4eec090110c8b199db4c16409d54ffdbd7d143aebb4d1e372ae671435e4621b856e
+  metadata.gz: e0b5ad8ce0ca98cbde47f8d3c745c400644853e8bbc4ce4f8151991da97cd3ce92f4aab0a370674dae50b78f7dd0dc003d1d1f386410d4e82620a0b16a2290b1
+  data.tar.gz: 85a9134058479f03dd307caab468070c55d793a97efae018a0b919cca5f7de119ec97e2b6eddd623b923027e2a92f175ed6dfd85426b73ab37879c317a5d275a

data/README.md

@@ -1,13 +1,16 @@
 # Zabbix-Rails
+
 主要实现 zabbix_connector 对象缓存，加速 API 交互效率。 依赖 zabbix_manager 作为后端请求模块
 
 ## Usage
+
 ```
 1、include Zabbix::Connector 到模块或者类对象；
 2、调用 zabbix_connector 方法自动实现后端鉴权，当前前提是配置好 'zabbix_rails.rb in config/initializers'
-3、调用 Zabbix::HostMonitor 实现自动维护监控对象
-4、调用 Zabbix::ItemTrigger 实现自动维护触发器对象
+3、调用 Zabbix::HostMonitor 实现自动维护监控对象，需要自行实现 [Zabbix::DeleteMonitor] 的JOB 消息队列函数；
+4、调用 Zabbix::ItemTrigger 实现自动维护触发器对象，需要自行实现 [Zabbix::DeleteTrigger] 的JOB 消息队列函数；
 5、调用 Zabbix::Dns 实现自动维护 DNS 监控
+6、调用 Zabbix::Chart 实现自动登录 zabbix 下载 item 的监控快照图片，同时兼容 V5 和 V6 版本，下载路径在 app/assets/images/chart;
 ```
 
 ## Installation
@@ -32,13 +35,19 @@ $ gem install zabbix-rails
 
 add zabbix_rails.rb in config/initializers
 
+```ruby
+Zabbix.configure do |config|
+  config.url      = Rails.application.credentials.zabbix.url
+  config.user     = Rails.application.credentials.zabbix.username
+  config.password = Rails.application.credentials.zabbix.password
+  config.debug    = false
+end
 ```
-# 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
+
+下载 zabbix item 图片范例：
+```ruby
+include Zabbix::Chart
+save_chart_graph 37932
 ```
 
 ## Contributing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 
 require "bundler/gem_tasks"

data/lib/zabbix/chart.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 
 module Zabbix
-  extend ActiveSupport::Concern
-
   module Chart
+    extend ActiveSupport::Concern
+    include Zabbix::Connector
+
     # 请求生成 graph_chart 对象
     def graph_chart(graphid, height = 400, width = 900, start_at = "now-6h", end_at = "now")
       # 构造数据结构
@@ -34,10 +37,13 @@ module Zabbix
 
     # 请求后端返回图形
     def _item_chart(url = "/chart.php", data)
+      base_url = Zabbix.url
+      host     = URI(base_url).host
+      conn     = Faraday::Connection.new(base_url)
       # 请求接口
-      @conn.get "#{url}" do |r|
+      conn.get(url) do |r|
         r.params.merge!(data)
-        r.headers["Host"]   = Config.url.gsub!(%r{http(s)?://}, "")
+        r.headers["Host"]   = host
         r.headers["Accept"] = "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9"
         r.headers["Cookie"] = zabbix_token
       end.body
@@ -47,23 +53,27 @@ module Zabbix
     def save_chart_graph(itemid, height = 400, width = 900, start_at = "now-6h", end_at = "now")
       filename = generate_name(itemid)
       save_file(filename, item_chart(itemid, height, width, start_at, end_at))
-      "chart/#{File.basename(filename)}"
     end
 
     # 保存图片
     def save_file(filename, content)
+      directory_base = "app/assets/images/chart/"
+
       # 生成绝对路径地址
-      filename.prepend("app/assets/images/chart/")
+      FileUtils.mkdir_p("#{Rails.root}/#{directory_base}") unless Dir.exist?("#{Rails.root}/#{directory_base}")
+      filename.prepend(directory_base)
 
       # 存储数据
       File.open(filename, "wb") do |chart|
         chart.write(content)
       end
+
+      "#{Rails.root}/#{filename}"
     end
 
+    # 生成随机名称
     def generate_name(itemid)
-      require "uuidtools"
-      "#{UUIDTools::UUID.timestamp_create}-#{itemid}.png"
+      "#{SecureRandom.hex(8)}-#{itemid}.png"
     end
   end
 end

data/lib/zabbix/connector.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
+require "faraday"
 
 module Zabbix
-  extend ::ActiveSupport::Concern
-
   module Connector
+    extend ::ActiveSupport::Concern
+
     # 开发测试环境需要单独开启缓存功能：bin/rails dev:cache
     # 将鉴权后的 zabbix-rails 对象缓存到 Rails，减少不必要的认证动作加速执行
     # https://guides.rubyonrails.org/caching_with_rails.html
     def zabbix_connector
-      Rails.cache.fetch("zabbix_connector", expires_in: 2.hours) do
+      Rails.cache.fetch("zabbix_connector", expires_in: 30.minutes) do
         Rails.logger.warn("Zabbix 正在请求 API 鉴权")
-        ZabbixManager.connect(url: Config.url, user: Config.user, password: Config.password, debug: Config.debug)
+        ZabbixManager.connect(url: Zabbix.url, user: Zabbix.user, password: Zabbix.password, debug: Zabbix.debug)
       rescue => e
         Rails.logger.warn("登录 ZABBIX 异常，请检查网络或登录凭证。原始报错信息: #{e}")
       end
@@ -20,7 +21,7 @@ module Zabbix
 
     # 获取 zabbix 登录凭证缓存
     def zabbix_token
-      Rails.cache.fetch("zabbix_token", expires_in: 2.hours) do
+      Rails.cache.fetch("zabbix_token", expires_in: 30.minutes) do
         Rails.logger.warn("正在请求 zabbix/index.php 登录认证")
         authenticate_with_cookie
       end
@@ -50,28 +51,30 @@ module Zabbix
     rescue => e
       Rails.logger.warn("调用 delete_trigger_monitor 接口异常，原始报错信息: #{e}")
     end
-  end
 
-  # 请求 zabbix 后端认证，返回 Cookie
-  def authenticate_with_cookie
-    # 初始化会话
-    base_url = Config.url
-    @conn    = Faraday::Connection.new(base_url)
+    # 请求 zabbix 后端认证，返回 Cookie
+    def authenticate_with_cookie
+      # 初始化会话
+      base_url = Zabbix.url
+      host     = URI(base_url).host
+      conn     = Faraday::Connection.new(base_url)
 
-    # 登录权限凭证
-    data = {
-      name:      Config.user,
-      password:  Config.password,
-      autologin: 1,
-      enter:     "Sign in",
-    }
+      # 登录权限凭证
+      data = {
+        name:      Zabbix.user,
+        password:  Zabbix.password,
+        autologin: 1,
+        enter:     "Sign in",
+      }
 
-    # 请求认证
-    ret = @conn.post "/index.php" do |r|
-      r.headers["Host"] = base_url.gsub!(%r{http(s)?://}, "")
-      r.body            = data
-    end
+      # 请求认证
+      ret = conn.post("/index.php") do |r|
+        r.headers["Host"] = host
+        r.body            = data
+      end
 
-    ret.headers["set-cookie"].presence || nil
+      # 此处需要特殊处理，否则 V5 版本无法正常加载缓存
+      ret.headers["set-cookie"]&.gsub(/ HttpOnly,?/, "").presence || nil
+    end
   end
 end

data/lib/zabbix/dns_monitor.rb

@@ -3,9 +3,9 @@
 require "active_support/concern"
 
 module Zabbix
-  extend ::ActiveSupport::Concern
-
   module DnsMonitor
+    extend ::ActiveSupport::Concern
+
     include Zabbix::Connector
 
     # 生成 DNS 触发器表达式

data/lib/zabbix/host_monitor.rb

@@ -3,9 +3,9 @@
 require "active_support/concern"
 
 module Zabbix
-  extend ::ActiveSupport::Concern
-
   module HostMonitor
+    extend ::ActiveSupport::Concern
+
     include Zabbix::Connector
 
     # 创建或更新 HostMonitor主机监控对象

data/lib/zabbix/item_trigger.rb

@@ -3,9 +3,9 @@
 require "active_support/concern"
 
 module Zabbix
-  extend ::ActiveSupport::Concern
-
   module ItemTrigger
+    extend ::ActiveSupport::Concern
+
     include Zabbix::Connector
 
     # 创建或新增触发器，返回触发器ID | 触发器的 DATA_STRUCTURE

data/lib/zabbix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zabbix
-  VERSION = "0.2.0"
+  VERSION = "0.2.4"
 end

data/lib/zabbix-rails.rb

@@ -1,11 +1,12 @@
 # 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/chart"
 
 # 加载外部依赖
 require "active_support/concern"
@@ -17,8 +18,8 @@ module Zabbix
   class << self
     attr_accessor :url, :user, :password, :debug
 
-    def configure(&block)
-      Config.configure(&block)
+    def config
+      yield self
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,7 +36,6 @@ files:
 - lib/tasks/zabbix_tasks.rake
 - lib/zabbix-rails.rb
 - lib/zabbix/chart.rb
-- lib/zabbix/config.rb
 - lib/zabbix/connector.rb
 - lib/zabbix/dns_monitor.rb
 - lib/zabbix/engine.rb

data/lib/zabbix/config.rb

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