zabbix_manager 5.1.3 → 5.1.4

data/lib/zabbix_manager/classes/maintenance.rb

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

data/lib/zabbix_manager/classes/mediatypes.rb

@@ -2,64 +2,45 @@
 
 class ZabbixManager
   class Mediatypes < Basic
-    # The method name used for interacting with MediaTypes via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的媒体类型方法名称
     def method_name
       "mediatype"
     end
 
-    # The id field name used for identifying specific MediaType objects via Zabbix API
-    #
-    # @return [String]
+    # 识别特定媒体类型对象的 id 字段名称
     def identify
       "name"
     end
 
-    # The default options used when creating MediaType objects via Zabbix API
-    #
-    # @return [Hash]
+    # 默认选项，用于通过 Zabbix API 创建媒体类型对象
     def default_options
       {
-        name: "", # Name
-        description: "", # Description
-        type: 0, # 0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
+        name: "", # 媒体类型名称
+        description: "", # 描述
+        type: 0, # 0 - 电子邮件，1 - 外部脚本，2 - 短信，3 - Jabber，100 - EzTexting
         smtp_server: "",
         smtp_helo: "",
-        smtp_email: "", # Email address of Zabbix server
-        exec_path: "",  # Name of external script
-        gsm_modem: "",  # Serial device name of GSM modem
-        username: "", # Jabber user name used by Zabbix server
-        passwd: "" # Jabber password used by Zabbix server
+        smtp_email: "", # Zabbix 服务器的电子邮件地址
+        exec_path: "",  # 外部脚本的名称
+        gsm_modem: "",  # GSM modem 的串口设备名称
+        username: "", # Zabbix 服务器使用的 Jabber 用户名
+        passwd: "" # Zabbix 服务器使用的 Jabber 密码
       }
     end
 
-    # def log(message)
-    #   STDERR.puts
-    #   STDERR.puts message.to_s
-    #   STDERR.puts
-    # end
-
-    # Update MediaType 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 [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
+    # 使用 API 更新媒体类型对象
     def update(data, force = false)
-      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 update 方法，参数: #{data.inspect}"
       if data[key.to_sym].nil?
         data[key.to_sym] = get_id(data)
-        log "[DEBUG] Enriched data with id: #{data.inspect}"
+        log "[DEBUG] 用 ID 丰富数据: #{data.inspect}"
       end
       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"
+        log "[DEBUG] 键 #{dump} 和 #{data} 相等，跳过更新"
         data[key.to_sym].to_i
       else
         data_update = [data]
@@ -68,19 +49,12 @@ class ZabbixManager
       end
     end
 
-    # Get MediaType object id from API based on provided data
-    #
-    # @param data [Hash]
-    # @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 获取媒体类型对象的 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
+      log "[DEBUG] 调用 get_id 方法，参数: #{data.inspect}"
       data = symbolize_keys(data) if data.key?(identify)
-      # raise an error if identify name was not supplied
       name = data[identify.to_sym]
-      raise ZbxError, "#{identify} not supplied in call to get_id, #{data} (#{method_name})" if name.nil?
+      raise ZbxError, "未提供 #{identify} 参数，#{data} (#{method_name})" if name.nil?
 
       result = @client.api_request(
         method: "#{method_name}.get",
@@ -94,15 +68,9 @@ class ZabbixManager
       id
     end
 
-    # Create or update MediaType object using 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 [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}"
+      log "[DEBUG] 调用 create_or_update 方法，参数: #{data.inspect}"
 
       id = get_id(identify.to_sym => data[identify.to_sym])
       id ? update(data.merge(key.to_sym => id.to_s)) : create(data)

data/lib/zabbix_manager/classes/problems.rb

@@ -5,93 +5,65 @@ class ZabbixManager
     require "active_support"
     require "active_support/core_ext/date/calculations"
 
-    # The method name used for interacting with Hosts via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的问题方法名称
     def method_name
       "problem"
     end
 
-    # The id field name used for identifying specific Problem objects via Zabbix API
-    #
-    # @return [String]
+    # 识别特定问题对象的 id 字段名称
     def identify
       "name"
     end
 
-    # Dump Problem 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]
+    # 通过键值对从 Zabbix API 转储问题对象数据
     def dump_by_id(data)
-      log "[DEBUG] Call #{method_name}.dump_by_id with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 #{method_name}.dump_by_id 方法，参数: #{data.inspect}"
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: {
-          filter: {
-            identify.to_sym => data[identify.to_sym]
-          },
-          output: "extend"
-        }
-      )
+      get_raw({
+                filter: {
+                  identify.to_sym => data[identify.to_sym]
+                },
+                output: "extend"
+              })
     end
 
