zabbix_manager 5.1.3 → 5.1.5

data/lib/zabbix_manager/classes/drules.rb

@@ -2,23 +2,17 @@
 
 class ZabbixManager
   class Drules < Basic
-    # The method name used for interacting with Drules via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 Drules 交互的方法名称
     def method_name
       "drule"
     end
 
-    # The id field name used for identifying specific Drule objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 Drule 对象的 id 字段名称
     def identify
       "name"
     end
 
-    # The default options used when creating Drule objects via Zabbix API
-    #
-    # @return [Hash]
+    # 创建 Drule 对象时使用的默认选项
     def default_options
       {
         name:    nil,
@@ -28,14 +22,9 @@ class ZabbixManager
       }
     end
 
-    # Get or Create Drule object using Zabbix API
-    #
-    # @param data [Hash] Needs to include name to properly identify Drule via Zabbix API
-    # @raise [ZbxError] 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
+    # 通过 Zabbix API 获取或创建 Drule 对象
     def get_or_create(data)
-      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 get_or_create，参数为：#{data.inspect}"
 
       unless (id = get_id(name: data[:name]))
         id = create(data)
@@ -43,12 +32,7 @@ class ZabbixManager
       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 [ZbxError] 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, TrueClass, FalseClass] Zabbix object id
+    # 通过 Zabbix API 创建或更新 Drule 对象
     def create_or_update(data)
       druleid = get_id(name: data[:name])
       druleid ? update(data.merge(druleid: druleid)) : create(data)

data/lib/zabbix_manager/classes/errors.rb

@@ -1,29 +1,39 @@
 # frozen_string_literal: true
 
 class ZabbixManager
+  # BaseError 是 ZabbixManager 模块中处理异常的基类
   class BaseError < RuntimeError
-    attr_accessor :response, :error, :error_message
+    # 用于存储响应对象
+    attr_accessor :response
+    # 用于存储 Zabbix API 错误信息
+    attr_accessor :error
+    # 用于存储格式化后的错误消息
+    attr_accessor :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
+
+    # 从响应中提取 Zabbix API 错误信息
+    def set_error!
+      @error = @response["error"]
+      @error_message = "#{@error["message"]}: #{@error["data"]}"
+    rescue StandardError
+      @error = nil
+      @error_message = nil
+    end
   end
 
+  # ZbxError 是 ZabbixManager 模块中处理 Zabbix API 异常的类
   class ZbxError < BaseError
   end
 
+  # HttpError 是 ZabbixManager 模块中处理 HTTP 异常的类
   class HttpError < BaseError
   end
 end

data/lib/zabbix_manager/classes/events.rb

@@ -2,16 +2,12 @@
 
 class ZabbixManager
   class Events < Basic
-    # The method name used for interacting with Events via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 Events 交互的方法名称
     def method_name
       "event"
     end
 
-    # The id field name used for identifying specific Event objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 Event 对象的 id 字段名称
     def identify
       "name"
     end

data/lib/zabbix_manager/classes/graphs.rb

@@ -2,32 +2,22 @@
 
 class ZabbixManager
   class Graphs < Basic
-    # The method name used for interacting with Graphs via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 Graphs 交互的方法名称
     def method_name
       "graph"
     end
 
-    # The id field name used for identifying specific Graph objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 Graph 对象的 id 字段名称
     def identify
       "name"
     end
 
-    # Get full/extended Graph data from Zabbix API
-    #
-    # @param data [Hash] Should include object's id field name (identify) and id value
-    # @raise [ZbxError] 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]
+    # 从 Zabbix API 获取完整/扩展的 Graph 数据
     def get_full_data(data)
