zabbix_manager 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5788062827f30e986041b5b75fecbc6bee2da108612326d2cbd5d9e7308bc086
-  data.tar.gz: af67f5fcf2a6bfdff721caaa72f23ed16d76c563d7ed6b975af6fb912065ab2c
+  metadata.gz: baddfe1c19c7d70234e9faaf1327b7fb5a440083229dfc417dd2bc3b34ecdf75
+  data.tar.gz: 19e8933f296db4a00f48df300d3684f5c11fdae8f1f4f0921e41a357ade03466
 SHA512:
-  metadata.gz: 8c0872a75da753c7b40ced8f269a413889f94742f876b2bf3868ee541b19fc38d8e8de7f2a5cc9729ef2a74eee0c2231d59dee8d01933b558c3c10578e2acb23
-  data.tar.gz: e647bea7ba69dc30fe7fa4e8cb671739622644ba09bdea4da21c7bd237aca0064c30f8a25e4928c480ad9e270d4dacd28eac13cca934c23890c2a5b31bf03fae
+  metadata.gz: e7992694a2eaf74eb663c254e9143f1b1f054dba270bd856f9fce44466c54540f674e587cf76fc4924e7059acd301b04058ccea5ebbca69f538ef1facbc9e4f7
+  data.tar.gz: 30ff7ca3f862f7db10361f46337a680a47a79fde932efe280ec756167d2b7de83aa7ea35c30229b756d68cd4492ac020ed4f2f7a3a1dbf832d1398a955c825e4

data/lib/zabbix_manager/basic/basic_alias.rb

@@ -0,0 +1,37 @@
+class ZabbixManager
+  class Basic
+    # Get Zabbix object data from API by id
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def get(data)
+      get_full_data(data)
+    end
+
+    # Add new Zabbix object using API create
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def add(data)
+      create(data)
+    end
+
+    # Destroy Zabbix object using API delete
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is deleted
+    # @return [Boolean] True/False if multiple objects are deleted
+    def destroy(data)
+      delete(data)
+    end
+
+    def method_name; end
+  end
+end

data/lib/zabbix_manager/basic/basic_extend.rb

@@ -0,0 +1,38 @@
+class ZabbixManager
+  class Basic
+    # 新增 get_hostgroup_ids 方法，使用列表 flatten 功能拉平属组对象
+    def get_hostgroup_ids(data)
+      result = @client.api_request(
+        method: 'hostgroup.get',
+        params: {
+          output: "extend",
+          filter: {
+            name: [data].flatten
+          }
+        }
+      ).map { |item| { groupid: item['groupid'] } }
+
+      # 检查是是否存在
+      result.empty? ? nil : result.flatten
+    end
+
+    # 新增 get_or_create_hostgroups 方法，查询或创建新的对象
+    def get_or_create_hostgroups(data)
+      [data].flatten.each do |item|
+        # 是否存在设备属组，不存在则新建
+        begin
+          result = get_hostgroup_ids(item)
+          @client.api_request(
+            method: 'hostgroup.create',
+            params: {
+              name: item
+            }
+          ) if result.nil?
+        rescue => e
+          ap e
+        end
+      end
+    end
+
+  end
+end

data/lib/zabbix_manager/basic/basic_func.rb