-    # Get full/extended Problem 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 获取完整/扩展的问题数据
     def get_full_data(data)
-      log "[DEBUG] Call #{method_name}.get_full_data with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 #{method_name}.get_full_data 方法，参数: #{data.inspect}"
 
       data = symbolize_keys(data)
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: {
-          filter:                {
-            identify.to_sym => data[identify.to_sym]
-          },
-          eventids:              data[:eventids] || nil,
-          groupids:              data[:groupids] || nil,
-          hostids:               data[:hostids] || nil,
-          objectids:             data[:objectids] || nil,
-          applicationids:        data[:applicationids] || nil,
-          tags:                  data[:tags] || nil,
-          time_from:             data[:time_from] || nil,
-          time_till:             data[:time_till] || nil,
-          eventid_from:          data[:eventid_from] || nil,
-          eventid_till:          data[:eventid_till] || nil,
-          recent:                data[:recent] || false,
-          sortfield:             data[:sortfield] || ["eventid"],
-          sortorder:             data[:sortorder] || "DESC",
-          countOutput:           data[:countOutput] || nil,
-          output:                "extend",
-          selectAcknowledges:    "extend",
-          selectTags:            "extend",
-          selectSuppressionData: "extend"
-        }
-      )
+      get_raw({
+                filter:                {
+                  identify.to_sym => data[identify.to_sym]
+                },
+                eventids:              data[:eventids] || nil,
+                groupids:              data[:groupids] || nil,
+                hostids:               data[:hostids] || nil,
+                objectids:             data[:objectids] || nil,
+                applicationids:        data[:applicationids] || nil,
+                tags:                  data[:tags] || nil,
+                time_from:             data[:time_from] || nil,
+                time_till:             data[:time_till] || nil,
+                eventid_from:          data[:eventid_from] || nil,
+                eventid_till:          data[:eventid_till] || nil,
+                recent:                data[:recent] || false,
+                sortfield:             data[:sortfield] || ["eventid"],
+                sortorder:             data[:sortorder] || "DESC",
+                countOutput:           data[:countOutput] || nil,
+                output:                "extend",
+                selectAcknowledges:    "extend",
+                selectTags:            "extend",
+                selectSuppressionData: "extend"
+              })
     end
 
-    # Get full/extended Zabbix data for Problem objects from 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] Array of matching objects
+    # 获取所有问题对象的完整/扩展 Zabbix 数据
     def all
       get_full_data({})
     end
 
-    # Acknowledged problems according to the given parameters.
-    # @note 自动确认14天前的问题单
-    # @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] Array of matching objects
+    # 根据给定参数自动确认问题
     def ack_problem
       time_from = 90.days.ago.at_beginning_of_day.to_i
       time_till = 7.days.ago.at_beginning_of_day.to_i
@@ -107,7 +79,7 @@ class ZabbixManager
         params: {
           eventids: event_ids,
           action:   2,
-          message:  "本次告警通过 zabbix_api 关闭"
+          message:  "本次告警符合自动刷新规则，已通过接口处理且刷新时间为：#{Time.now}"
         }
       )
       result.empty? ? nil : result.map { |i| { eventids: i["eventids"] } }

data/lib/zabbix_manager/classes/proxies.rb

@@ -2,48 +2,29 @@
 
 class ZabbixManager
   class Proxies < Basic
-    # The method name used for interacting with Proxies via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的代理方法名称
     def method_name
       "proxy"
     end
 
