zabbix-rails 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a35e9d3bc2ccbf034fa95b86940f7b9ce66b9d8fd3317ff98b3f002976f8b8e3
-  data.tar.gz: 802e68ec3f3284fbb86161fdfc5c426a34fba94469d35e1690ec8ff6427bea86
+  metadata.gz: 83d29ce8108e3a961a912b374df2183d87ca82c3bc32a7740ac1776918fd1714
+  data.tar.gz: c95b0c117cbf172ea55798bcc49a0dec2459957a4c0060543fa0862d5ea7cd60
 SHA512:
-  metadata.gz: 198fade3a060207b1c2e401640d796c1e1e6985bc21dbccba8c716f066874bdfe4f5302e33faf45bd1c74354597e70d8870872e54abc761cf58d24649c9ba1ee
-  data.tar.gz: 02e31303134e3afd75f87e5c409371e948f7db3d15401d21b519b248bde323ddc77d700b0e2d8d3e666768bccbdca88c3e5817e189bd8ea3ef62502f7fcdfb8f
+  metadata.gz: 20370a5a28d224ab5de353f00b0ab5ed41df9392f248d446f0eeb9767dfb00b248927752b1ad4108ecab89817da74e89561450d3358beb3a268145b14527d302
+  data.tar.gz: 3198490f86bcfca1976932222c48b188751879104202752479146c9591dd3036f5dc03e9241127f6acad551ad373b19317980b6e74c12482defc13f3f714c825

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 
 module Zabbix
@@ -35,11 +37,11 @@ module Zabbix
 
     # 请求后端返回图形
     def _item_chart(url = "/chart.php", data)
-      base_url = Config.url
+      base_url = Zabbix.url
       host     = URI(base_url).host
-      conn = Faraday::Connection.new(base_url)
+      conn     = Faraday::Connection.new(base_url)
       # 请求接口
-      conn.get "#{url}" do |r|
+      conn.get(url) do |r|
         r.params.merge!(data)
         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"
@@ -51,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

@@ -11,9 +11,9 @@ module Zabbix
     # 将鉴权后的 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
@@ -21,7 +21,7 @@ module Zabbix
 
     # 获取 zabbix 登录凭证缓存
     def zabbix_token
-      Rails.cache.fetch("zabbix_token", expires_in: 1.hours) do
+      Rails.cache.fetch("zabbix_token", expires_in: 30.minutes) do
         Rails.logger.warn("正在请求 zabbix/index.php 登录认证")
         authenticate_with_cookie
       end
@@ -55,25 +55,26 @@ module Zabbix
     # 请求 zabbix 后端认证，返回 Cookie
     def authenticate_with_cookie
       # 初始化会话
-      base_url = Config.url
+      base_url = Zabbix.url
       host     = URI(base_url).host
       conn     = Faraday::Connection.new(base_url)
 
       # 登录权限凭证
       data = {
-        name:      Config.user,
-        password:  Config.password,
+        name:      Zabbix.user,
+        password:  Zabbix.password,
         autologin: 1,
         enter:     "Sign in",
       }
 
       # 请求认证
-      ret = conn.post "/index.php" do |r|
+      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/host_monitor.rb

@@ -15,6 +15,9 @@ module Zabbix
         hostid = item[:hostid]
 
         # 封装数据之前确保设备属组已经存在
+        zabbix_connector.hostgroups.get_or_create_hostgroups(item.group) if item.group.present?
+
+        # 检查是否已存在监控对象
         search_id = zabbix_connector.hosts.get_id(host: item.sn)
         # 构建 zabbix-rails 监控对象数据结构，创建或者更新数据
         if hostid.present?

data/lib/zabbix/version.rb

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

data/lib/zabbix-rails.rb

@@ -2,12 +2,11 @@
 
 # 注意加载顺序
 require "zabbix/version"
-require "zabbix/config"
 require "zabbix/connector"
-require "zabbix/chart"
 require "zabbix/host_monitor"
 require "zabbix/item_trigger"
 require "zabbix/dns_monitor"
+require "zabbix/chart"
 
 # 加载外部依赖
 require "active_support/concern"
@@ -19,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.2
+  version: 0.2.5
 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