@@ -0,0 +1,103 @@
+class ZabbixManager
+  class Basic
+    # Log messages to stdout when debugging
+    #
+    # @param message [String]
+    def log(message)
+      puts message.to_s if @client.options[:debug]
+    end
+
+    # Compare two hashes for equality
+    #
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
+    # @return [Boolean]
+    def hash_equals?(first_hash, second_hash)
+      normalized_first_hash = normalize_hash(first_hash)
+      normalized_second_hash = normalize_hash(second_hash)
+
+      hash1 = normalized_first_hash.merge(normalized_second_hash)
+      hash2 = normalized_second_hash.merge(normalized_first_hash)
+      hash1 == hash2
+    end
+
+    # Convert all hash/array keys to symbols
+    #
+    # @param object [Array, Hash]
+    # @return [Array, Hash]
+    def symbolize_keys(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys(object.delete(key))
+        end
+      end
+      object
+    end
+
+    # Normalize all hash values to strings
+    #
+    # @param hash [Hash]
+    # @return [Hash]
+    def normalize_hash(hash)
+      result = hash.dup
+
+      result.delete(:hostid) # TODO: remove to logig. TemplateID and HostID has different id
+
+      result.each do |key, value|
+        result[key] = value.is_a?(Array) ? normalize_array(value) : value.to_s
+      end
+
+      result
+    end
+
+    # Normalize all array values to strings
+    #
+    # @param array [Array]
+    # @return [Array]
+    def normalize_array(array)
+      result = []
+
+      array.each do |e|
+        if e.is_a?(Array)
+          result.push(normalize_array(e))
+        elsif e.is_a?(Hash)
+          result.push(normalize_hash(e))
+        else
+          result.push(e.to_s)
+        end
+      end
+
+      result
+    end
+
+    # Parse a data hash for id key or boolean to return
+    #
+    # @param data [Hash]
+    # @return [Integer] The object id if a single object hash is provided with key
+    # @return [Boolean] True/False if multiple class object hash is provided
+    def parse_keys(data)
+      case data
+      when Hash
+        data.empty? ? nil : data[keys][0].to_i
+      when TrueClass
+        true
+      when FalseClass
+        false
+      end
+    end
+
+    # Merge two hashes into a single new hash
+    #
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
+    # @return [Hash]
+    def merge_params(first_hash, second_hash)
+      new = first_hash.dup
+      new.merge(second_hash)
+    end
+  end
+end

data/lib/zabbix_manager/basic/basic_init.rb

@@ -0,0 +1,46 @@
+class ZabbixManager
+  class Basic
+    # Initializes a new Basic object with ZabbixManager Client
+    #
+    # @param client [ZabbixManager::Client]
+    # @return [ZabbixManager::Client]
+    def initialize(client)
+      @client = client
+    end
+
+    # Placeholder for inherited objects to provide object-specific method name
+    #
+    # @raise [ManagerError] Basic object does not directly support method_name
+    def method_name
+      raise ManagerError.new("Can't call method_name here")
+    end
+
+    # Placeholder for inherited objects to provide default options
+    #
+    # @return [Hash]
+    def default_options
+      {}
+    end
+
+    # Returns the object's plural id field name (identify) based on key
+    #
+    # @return [String]
+    def keys
+      key + 's'
+    end
+
+    # Returns the object's id field name (identify) based on method_name + id
+    #
+    # @return [String]
+    def key
+      method_name + 'id'
+    end
+
+    # Placeholder for inherited objects to provide object-specific id field name
+    #
+    # @raise [ManagerError] Basic object does not directly support identify
+    def identify
+      raise ManagerError.new("Can't call identify here")
+    end
+  end
+end

data/lib/zabbix_manager/basic/basic_logic.rb

@@ -0,0 +1,227 @@
+class ZabbixManager
+  class Basic
+    # Create new Zabbix object using API (with defaults)
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def create(data)
+      log "[DEBUG] Call create with parameters: #{data.inspect}"
+
+      # 判断是否绑定默认选项并重新生成配置
+      data_with_default = default_options.empty? ? data : merge_params(default_options, data)
+      data_create       = [data_with_default]
+
+      # 调用实例方法
+      result = @client.api_request(method: "#{method_name}.create", params: data_create)
+      # 判断是否执行成功并返回结果
+      parse_keys result
+    end
+
+    # Delete Zabbix object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is deleted
+    # @return [Boolean] True/False if multiple objects are deleted
+    def delete(data)
+      log "[DEBUG] Call delete with parameters: #{data.inspect}"
+
+      data_delete = [data]
+      result      = @client.api_request(method: "#{method_name}.delete", params: data_delete)
+      parse_keys result
+    end
+
+    # Create or update Zabbix object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def create_or_update(data)
+      log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
+
+      id = get_id(identify.to_sym => data[identify.to_sym])
+      id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
+    end
+
+    # Update Zabbix object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def update(data, force = false)
+      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      dump = {}
+      dump_by_id(key.to_sym => data[key.to_sym]).each do |item|
+        dump = symbolize_keys(item) if item[key].to_i == data[key.to_sym].to_i
+      end
+      if hash_equals?(dump, data) && !force
+        log "[DEBUG] Equal keys #{dump} and #{data}, skip update"
+        data[key.to_sym].to_i
+      else
+        data_update = [data]
+        result      = @client.api_request(method: "#{method_name}.update", params: data_update)
+        parse_keys result
+      end
+    end
+
+    # mojo_update 请求补丁函数
+    def mojo_update(method, data)
+      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      @client.api_request(method: method, params: data)
+    end
+
+    # MOJO_UPDATE
+
+    # Get full/extended Zabbix object data from API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def get_full_data(data)
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get raw Zabbix object data from API
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def get_raw(data)
+      log "[DEBUG] Call get_raw with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: data
+      )
+    end
+
+    # Dump Zabbix object data by key from API
+    #
+    # @param data [Hash] Should include desired object's key and value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def dump_by_id(data)
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
+          },
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get full/extended Zabbix data for all objects of type/class from API
+    #
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Array<Hash>] Array of matching objects
+    def all
+      result = {}
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: { output: 'extend' }
+      ).each do |item|
+        result[item[identify]] = item[key]
+      end
+      result
+    end
+
+    # Get Zabbix object id from API based on provided data
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_id(data)
+      log "[DEBUG] Call get_id with parameters: #{data.inspect}"
+
+      # symbolize keys if the user used string keys instead of symbols
+      data = symbolize_keys(data) if data.key?(identify)
+      # raise an error if identify name was not supplied
+      name = data[identify.to_sym]
+      raise ManagerError.new("#{identify} not supplied in call to get_id") if name.nil?
+
+      result = @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: data,
+          output: [key, identify]
+        }
+      )
+      id     = nil
+      result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
+      id
+    end
+
+    # Get or Create Zabbix object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(identify.to_sym => data[identify.to_sym]))
+        id = create(data)
+      end
+      id
+    end
+
+    # 根据数据自动创建
+    def create_raw(data)
+      log "[DEBUG] Call create_raw with parameters: #{data.inspect}"
+      # 请求创建数据
+      @client.api_request(
+        method: "#{method_name}.create",
+        params: data
+      )
+    end
+
+    # 根据数据自动更新数据
+    def update_raw(data)
+      log "[DEBUG] Call update_raw with parameters: #{data.inspect}"
+      # 请求创建数据
+      @client.api_request(
+        method: "#{method_name}.update",
+        params: data
+      )
+    end
+
+    # 根据数据自动删除数据
+    def delete_raw(data)
+      log "[DEBUG] Call delete_raw with parameters: #{data.inspect}"
+      # 请求创建数据
+      @client.api_request(
+        method: "#{method_name}.delete",
+        params: data
+      )
+    end
+  end
+end