-      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+      log "[DEBUG] 使用参数调用 get_full_data: #{data.inspect}"
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: {
+      get_raw(
+        {
           search: {
             identify.to_sym => data[identify.to_sym]
           },
@@ -36,16 +26,10 @@ class ZabbixManager
       )
     end
 
-    # Get Graph ids for Host from Zabbix API
-    #
-    # @param data [Hash] Should include host value to query for matching graphs
-    # @raise [ZbxError] 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] Returns array of Graph ids
+    # 从 Zabbix API 获取主机的 Graph ids
     def get_ids_by_host(data)
-      result = @client.api_request(
-        method: "graph.get",
-        params: {
+      result = get_raw(
+        {
           filter: {
             host: data[:host]
           },
@@ -54,38 +38,28 @@ class ZabbixManager
       )
 
       result.filter_map do |graph|
-        num  = graph["graphid"]
-        name = graph["name"]
-        filter = data[:filter]
+        graphid = graph["graphid"]
+        name    = graph["name"]
+        filter  = data[:filter]
 
-        num if filter.nil? || /#{filter}/ =~ name
+        graphid if filter.nil? || name.match?(/#{filter}/)
       end
     end
 
-    # Get Graph Item object using Zabbix API
-    #
-    # @param data [Hash] Needs to include graphids to properly identify Graph Items via Zabbix API
-    # @raise [ZbxError] 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]
+    # 通过 Zabbix API 获取 Graph Item 对象
     def get_items(data)
       @client.api_request(
         method: "graphitem.get",
         params: {
           graphids: [data],
-          output: "extend"
+          output:   "extend"
         }
       )
     end
 
-    # Get or Create Graph object using Zabbix API
-    #
-    # @param data [Hash] Needs to include name and templateid to properly identify Graphs via Zabbix API
-    # @raise [ZbxError] 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
+    # 通过 Zabbix API 获取或创建 Graph 对象
     def get_or_create(data)
-      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+      log "[DEBUG] 使用参数调用 get_or_create: #{data.inspect}"
 
       unless (id = get_id(name: data[:name], templateid: data[:templateid]))
         id = create(data)
@@ -94,12 +68,7 @@ class ZabbixManager
       id
     end
 
-    # Create or update Graph object using Zabbix API
-    #
-    # @param data [Hash] Needs to include name and templateid to properly identify Graphs via Zabbix API
-    # @raise [ZbxError] 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, TrueClass, FalseClass] Zabbix object id
+    # 通过 Zabbix API 创建或更新 Graph 对象
     def create_or_update(data)
       graphid = get_id(name: data[:name], templateid: data[:templateid])
       graphid ? _update(data.merge(graphid: graphid)) : create(data)

data/lib/zabbix_manager/classes/hostgroups.rb

@@ -2,23 +2,17 @@
 
 class ZabbixManager
   class HostGroups < Basic
-    # The method name used for interacting with HostGroups via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 HostGroups 交互的方法名称
     def method_name
       "hostgroup"
     end
 
-    # The id field name used for identifying specific HostGroup objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 HostGroup 对象的 id 字段名称
     def identify
       "name"
     end
 
-    # The key field name used for HostGroup objects via Zabbix API
-    #
-    # @return [String]
+    # HostGroup 对象通过 Zabbix API 使用的 key 字段名称
     def key
       "groupid"
     end

data/lib/zabbix_manager/classes/hostinterfaces.rb

@@ -2,35 +2,27 @@
 
 class ZabbixManager
   class HostInterfaces < Basic
-    # The method name used for interacting with HostInterfaces via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 HostInterfaces 交互的方法名称
     def method_name
       "hostinterface"
     end
 
-    # The id field name used for identifying specific HostInterface objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 HostInterface 对象的 id 字段名称
     def identify
       "hostids"
     end
 
-    # The key field name used for HostInterface objects via Zabbix API
-    #
-    # @return [String]
+    # HostInterface 对象通过 Zabbix API 使用的 key 字段名称
     def key
       "interfaceid"
     end
 
-    # Get Zabbix interface id from API based on provided hostid
+    # 通过 Zabbix API 基于提供的 hostid 获取 Zabbix interface 的 id
     # @note 基于 hostid 查询关联的 Interfaceid
-    # @param hostid [Integer, String]
-    # @raise [ZbxError] 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, NilClass] Zabbix object id
     def get_interfaceid(hostid)
-      result = get_raw({ output: key, "#{identify}": hostid })
+      result = get_raw({ output: key, identify.to_sym => hostid })
+
+      # 如果查询结果不为空，且第一个元素不为空，则继续获取 {interfaceid} 并转换为整数
       result&.[](0)&.[](key)&.to_i
     end
   end

data/lib/zabbix_manager/classes/hosts.rb

@@ -2,44 +2,17 @@
 
 class ZabbixManager
   class Hosts < Basic
-    # The method name used for interacting with Hosts via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的主机方法名称
     def method_name
       "host"
     end
 
-    # The id field name used for identifying specific Host objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定主机对象的 id 字段名称
     def identify
       "host"
     end
 
-    # Dump Host object data by key from Zabbix API
-    #
-    # @param data [Hash] Should include desired object's key and value
-    # @raise [ZbxError] 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: "host.get",
-        params: {
-          filter:      {
-            key.to_sym => data[key.to_sym]
-          },
-          output:      "extend",
-          selectHosts: "shorten"
-        }
-      )
-    end
-
-    # The default options used when creating Host objects via Zabbix API
-    # @note Create Host 缺省的配置参数
-    # @return [Hash]
+    # 在通过 Zabbix API 创建主机对象时使用的默认选项
     def default_options
       {
         host:           nil,
@@ -63,76 +36,88 @@ class ZabbixManager
       }
     end
 
-    # Unlink/Remove Templates from Hosts using Zabbix API
-    #
-    # @param data [Hash] Should include hosts_id array and templates_id array
-    # @raise [ZbxError] 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 [Boolean]
-    def unlink_templates(data)
-      result = @client.api_request(
-        method: "host.massRemove",
-        params: {
-          hostids:   data[:hosts_id],
-          templates: data[:templates_id]
-        }
+    # 通过 Zabbix API 从指定的 key 值获取主机对象数据
+    def dump_by_id(data)
+      log "[DEBUG] 调用 dump_by_id 方法，参数: #{data.inspect}"
+
+      get_raw({
+                filter:      {
+                  key.to_sym => data[key.to_sym]
+                },
+                output:      "extend",
+                selectHosts: "shorten"
+              }
       )
-      result.empty? ? false : true
     end
 
-    # Get Zabbix object ID by name using Zabbix API
-    # @note 基于监控对象索引键(#{identify})查询 #{key}
-    # @param data [String, Array] Needs to include host to properly identify Zabbix Objects via Zabbix API
-    # @raise [ZbxError] 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, NilClass] Zabbix object id
+    # 通过 Zabbix API 根据名称获取 Zabbix 对象的 ID
     def get_ids_by_name(data)
-      log "[DEBUG] Call #{method_name}.get_ids_by_name with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 #{method_name}.get_ids_by_name 方法，参数: #{data.inspect}"
 
-      result = get_raw(
-        {
-          filter: { name: [data].flatten },
-          output: ["#{key}"]
-        }
+      result = get_raw({
+                         filter: { name: [data].flatten },
+                         output: [key]
+                       }
       )
-      result.empty? ? nil : result.map { |i| { "#{key}": i[key] } }
+      result.empty? ? nil : result.map { |i| { key.to_sym => i[key] } }
     end
 
-    # Create or update Zabbix object using API
-    # @note 创建或更新 Host 监控对象，入参为基于符号的哈希对象，返回监控对象 id
-    # @note 重写基类方法 create_or_update，特殊处理 interfaces 对象
-    # @param data [Hash] Should include object's id field name (identify) and id value
-    # @raise [ZbxError] 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
+    # 使用 Zabbix API 创建或更新 Zabbix 对象
     def create_or_update(data)
-      log "[DEBUG] Call #{method_name}.create_or_update with parameters: #{data.inspect}"
+      # 输出调试日志，显示方法调用和参数信息
+      log "[DEBUG] 调用 #{method_name}.create_or_update 方法，参数: #{data.inspect}"
 
+      # 获取 Zabbix 对象的 ID
       hostid = get_id(identify.to_sym => data[identify.to_sym])
+      # 如果不存在对应的对象ID，则创建新对象
       return create(data) unless hostid
 
+      # 获取对象的接口 ID
       interface_id = get_interfaceid(hostid)
-      raise ZbxError, "interfaceid not found in call to get_interfaceid" unless interface_id
+      # 如果接口 ID 不存在，抛出异常
+      raise ZbxError, "#{data.inspect} get_interfaceid 查无记录" unless interface_id
+
+      # 复制数据以避免修改原始数据
+      dump_data = data.dup
 
-      interfaces = data.delete(:interfaces)&.merge(interfaceid: interface_id)
-      params     = data.merge(interfaces: interfaces).merge(key.to_sym => hostid.to_s)
+      # 从数据中提取并删除 interfaces，并合并接口 ID
+      interfaces = dump_data.delete(:interfaces)&.merge(interfaceid: interface_id)
+
+      # 构建参数，包括 interfaces 和 Zabbix 对象的键值对
+      params = dump_data.merge(interfaces: interfaces).merge(key.to_sym => hostid.to_s)
+
+      # 更新对象
       update(params)
     end
 
-    # Get Zabbix interface id from API based on provided hostid
-    # @note 基于 hostid 查询关联的 Interfaceid
-    # @param hostid [Integer, String]
-    # @raise [ZbxError] 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, NilClass] Zabbix object id
+    # 从 API 中基于提供的 hostid 获取 Zabbix interface 的 id
     def get_interfaceid(hostid)
+      log "[DEBUG] 调用 #{method_name}.get_interfaceid 方法，参数: #{hostid.inspect}"
+
       result = @client.api_request(
         method: "hostinterface.get",
         params: { output: "interfaceid", hostids: hostid }
       )
-      result&.[](0)&.[]("interfaceid")&.to_i
+
+      # 使用 dig 方法获取深层嵌套的值
+      interface_id = result&.dig(0, "interfaceid")&.to_i
+
+      # 如果获取接口 ID 失败，提供更具体的错误信息
+      raise ZbxError, "无法获取 #{hostid} 的接口 ID" if interface_id.nil?
+
+      interface_id
+    end
+
+    # 在 Hosts 中使用 Zabbix API 取消关联/移除模板
+    def unlink_templates(data)
+      result = @client.api_request(
+        method: "host.massRemove",
+        params: {
+          hostids:   data[:hosts_id],
+          templates: data[:templates_id]
+        }
+      )
+      result.empty? ? false : true
     end
   end
 end
-

data/lib/zabbix_manager/classes/httptests.rb

@@ -2,39 +2,28 @@
 
 class ZabbixManager
   class HttpTests < Basic
-    # The method name used for interacting with HttpTests via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 与 HttpTests 交互的方法名称
     def method_name
       "httptest"
     end
 
-    # The id field name used for identifying specific HttpTest objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定 HttpTest 对象的 id 字段名称
     def identify
       "name"
     end
 
-    # The default options used when creating HttpTest objects via Zabbix API
-    #
-    # @return [Hash]
+    # 通过 Zabbix API 创建 HttpTest 对象时使用的默认选项
     def default_options
       {
         hostid: nil,
-        name: nil,
-        steps: []
+        name:   nil,
+        steps:  []
       }
     end
 
-    # Get or Create HttpTest object using Zabbix API
-    #
-    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests via Zabbix API
-    # @raise [ZbxError] 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
+    # 通过 Zabbix API 获取或创建 HttpTest 对象
     def get_or_create(data)
-      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+      log "[DEBUG] 使用参数调用 get_or_create: #{data.inspect}"
 
       unless (id = get_id(name: data[:name], hostid: data[:hostid]))
         id = create(data)
@@ -42,12 +31,7 @@ class ZabbixManager
       id
     end
 
-    # Create or update HttpTest object using Zabbix API
-    #
-    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests via Zabbix API
-    # @raise [ZbxError] 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, TrueClass, FalseClass] Zabbix object id
+    # 通过 Zabbix API 创建或更新 HttpTest 对象
     def create_or_update(data)
       httptestid = get_id(name: data[:name], hostid: data[:hostid])
       httptestid ? update(data.merge(httptestid: httptestid)) : create(data)