zabbix-rails 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17c05a667ebfd11b5d4570c766da4a306ec26f4118893b4efdf5c449af2c509
-  data.tar.gz: 0d5bca9ba31c6a87cbbc3e5315ba6e0b7f353e0fbeb85bbdd17fccec76b7319b
+  metadata.gz: d72e0a2099b3dd87de6d9a38ec3514bc2e8f6fa7720804a202457a278af39987
+  data.tar.gz: d92f35f0c3497663edc9f50f5a6fbf4815bde298fb50fd2eb2921ffa367077ed
 SHA512:
-  metadata.gz: a4cbfb30bb0860f289adc7f03105bdf10568f188712cb6f8ad6c84d4ee0620374cab4d4c915999797587051f8aadbb931592461d41b676ba21aba97812f23926
-  data.tar.gz: 53b13efb8a0923e2f4e89641bdf903e58ab5ec8183c2bb7927120ae09120082eaffb1a0e0a05f1eb6c6a3ea7b2bc87a526f69de13f24ad7f9ad914bf3a11e5c2
+  metadata.gz: 239955a4196412900aad1f05e4b455274355960d3643ef1fc6572f16b16b158f7ec7b856aa069046c857774c284eaf7ef9d2b6a8f60e9727b2a4bbef1dd674c9
+  data.tar.gz: 6d3b8303de360e70c3c590faa7ed39b3b22fab9a198fd552dbe150ebf5a4a4eec090110c8b199db4c16409d54ffdbd7d143aebb4d1e372ae671435e4621b856e

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/chart.rb

@@ -0,0 +1,69 @@
+require "active_support/concern"
+
+module Zabbix
+  extend ActiveSupport::Concern
+
+  module Chart
+    # 请求生成 graph_chart 对象
+    def graph_chart(graphid, height = 400, width = 900, start_at = "now-6h", end_at = "now")
+      # 构造数据结构
+      data = {
+        from:    start_at,
+        to:      end_at,
+        graphid: graphid,
+        height:  height,
+        width:   width
+      }
+      # 请求后端返回图片对象
+      _item_chart("/chart2.php", data)
+    end
+
+    # 请求生成 item_chart 对象
+    def item_chart(itemid, height = 400, width = 900, start_at = "now-6h", end_at = "now")
+      # 构造数据结构
+      data = {
+        from:    start_at,
+        to:      end_at,
+        itemids: [itemid.to_i],
+        height:  height,
+        width:   width
+      }
+      # 请求后端返回图片对象
+      _item_chart(data)
+    end
+
+    # 请求后端返回图形
+    def _item_chart(url = "/chart.php", data)
+      # 请求接口
+      @conn.get "#{url}" do |r|
+        r.params.merge!(data)
+        r.headers["Host"]   = Config.url.gsub!(%r{http(s)?://}, "")
+        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
+    end
+
+    # 保存图片并返回文件名
+    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)
+      # 生成绝对路径地址
+      filename.prepend("app/assets/images/chart/")
+
+      # 存储数据
+      File.open(filename, "wb") do |chart|
+        chart.write(content)
+      end
+    end
+
+    def generate_name(itemid)
+      require "uuidtools"
+      "#{UUIDTools::UUID.timestamp_create}-#{itemid}.png"
+    end
+  end
+end

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,3 +1,6 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
 
 module Zabbix
   extend ::ActiveSupport::Concern
@@ -7,18 +10,22 @@ module Zabbix
     # 将鉴权后的 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.cache.fetch("zabbix_connector", expires_in: 2.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
     end
 
+    # 获取 zabbix 登录凭证缓存
+    def zabbix_token
+      Rails.cache.fetch("zabbix_token", expires_in: 2.hours) do
+        Rails.logger.warn("正在请求 zabbix/index.php 登录认证")
+        authenticate_with_cookie
+      end
+    end
+
     # 删除主机监控
     def delete_host_monitor(name)
       id = zabbix_connector.hosts.get_host_id(name)
@@ -44,4 +51,27 @@ module Zabbix
       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)
+
+    # 登录权限凭证
+    data = {
+      name:      Config.user,
+      password:  Config.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.headers["set-cookie"].presence || nil
+  end
 end

data/lib/zabbix/dns_monitor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
   extend ::ActiveSupport::Concern
 

data/lib/zabbix/engine.rb

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

data/lib/zabbix/host_monitor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
   extend ::ActiveSupport::Concern
 
@@ -42,6 +44,5 @@ module Zabbix
     rescue => e
       Rails.logger.warn("无法执行创建或更新监控主机: #{item.name} #{item.sn} #{e}")
     end
-
   end
 end

data/lib/zabbix/item_trigger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/concern"
+
 module Zabbix
   extend ::ActiveSupport::Concern
 

data/lib/zabbix/version.rb

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

data/lib/zabbix-rails.rb

@@ -1,11 +1,14 @@
+# 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 "zabbix_manager"
 
 module Zabbix

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbix-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - WENWU.YAN
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of Zabbix-rails.
+description: 借助 zabbix_manager 实现自动维护 zabbix 监控对象
 email:
 - careline@foxmail.com
 executables: []
@@ -35,17 +35,20 @@ files:
 - Rakefile
 - 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
 - lib/zabbix/host_monitor.rb
 - lib/zabbix/item_trigger.rb
-- lib/zabbix/railtie.rb
 - lib/zabbix/version.rb
-homepage: https://rubygem.org
+homepage: https://github.com/ciscolive/zabbix-rails
 licenses: []
 metadata:
-  homepage_uri: https://rubygem.org
+  homepage_uri: https://github.com/ciscolive/zabbix-rails
+  source_code_uri: https://github.com/ciscolive/zabbix-rails
+  changelog_uri: https://github.com/ciscolive/zabbix-rails/blob/main/README.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -64,5 +67,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: Summary of Zabbix-rails.
+summary: 主要实现 zabbix_connector 对象缓存，加速 API 交互效率
 test_files: []

data/lib/zabbix/railtie.rb

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