-    # The id field name used for identifying specific Proxy objects via Zabbix API
-    #
-    # @return [String]
+    # 识别特定代理对象的 id 字段名称
     def identify
       "host"
     end
 
-    # Delete Proxy object using Zabbix API
-    #
-    # @param data [Array] Should include array of proxyid's
-    # @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, NilClass] The Proxy object id that was deleted
+    # 使用 Zabbix API 删除代理对象
     def delete(data)
       result = @client.api_request(method: "proxy.delete", params: data)
       result.empty? ? nil : result["proxyids"][0].to_i
     end
 
-    # Check if a Proxy object is readable using Zabbix API
-    #
-    # @param data [Array] Should include array of proxyid's
-    # @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] Returns true if the given proxies are readable
-    def isreadable(data)
+    # 检查代理对象是否可读
+    def is_readable(data)
       @client.api_request(method: "proxy.isreadable", params: data)
     end
 
-    # Check if a Proxy object is writable using Zabbix API
-    #
-    # @param data [Array] Should include array of proxyid's
-    # @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] Returns true if the given proxies are writable
-    def iswritable(data)
+    # 检查代理对象是否可写
+    def is_writable(data)
       @client.api_request(method: "proxy.iswritable", params: data)
     end
   end

data/lib/zabbix_manager/classes/roles.rb

@@ -2,85 +2,51 @@
 
 class ZabbixManager
   class Roles < Basic
-    # The method name used for interacting with Role via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的角色方法名称
     def method_name
       "role"
     end
 
-    # The key field name used for Role objects via Zabbix API
-    #
-    # @return [String]
-    def key
-      "roleid"
-    end
-
-    # The id field name used for identifying specific Role objects via Zabbix API
-    #
-    # @return [String]
+    # 识别特定角色对象的 id 字段名称
     def identify
       "name"
     end
 
-    # Set permissions for usergroup using Zabbix API
-    #
-    # @param data [Hash] Needs to include usrgrpids and hostgroupids along with permissions to set
-    # @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, NilClass] Zabbix object id (usergroup)
+    # 使用 Zabbix API 为用户组设置权限
     def rules(data)
-      rules = data[:rules] || 2
+      rules  = data[:rules] || 2
       result = @client.api_request(
         method: "role.update",
         params: {
           roleid: data[:roleid],
-          rules: data[:hostgroupids].map { |t| { permission: permission, id: t } }
+          rules:  data[:hostgroupids].map { |t| { permission: permission, id: t } }
         }
       )
       result ? result["usrgrpids"][0].to_i : nil
     end
 
-    # Add users to usergroup using Zabbix API
-    #
-    # @deprecated Zabbix has removed massAdd in favor of update.
-    # @param data [Hash] Needs to include userids and usrgrpids to mass add users to groups
-    # @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 (usergroup)
+    # 使用 Zabbix API 将用户添加到用户组
     def add_user(data)
       update_users(data)
     end
 
-    # Dump Role 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]
+    # 从 Zabbix API 中根据指定键和值获取角色对象的数据
     def dump_by_id(data)
-      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+      log "[DEBUG] 调用 dump_by_id 方法，参数: #{data.inspect}"
 