data/lib/zabbix_manager/classes/actions.rb

@@ -0,0 +1,41 @@
+class ZabbixManager
+  class Actions < Basic
+    # The method name used for interacting with Actions via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'action'
+    end
+
+    # The id field name used for identifying specific Action objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Get full/extended Action object data from API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def get_full_data(data)
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend',
+          selectOperations: "extend",
+          selectRecoveryOperations: "extend",
+          selectAcknowledgeOperations: "extend",
+          selectFilter: "extend",
+        }
+      )
+    end
+  end
+end

data/lib/zabbix_manager/classes/applications.rb

@@ -0,0 +1,43 @@
+class ZabbixManager
+  class Applications < Basic
+    # The method name used for interacting with Applications via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'application'
+    end
+
+    # The id field name used for identifying specific Application objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Get or Create Application object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Applications via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(name: data[:name], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Application object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Applications via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def create_or_update(data)
+      applicationid = get_id(name: data[:name], hostid: data[:hostid])
+      applicationid ? update(data.merge(applicationid: applicationid)) : create(data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/configurations.rb

@@ -0,0 +1,42 @@
+class ZabbixManager
+  class Configurations < Basic
+    # @return [Boolean]
+    def array_flag
+      true
+    end
+
+    # The method name used for interacting with Configurations via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'configuration'
+    end
+
+    # The id field name used for identifying specific Configuration objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'host'
+    end
+
+    # Export configuration data using Zabbix API
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def export(data)
+      @client.api_request(method: 'configuration.export', params: data)
+    end
+
+    # Import configuration data using Zabbix API
+    #
+    # @param data [Hash]
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Hash]
+    def import(data)
+      @client.api_request(method: 'configuration.import', params: data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/drules.rb

@@ -0,0 +1,55 @@
+class ZabbixManager
+  class Drules < Basic
+    # The method name used for interacting with Drules via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'drule'
+    end
+
+    # The id field name used for identifying specific Drule objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating Drule objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        name: nil,
+        iprange: nil,
+        delay: 3600,
+        status: 0,
+      }
+    end
+
+    # Get or Create Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drule via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(name: data[:name]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drules via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def create_or_update(data)
+      druleid = get_id(name: data[:name])
+      druleid ? update(data.merge(druleid: druleid)) : create(data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/errors.rb

@@ -0,0 +1,28 @@
+class ZabbixManager
+  class BaseError < RuntimeError
+    attr_accessor :response, :error, :error_message
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+
+      set_error! if @response
+    end
+
+  private
+
+    def set_error!
+      @error = @response['error']
+      @error_message = "#{@error['message']}: #{@error['data']}"
+    rescue StandardError
+      @error = nil
+      @error_message = nil
+    end
+  end
+
+  class ManagerError < BaseError
+  end
+
+  class HttpError < BaseError
+  end
+end