-      @client.api_request(
-        method: "role.get",
-        params: {
-          output: "extend",
+      get_raw(
+        {
+          output:      "extend",
           selectRules: "extend",
-          roleids: data[:id]
+          roleids:     data[:id]
         }
       )
     end
 
-    # Get Role ids by Role Name 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 获取角色 id
     def get_ids_by_name(data)
-      result = @client.api_request(
-        method: "role.get",
-        params: {
+      result = get_raw(
+        {
           filter: {
             name: data[:name]
           },
@@ -93,20 +59,15 @@ class ZabbixManager
       end
     end
 
-    # Update users in Userroles using Zabbix API
-    #
-    # @param data [Hash] Needs to include userids and usrgrpids to mass update users in groups
-    # @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, NilClass] Zabbix object id (usergroup)
+    # 使用 Zabbix API 更新用户角色中的用户
     def update_users(data)
       user_groups = data[:usrgrpids].map do |t|
         {
           usrgrpid: t,
-          userids: data[:userids]
+          userids:  data[:userids]
         }
       end
-      result = @client.api_request(
+      result      = @client.api_request(
         method: "usergroup.update",
         params: user_groups
       )

data/lib/zabbix_manager/classes/screens.rb

@@ -21,37 +21,23 @@ class ZabbixManager
     # SCREEN_RESOURCE_SYSTEM_STATUS => 15,
     # SCREEN_RESOURCE_HOST_TRIGGERS => 16
 
-    # The method name used for interacting with Screens via Zabbix API
-    #
-    # @return [String]
+    # 与 Zabbix API 交互的屏幕方法名称
     def method_name
       "screen"
     end
 
-    # The id field name used for identifying specific Screen objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定屏幕对象的 ID 字段名称
     def identify
       "name"
     end
 
-    # Delete Screen object using Zabbix API
-    #
-    # @param data [String, Array] Should include id's of the screens to delete
-    # @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, NilClass] Zabbix object id
+    # 删除 Zabbix API 中的屏幕对象
     def delete(data)
       result = @client.api_request(method: "screen.delete", params: [data])
       result.empty? ? nil : result["screenids"][0].to_i
     end
 
-    # Get or Create Screen object for Host using Zabbix API
-    #
-    # @param data [Hash] Needs to include screen_name and graphids to properly identify Screens 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 为主机获取或创建屏幕对象
     def get_or_create_for_host(data)
       screen_name = data[:screen_name]
       graphids = data[:graphids]
@@ -61,13 +47,13 @@ class ZabbixManager
       halign = data[:halign] || 2
       rowspan = data[:rowspan] || 1
       colspan = data[:colspan] || 1
-      height = data[:height] || 320 # default 320
-      width = data[:width] || 200 # default 200
+      height = data[:height] || 320
+      width = data[:width] || 200
       vsize = data[:vsize] || [1, (graphids.size / hsize).to_i].max
       screenid = get_id(name: screen_name)
 
       unless screenid
-        # Create screen
+        # 创建屏幕
         graphids.each_with_index do |graphid, index|
           screenitems << {
             resourcetype: 0,

data/lib/zabbix_manager/classes/scripts.rb

@@ -2,24 +2,20 @@
 
 class ZabbixManager
   class Scripts < Basic
+    # 与 Zabbix API 交互的方法名称
     def method_name
       "script"
     end
 
-    # The id field name used for identifying specific Screen objects via Zabbix API
-    #
-    # @return [String]
+    # 用于通过 Zabbix API 标识特定脚本对象的 ID 字段名称
     def identify
       "name"
     end
 
-    # Submits a request to the zabbix api
-    # data - A Hash containing the scriptid and hostid
-    #
-    # Example:
-    #   execute({ scriptid: '12', hostid: '32 })
+    # 执行 Zabbix API 中特定主机上的脚本
     #
-    # Returns nothing
+    # 示例:
+    #   execute({ scriptid: '12', hostid: '32' })
     def execute(data)
       @client.api_request(
         method: "script.execute",
@@ -30,7 +26,8 @@ class ZabbixManager
       )
     end
 
-    def getscriptsbyhost(data)
+    # 使用 Zabbix API 通过主机获取脚本
+    def get_scripts_by_host(data)
       @client.api_request(method: "script.getscriptsbyhosts", params: data)
     end
   end

data/lib/zabbix_manager/classes/server.rb

@@ -2,14 +2,9 @@
 
 class ZabbixManager
   class Server
-    # @return [String]
     attr_reader :version
 
-    # Initializes a new Server object with ZabbixManager Client and fetches Zabbix Server API version
-    #
-    # @param client [ZabbixManager::Client]
-    # @return [ZabbixManager::Client]
-    # @return [String] Zabbix API version number
+    # 初始化一个新的 Server 对象，使用 ZabbixManager 客户端，并获取 Zabbix 服务器 API 版本
     def initialize(client)
       @client = client
       @version = @client.api_version