This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 2ea24c1b3 [feature] add Synology NAS monitoring support (#3721)
2ea24c1b3 is described below
commit 2ea24c1b3a0b628cd6c2d813ae4dd3aae1d7c988
Author: DeleiGuo <[email protected]>
AuthorDate: Thu Aug 28 23:41:47 2025 +0800
[feature] add Synology NAS monitoring support (#3721)
Co-authored-by: tomsun28 <[email protected]>
---
.../src/main/resources/define/app-synology_nas.yml | 863 +++++++++++++++++++++
home/docs/help/synology_nas.md | 128 +++
.../current/help/synology_nas.md | 127 +++
home/sidebars.json | 3 +-
4 files changed, 1120 insertions(+), 1 deletion(-)
diff --git a/hertzbeat-manager/src/main/resources/define/app-synology_nas.yml
b/hertzbeat-manager/src/main/resources/define/app-synology_nas.yml
new file mode 100644
index 000000000..c7120e3bd
--- /dev/null
+++ b/hertzbeat-manager/src/main/resources/define/app-synology_nas.yml
@@ -0,0 +1,863 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# The monitoring type category：service-application service monitoring
db-database monitoring mid-middleware custom-custom monitoring os-operating
system monitoring
+category: server
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: synology
+# The monitoring i18n name
+name:
+ zh-CN: Synology NAS
+ en-US: Synology NAS
+ ja-JP: Synology NAS
+# The description and help of this monitoring type
+help:
+ zh-CN: Hertzbeat 使用 <a class='help_module_content'
href='https://hertzbeat.apache.org/docs/advanced/extend-snmp'> SNMP 协议</a> 对
Synology NAS 的通用指标进行采集监控。<br><span class='help_module_span'>注意⚠️：Synology NAS
要开启 SNMP 服务，<a class='help_module_content'
href='https://kb.synology.cn/zh-cn/DSM/help/DSM/AdminCenter/system_snmp'>点击查看开启步骤</a>。</span>您可以点击
“<i>新建 Synology NAS</i>” 并进行配置SNMP相关参数添加，或者选择“<i>更多操作</i>”，导入已有配置。
+ en-US: HertzBeat uses <a class='help_module_content'
href='https://hertzbeat.apache.org/docs/advanced/extend-snmp'> SNMP
Protocol</a> to monitoring Synology NAS general performance metrics. <br><span
class='help_module_span'>Note⚠️:Synology NAS need enable the SNMP services <a
class='help_module_content'
href='https://kb.synology.com/en-global/DSM/help/DSM/AdminCenter/system_snmp'>Click
here to view the specific steps.</a></span> You can click the "<i>Synology
NAS</i>" button and confi [...]
+ zh-TW: Hertzbeat 使用 <a class='help_module_content'
href='https://hertzbeat.apache.org/docs/advanced/extend-snmp'> SNMP 协议</a> 对
Synology NAS 的通用指标进行采集监控。<br><span class='help_module_span'>注意⚠️：Synology NAS
需要开启 SNMP 服务，<a class='help_module_content'
href='https://kb.synology.com/zh-tw/DSM/help/DSM/AdminCenter/system_snmp'>点击查看开启步骤</a>。</span>您可以点击
“<i>新建 Synology NAS</i>” 并进行配置SNMP相关参数添加，或者选择“<i>更多操作</i>”，导入已有配置。
+ ja-JP: Hertzbeat は <a class='help_module_content'
href='https://hertzbeat.apache.org/docs/advanced/extend-snmp'> SNMP
プロトコルを介して</a> Synology NAS 一般的なメトリクスを監視します。<br><span
class='help_module_span'>注意⚠️：Synology NAS で SNMP サービスを有効にする必要があります，<a
class='help_module_content'
href='https://kb.synology.com/ja-jp/DSM/help/DSM/AdminCenter/system_snmp'>クリックしてガイドを見ます</a>。<br>「<i>新規
Synology NAS</i>」をクリックしてSNMPなどのパラメタを設定した後、新規することができます。
+helpLink:
+ zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/synology_nas
+ en-US: https://hertzbeat.apache.org/docs/help/synology_nas
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 目标Host
+ en-US: Target Host
+ ja-JP: 目標ホスト
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ ja-JP: ポート
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 161
+ # field-param field key
+ - field: snmpVersion
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP 版本
+ en-US: SNMP Version
+ ja-JP: SNMPバージョン
+ # type-param field type(radio mapping the html radio tag)
+ type: radio
+ # required-true or false
+ required: true
+ # when type is radio checkbox, use option to show optional values
{name1:value1,name2:value2}
+ options:
+ - label: SNMPv1
+ value: 0
+ - label: SNMPv2c
+ value: 1
+ - label: SNMPv3
+ value: 3
+ # field-param field key
+ - field: community
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP 团体字
+ en-US: SNMP Community
+ ja-JP: SNMPコミュニティ
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 100
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Snmp community for v1 v2c'
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 0
+ - 1
+ # field-param field key
+ - field: username
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP username
+ en-US: SNMP username
+ ja-JP: SNMPユーザー名
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 50
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Snmp username for v3'
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: contextName
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP contextName
+ en-US: SNMP contextName
+ ja-JP: SNMPコンテキスト名
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 100
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Snmp contextName for v3'
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: authPassphrase
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP authPassword
+ en-US: SNMP authPassword
+ ja-JP: SNMP認証パスワード
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 100
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Snmp authPassword for v3'
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: authPasswordEncryption
+ # name-param field display i18n name
+ name:
+ zh-CN: authPassword 加密方式
+ en-US: authPassword Encryption
+ ja-JP: 認証暗号
+ # type-param field type(radio mapping the html radio tag)
+ type: radio
+ # required-true or false
+ required: false
+ # when type is radio checkbox, use option to show optional values
{name1:value1,name2:value2}
+ options:
+ - label: MD5
+ value: 0
+ - label: SHA1
+ value: 1
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: privPassphrase
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP privPassphrase
+ en-US: SNMP privPassphrase
+ ja-JP: SNMPパスワードフレーズ
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 100
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Snmp authPassword for v3'
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: privPasswordEncryption
+ # name-param field display i18n name
+ name:
+ zh-CN: privPassword 加密方式
+ en-US: privPassword Encryption
+ ja-JP: パスワードの暗号
+ # type-param field type(radio mapping the html radio tag)
+ type: radio
+ # required-true or false
+ required: false
+ # when type is radio checkbox, use option to show optional values
{name1:value1,name2:value2}
+ options:
+ - label: DES
+ value: 0
+ - label: AES128
+ value: 1
+ # dependent parameter values list
+ depend:
+ snmpVersion:
+ - 3
+ # field-param field key
+ - field: timeout
+ # name-param field display i18n name
+ name:
+ zh-CN: 超时时间(ms)
+ en-US: Timeout(ms)
+ ja-JP: タイムアウト（ｍｓ）
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,100000]'
+ # required-true or false
+ required: false
+ # hide-is hide this field and put it in advanced layout
+ hide: true
+ # default value
+ defaultValue: 6000
+# collect metrics config list
+metrics:
+ # metrics - system
+ - name: system
+ i18n:
+ zh-CN: 系统
+ en-US: System
+ ja-JP: システム
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same
priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled
first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ fields:
+ - field: modelName
+ type: 1
+ i18n:
+ zh-CN: 型号
+ en-US: Name
+ ja-JP: モデル
+ - field: serialNumber
+ type: 1
+ i18n:
+ zh-CN: 序列号
+ en-US: Serial Number
+ ja-JP: シリアル番号
+ - field: version
+ type: 1
+ i18n:
+ zh-CN: DSM 版本
+ en-US: Version
+ ja-JP: DSM バージョン
+ - field: controllerNumber
+ type: 1
+ i18n:
+ zh-CN: 控制器编号
+ en-US: Number of Users
+ ja-JP: コントローラー番号
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ modelName: 1.3.6.1.4.1.6574.1.5.1
+ serialNumber: 1.3.6.1.4.1.6574.1.5.2
+ version: 1.3.6.1.4.1.6574.1.5.3
+ controllerNumber: 1.3.6.1.4.1.6574.1.6
+
+ - name: status
+ i18n:
+ zh-CN: 状态
+ en-US: Status
+ ja-JP: ステータス
+ priority: 1
+ fields:
+ - field: powerStatus
+ type: 0
+ i18n:
+ zh-CN: 电源
+ en-US: Power
+ ja-JP: 電源
+ - field: systemFanStatus
+ type: 0
+ i18n:
+ zh-CN: 系统风扇
+ en-US: System Fan
+ ja-JP: システムファン
+ - field: cpuFanStatus
+ type: 0
+ i18n:
+ zh-CN: CPU 风扇
+ en-US: CPU Fan
+ ja-JP: CPUファン
+ - field: systemStatus
+ type: 0
+ i18n:
+ zh-CN: 系统分区
+ en-US: System Partition
+ ja-JP: システムパーティション
+ - field: thermalStatus
+ type: 0
+ i18n:
+ zh-CN: 散热状态
+ en-US: Thermal Partition
+ ja-JP: 熱源
+ - field: temperature
+ type: 0
+ i18n:
+ zh-CN: 温度
+ en-US: Temperature
+ ja-JP: 温度
+ - field: cpuUtilization
+ type: 0
+ i18n:
+ zh-CN: CPU 利用率
+ en-US: CPU Utilization
+ ja-JP: CPU 使用率
+ - field: memUtilization
+ type: 0
+ i18n:
+ zh-CN: 内存利用率
+ en-US: Memory Utilization
+ ja-JP: メモリ使用率
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ systemStatus: 1.3.6.1.4.1.6574.1.1
+ temperature: 1.3.6.1.4.1.6574.1.2
+ powerStatus: 1.3.6.1.4.1.6574.1.3
+ systemFanStatus: 1.3.6.1.4.1.6574.1.4.1
+ cpuFanStatus: 1.3.6.1.4.1.6574.1.4.2
+ cpuUtilization: 1.3.6.1.4.1.6574.1.7.1
+ memUtilization: 1.3.6.1.4.1.6574.1.7.2
+ thermalStatus: 1.3.6.1.4.1.6574.1.78
+
+ - name: disk
+ i18n:
+ zh-CN: 硬盘
+ en-US: Disk
+ ja-JP: ディスク
+ priority: 2
+ fields:
+ - field: diskID
+ type: 1
+ i18n:
+ zh-CN: ID
+ en-US: ID
+ ja-JP: ディスクID
+ - field: diskModel
+ type: 1
+ i18n:
+ zh-CN: 型号
+ en-US: Model
+ ja-JP: ディスクモデル
+ - field: diskType
+ type: 1
+ i18n:
+ zh-CN: 类型
+ en-US: Type
+ ja-JP: ディスクタイプ
+ - field: diskStatus
+ type: 1
+ i18n:
+ zh-CN: 状态
+ en-US: Status
+ ja-JP: ディスクステータス
+ - field: diskTemperature
+ type: 0
+ i18n:
+ zh-CN: 温度
+ en-US: Temperature
+ ja-JP: ディスク温度
+ - field: diskRole
+ type: 1
+ i18n:
+ zh-CN: 作用
+ en-US: Role
+ ja-JP: ディスク作用
+ - field: diskRetry
+ type: 0
+ i18n:
+ zh-CN: 连接重试次数
+ en-US: Retry count
+ ja-JP: ディスクリミネーション
+ - field: diskBadSector
+ type: 0
+ i18n:
+ zh-CN: 坏扇区数
+ en-US: Bad Sector
+ ja-JP: ディスクバッドセクタ
+ - field: diskIdentifyFail
+ type: 0
+ i18n:
+ zh-CN: 计数失败
+ en-US: Identify Fail
+ ja-JP: ディスク識別失敗
+ - field: diskRemainLife
+ type: 0
+ i18n:
+ zh-CN: 预计剩余寿命
+ en-US: Remain Life
+ ja-JP: ディスク残り寿命
+ - field: diskName
+ type: 1
+ i18n:
+ zh-CN: 保留名称
+ en-US: Disk Name
+ ja-JP: ディスク名
+ - field: diskHealthStatus
+ type: 0
+ i18n:
+ zh-CN: 健康状况
+ en-US: Health Status
+ ja-JP: ディスクヘルスステータス
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ diskID: 1.3.6.1.4.1.6574.2.1.1.2
+ diskModel: 1.3.6.1.4.1.6574.2.1.1.3
+ diskType: 1.3.6.1.4.1.6574.2.1.1.4
+ diskStatus: 1.3.6.1.4.1.6574.2.1.1.5
+ diskTemperature: 1.3.6.1.4.1.6574.2.1.1.6
+ diskRole: 1.3.6.1.4.1.6574.2.1.1.7
+ diskRetry: 1.3.6.1.4.1.6574.2.1.1.8
+ diskBadSector: 1.3.6.1.4.1.6574.2.1.1.9
+ diskIdentifyFail: 1.3.6.1.4.1.6574.2.1.1.10
+ diskRemainLife: 1.3.6.1.4.1.6574.2.1.1.11
+ diskName: 1.3.6.1.4.1.6574.2.1.1.12
+ diskHealthStatus: 1.3.6.1.4.1.6574.2.1.1.13
+
+ - name: raid
+ i18n:
+ zh-CN: RAID
+ en-US: RAID
+ ja-JP: RAID
+ priority: 3
+ fields:
+ - field: raidName
+ type: 1
+ i18n:
+ zh-CN: 名称
+ en-US: Name
+ ja-JP: 名
+ - field: raidStatus
+ type: 0
+ i18n:
+ zh-CN: 状态
+ en-US: Status
+ ja-JP: ディスクモデル
+ - field: raidFreeSize
+ type: 0
+ i18n:
+ zh-CN: 可用容量
+ en-US: Free Size
+ ja-JP: ディスク残りサイズ
+ - field: raidTotalSize
+ type: 0
+ i18n:
+ zh-CN: 总大小
+ en-US: Total Size
+ ja-JP: ディスクサイズ
+ - field: raidHotspareCnt
+ type: 0
+ i18n:
+ zh-CN: 热备数
+ en-US: Hot Spare Count
+ ja-JP: ディスクホットスパア数
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ raidName: 1.3.6.1.4.1.6574.3.1.1.2
+ raidStatus: 1.3.6.1.4.1.6574.3.1.1.3
+ raidFreeSize: 1.3.6.1.4.1.6574.3.1.1.4
+ raidTotalSize: 1.3.6.1.4.1.6574.3.1.1.5
+ raidHotspareCnt: 1.3.6.1.4.1.6574.3.1.1.6
+
+ - name: smart
+ i18n:
+ zh-CN: S.M.A.R.T
+ en-US: S.M.A.R.T
+ ja-JP: S.M.A.R.T
+ priority: 4
+ fields:
+ - field: diskSMARTInfoDevName
+ type: 1
+ i18n:
+ zh-CN: 设备名称
+ en-US: Device Name
+ ja-JP: ディスク名
+ - field: diskSMARTAttrName
+ type: 1
+ i18n:
+ zh-CN: 属性名
+ en-US: Attribute Name
+ ja-JP: ディスク属性名
+ - field: diskSMARTAttrId
+ type: 1
+ i18n:
+ zh-CN: 属性 ID
+ en-US: Attribute ID
+ ja-JP: ディスク属性ID
+ - field: diskSMARTAttrCurrent
+ type: 0
+ i18n:
+ zh-CN: 当前值
+ en-US: Attribute Current
+ ja-JP: ディスク属性現在値
+ - field: diskSMARTAttrWorst
+ type: 0
+ i18n:
+ zh-CN: 最差值
+ en-US: Attribute Worst
+ ja-JP: ディスク属性最差値
+ - field: diskSMARTAttrThreshold
+ type: 0
+ i18n:
+ zh-CN: 阈值
+ en-US: Attribute Threshold
+ ja-JP: ディスク属性しきい値
+ - field: diskSMARTAttrRaw
+ type: 0
+ i18n:
+ zh-CN: 原始值
+ en-US: Raw
+ ja-JP: ディスク属性原始値
+ - field: diskSMARTAttrStatus
+ type: 1
+ i18n:
+ zh-CN: 信息状态
+ en-US: Attribute Status
+ ja-JP: ディスク属性情報ステータス
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ diskSMARTInfoDevName: 1.3.6.1.4.1.6574.5.1.1.2
+ diskSMARTAttrName: 1.3.6.1.4.1.6574.5.1.1.3
+ diskSMARTAttrId: 1.3.6.1.4.1.6574.5.1.1.4
+ diskSMARTAttrCurrent: 1.3.6.1.4.1.6574.5.1.1.5
+ diskSMARTAttrWorst: 1.3.6.1.4.1.6574.5.1.1.6
+ diskSMARTAttrThreshold: 1.3.6.1.4.1.6574.5.1.1.7
+ diskSMARTAttrRaw: 1.3.6.1.4.1.6574.5.1.1.8
+ diskSMARTAttrStatus: 1.3.6.1.4.1.6574.5.1.1.9
+
+ - name: spaceio
+ i18n:
+ zh-CN: 存储空间 I/O
+ en-US: Space I/O
+ ja-JP: スペースI/O
+ priority: 5
+ fields:
+ - field: spaceIODevice
+ type: 1
+ i18n:
+ zh-CN: 设备名称
+ en-US: Device Name
+ ja-JP: ディスク名
+ - field: spaceIOReads
+ type: 0
+ i18n:
+ zh-CN: 读取访问次数
+ en-US: Read Accesses Count
+ ja-JP: ディスク属性読み込みアクセス回数
+ - field: spaceIOWrites
+ type: 0
+ i18n:
+ zh-CN: 写入访问次数
+ en-US: Write Accesses Count
+ ja-JP: ディスク属性書き込みアクセス回数
+ - field: spaceIOLA
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 硬盘负载
+ en-US: The load of disk
+ ja-JP: ディスク属性ディスクロード
+ - field: spaceIOLA1
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 1 分钟平均负载
+ en-US: The 1-minute average load of disk
+ ja-JP: 1分平均負荷
+ - field: spaceIOLA5
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 5分钟平均负载
+ en-US: The 5-minute average load of disk
+ ja-JP: 5分平均負荷
+ - field: spaceIOLA15
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 15 分钟平均负载
+ en-US: The-15 minute average load of disk
+ ja-JP: 15分平均負荷
+ - field: spaceUUID
+ type: 1
+ i18n:
+ zh-CN: 卷UUID
+ en-US: UUID
+ ja-JP: UUID
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ spaceIODevice: 1.3.6.1.4.1.6574.102.1.1.2
+ spaceIOReads: 1.3.6.1.4.1.6574.102.1.1.5
+ spaceIOWrites: 1.3.6.1.4.1.6574.102.1.1.6
+ spaceIOLA: 1.3.6.1.4.1.6574.102.1.1.7
+ spaceIOLA1: 1.3.6.1.4.1.6574.102.1.1.8
+ spaceIOLA5: 1.3.6.1.4.1.6574.102.1.1.9
+ spaceIOLA15: 1.3.6.1.4.1.6574.102.1.1.10
+ spaceUUID: 1.3.6.1.4.1.6574.102.1.1.13
+
+ - name: storageio
+ i18n:
+ zh-CN: 硬盘 I/O
+ en-US: Storage I/O
+ ja-JP: ハードディスクI/O
+ priority: 6
+ fields:
+ - field: storageIODevice
+ type: 1
+ i18n:
+ zh-CN: 设备名称
+ en-US: Device Name
+ ja-JP: ディスク名
+ - field: storageIOReads
+ type: 0
+ i18n:
+ zh-CN: 读取访问次数
+ en-US: Read Accesses Count
+ ja-JP: ディスク属性読み込みアクセス回数
+ - field: storageIOWrites
+ type: 0
+ i18n:
+ zh-CN: 写入访问次数
+ en-US: Write Accesses Count
+ ja-JP: ディスク属性書き込みアクセス回数
+ - field: storageIOLA
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 硬盘负载
+ en-US: The load of disk
+ ja-JP: ディスク属性ディスクロード
+ - field: storageIOLA1
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 1 分钟平均负载
+ en-US: The 1-minute average load of disk
+ ja-JP: 1分平均負荷
+ - field: storageIOLA5
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 5分钟平均负载
+ en-US: The 5-minute average load of disk
+ ja-JP: 5分平均負荷
+ - field: storageIOLA15
+ type: 0
+ unit: '%'
+ i18n:
+ zh-CN: 15 分钟平均负载
+ en-US: The-15 minute average load of disk
+ ja-JP: 15分平均負荷
+ - field: storageIODeviceSerial
+ type: 1
+ i18n:
+ zh-CN: 序列号
+ en-US: Serial Number
+ ja-JP: シリアルナンバー
+ protocol: snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp username
+ username: ^_^username^_^
+ # snmp authPassphrase
+ authPassphrase: ^_^authPassphrase^_^
+ # snmp privPassphrase
+ privPassphrase: ^_^privPassphrase^_^
+ # snmp privPasswordEncryption
+ privPasswordEncryption: ^_^privPasswordEncryption^_^
+ # snmp authPasswordEncryption
+ authPasswordEncryption: ^_^authPasswordEncryption^_^
+ # contextName
+ contextName: ^_^contextName^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^snmpVersion^_^
+ # snmp operation: get, walk
+ operation: walk
+ oids:
+ storageIODevice: 1.3.6.1.4.1.6574.101.1.1.2
+ storageIOReads: 1.3.6.1.4.1.6574.101.1.1.5
+ storageIOWrites: 1.3.6.1.4.1.6574.101.1.1.6
+ storageIOLA: 1.3.6.1.4.1.6574.101.1.1.7
+ storageIOLA1: 1.3.6.1.4.1.6574.101.1.1.8
+ storageIOLA5: 1.3.6.1.4.1.6574.101.1.1.9
+ storageIOLA15: 1.3.6.1.4.1.6574.101.1.1.10
+ storageIODeviceSerial: 1.3.6.1.4.1.6574.101.1.1.13
diff --git a/home/docs/help/synology_nas.md b/home/docs/help/synology_nas.md
new file mode 100644
index 000000000..9f5d5beb4
--- /dev/null
+++ b/home/docs/help/synology_nas.md
@@ -0,0 +1,128 @@
+---
+id: synology_nas
+title: Monitoring：Synology NAS
+sidebar_label: Synology NAS
+keywords: [ open source monitoring tool, server monitoring, Synology Nas ]
+---
+
+> Collect and monitor the general performance Metrics of Synology NAS device.
+
+**Protocol Use: SNMP**
+
+## Pre-monitoring operations
+
+Please refer to
[SNMP](https://kb.synology.com/en-global/DSM/help/DSM/AdminCenter/system_snmp)
to enable SNMP service. Currently, SNMPv1, SNMPv2c and SNMPv3 protocols are
supported.
+
+### Configuration parameter
+
+| Parameter name |
Parameter help description
[...]
+|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without
protocol header (eg: https://, http://)
[...]
+| Task Name | Identify the name of this monitoring. The name
needs to be unique
[...]
+| Port | Port of SNMP. The default is 161
[...]
+| SNMP Version | SNMP version to use
[...]
+| SNMP Community | Used in SNMP v1 and SNMP v2c, used to complete
authentication in SNMP Agent, in string form. Group name includes "read" and
"write", when performing SNMP query operation, "read" group name is used for
authentication; when performing SNMP setting operation, "write" group name is
used for authentication. When performing SNMP query operation, "read" group
name is used for authentication; when performing SNMP setting operation,
"write" group name is used for authe [...]
+| SNMP username | For SNMP v3, MSG username
[...]
+| SNMP contextName | For SNMP v3, used to determine the MIB view of the
Context EngineID to the managed device
[...]
+| SNMP authPassword | For SNMP v3, SNMP authentication passwords
[...]
+| authPassword Encryption | For SNMP v3, SNMP authentication algorithm
[...]
+| SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords
[...]
+| privPassword Encryption | For SNMP v3, SNMP encrypted algorithm
[...]
+| Timeout | Set the timeout time when querying unresponsive
data, in milliseconds, the default is 6000 milliseconds
[...]
+| Intervals | Interval time of monitor periodic data collection,
unit: second, and the minimum interval that can be set is 30 seconds
[...]
+| Description | For more information about identifying and
describing this monitoring, users can note information here
[...]
+
+### Collection Metric
+
+Since there are too many metrics that can be queried, detailed metrics can be
queried
+on [SNMP MIB
Guide](https://kb.synology.com/en-global/DG/Synology_DiskStation_MIB_Guide/3).
+
+This document only introduces the monitoring indicators queried in the monitor
template.
+
+### Metric Set: system
+
+| Metric Name | Metric Unit | Metric Help Description |
+|------------------|-------------|-------------------------|
+| modelName | None | Model name of this NAS |
+| serialNumber | None | Model serial number |
+| version | None | The version of DSM |
+| controllerNumber | None | The controller number |
+
+### Metric Set: status
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|-----------------|---------------|---------------------------------------------------------|
+| powerStatus | None | Power status，returns error if power
supplies fail |
+| systemFanStatus | None | System fan status, returns error if system
fan fails |
+| cpuFanStatus | None | CPU fan status, returns error if CPU fan
fails |
+| systemStatus | None | System partition status
|
+| thermalStatus | None | returns error if thermal status is
abnormal |
+| temperature | None | Temperature of this NAS
|
+| cpuUtilization | Percentage(%) | Utilization (%) is the sum of user and
system CPU usage |
+| memUtilization | Percentage(%) | Utilization (%) is the sum of memory usage
|
+
+### Metric Set: disk
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|------------------|-------------|-------------------------------------------------------------------|
+| diskID | None | Disk name in DSM
|
+| diskModel | None | Disk model
|
+| diskType | None | Disk type, e.g. SATA, SSD
|
+| diskStatus | None | Current disk status
|
+| diskTemperature | None | Disk temperature
|
+| diskRole | None | The role of the disk in system
|
+| diskRetry | None | The count of each disk connection retries
|
+| diskBadSector | None | The count of each disk I/O bad sector
|
+| diskIdentifyFail | None | The count of each disk identify fails
|
+| diskRemainLife | None | The estimate remain life of each disk
|
+| diskName | None | Disk name which will keep the same value in
different DSM version |
+| diskHealthStatus | None | Current disk health status
|
+
+### Metric Set: RAID
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|-----------------|-------------|------------------------------------------------------------------------------------------|
+| raidName | None | The name of each RAID in DSM
|
+| raidStatus | None | It shows the RAID status right now
|
+| raidFreeSize | None | The free size of volume / disk group
|
+| raidTotalSize | None | The total size of volume / disk group
|
+| raidHotspareCnt | None | Total hotspare disks count which can protect
RAID (smaller than 0 means something wrong) |
+
+### Metric Set: S.M.A.R.T
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|------------------------|-------------|--------------------------------------------------------|
+| diskSMARTInfoDevName | None | Describes the disk to which this
SMART info belongs to |
+| diskSMARTAttrName | None | The name of the SMART info attribute
|
+| diskSMARTAttrId | None | SMART attribute ID number
|
+| diskSMARTAttrCurrent | None | SMART attribute current value
|
+| diskSMARTAttrWorst | None | SMART attribute worst value
|
+| diskSMARTAttrThreshold | None | SMART attribute threshold value
|
+| diskSMARTAttrRaw | None | SMART attribute raw value
|
+| diskSMARTAttrStatus | None | Status of this SMART info
|
+
+### Metric Set: space io
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|---------------|---------------|---------------------------------------------------------|
+| spaceIODevice | None | The name of the device this volume mounted
on |
+| spaceIOReads | None | The number of read accesses from this volume
since boot |
+| spaceIOWrites | None | The number of write accesses to this volume
since boot |
+| spaceIOLA | Percentage(%) | The load of disk in the volume
|
+| spaceIOLA1 | Percentage(%) | The 1 minute average load of disk in the
volume |
+| spaceIOLA5 | Percentage(%) | The 5 minute average load of disk in the
volume |
+| spaceIOLA15 | Percentage(%) | The 15 minute average load of disk in the
volume |
+| spaceUUID | None | The UUID of this volume
|
+
+### Metric Set: storage io
+
+| Metric Name | Metric Unit | Metric Help Description
|
+|-----------------------|---------------|---------------------------------------------------------|
+| storageIODevice | None | The name of the device we are
counting/checking |
+| storageIOReads | None | The number of read accesses from
this device since boot |
+| storageIOWrites | None | The number of write accesses to this
device since boot |
+| storageIOLA | Percentage(%) | The load of disk
|
+| storageIOLA1 | Percentage(%) | The 1-minute average load of disk
|
+| storageIOLA5 | Percentage(%) | The 5-minute average load of disk
|
+| storageIOLA15 | Percentage(%) | The 15-minute average load of disk
|
+| storageIODeviceSerial | None | The serial number of this device
|
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/synology_nas.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/synology_nas.md
new file mode 100644
index 000000000..5d6acb3e4
--- /dev/null
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/synology_nas.md
@@ -0,0 +1,127 @@
+---
+id: synology_nas
+title: 监控：群晖 NAS
+sidebar_label: 群晖 NAS
+keywords: [ 开源监控系统, 服务器监控, 群晖 NAS 监控 ]
+---
+
+> 对 群晖 NAS 的通用指标进行采集监控。
+
+**使用协议：SNMP**
+
+## 监控前操作
+
+请参考 [SNMP](https://kb.synology.cn/zh-cn/DSM/help/DSM/AdminCenter/system_snmp)
设置 SNMP 服务。目前支持的协议为 SNMPv1、SNMPv2c 以及 SNMPv3。
+
+## 配置参数
+
+| 参数名称 |
参数帮助描述 |
+|---------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。
|
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。
|
+| 端口 | SNMP端口号，默认为161
|
+| SNMP 版本 | 所使用的SNMP版本
|
+| SNMP 团体字 | 用于SNMP v1 和 SNMP v2c，用于在SNMP
Agent完成认证，字符串形式。团体名包括“read”和“write”两种，执行SNMP查询操作时，采用“read”团体名进行认证；执行SNMP设置操作时，则采用“write”团体名进行认证。
|
+| SNMP username | 用于SNMP v3，MSG 用户名
|
+| SNMP contextName | 用于SNMP v3，用于确定Context EngineID对被管理设备的MIB视图。
|
+| SNMP authPassword | 用于SNMP v3，SNMP 认证密码
|
+| authPassword 加密方式 | 用于SNMP v3，SNMP 认证算法
|
+| SNMP privPassphrase | 用于SNMP v3，SNMP 加密密码
|
+| privPassword 加密方式 | 用于SNMP v3，SNMP 加密算法
|
+| 查询超时时间 | 设置查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。
|
+| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。
|
+| 描述备注 | 用于添加关于监控的额外标识和描述信息。
|
+
+## 采集指标
+
+由于可查询的指标过多，详细的指标可在官网的 [SNMP
MIB指南](https://kb.synology.cn/zh-cn/DG/Synology_DiskStation_MIB_Guide) 进行查询。
+
+此文档仅介绍监控模板中查询的监控指标。
+
+### 指标集合：系统
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------------|------|-----------|
+| modelName | 无 | NAS 的型号名称 |
+| serialNumber | 无 | 型号序列号 |
+| version | 无 | DSM 的版本 |
+| controllerNumber | 无 | 控制器编号 |
+
+### 指标集合：状态
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------------|------|-----------------------------|
+| powerStatus | 无 | 电源状态，如果电源出现故障则返回错误 |
+| systemFanStatus | 无 | 系统风扇状态，如果系统风扇发生故障则返回错误 |
+| cpuFanStatus | 无 | CPU 风扇状态，如果 CPU 风扇发生故障则返回错误 |
+| systemStatus | 无 | 系统分区状态 |
+| thermalStatus | 无 | 散热状态，如果散热状态异常 |
+| temperature | 无 | NAS 的温度 |
+| cpuUtilization | 百分比 | 利用率 (%) 是用户和系统 CPU 使用率的总和 |
+| memUtilization | 百分比 | 利用率 (%) 是内存使用率的总和 |
+
+### 指标集合：硬盘
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------------|------|----------------------|
+| diskID | 无 | DSM 中的硬盘名称 |
+| diskModel | 无 | 硬盘型号 |
+| diskType | 无 | 硬盘类型如 SATA、SSD |
+| diskStatus | 无 | 当前硬盘状态 |
+| diskTemperature | 无 | 硬盘温度 |
+| diskRole | 无 | 硬盘在系统中的作用 |
+| diskRetry | 无 | 每个硬盘连接重试次数 |
+| diskBadSector | 无 | 每个硬盘 I/O 坏扇区的计数 |
+| diskIdentifyFail | 无 | 每个硬盘名称的计数失败 |
+| diskRemainLife | 无 | 每个硬盘的预计剩余寿命 |
+| diskName | 无 | 不同 DSM 版本中保留相同值的硬盘名称 |
+| diskHealthStatus | 无 | 当前硬盘运行状况 |
+
+### 指标集合：RAID状态
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------------|------|------------------------------------|
+| raidName | 无 | RAID 的名称 |
+| raidStatus | 无 | RAID 状态 |
+| raidFreeSize | 无 | 卷/硬盘组的可用容量 |
+| raidTotalSize | 无 | 卷/硬盘组的总大小 |
+| raidHotspareCnt | 无 | 可保护 RAID 的 hotspare 硬盘总数，小于 0 表示错误 |
+
+### 指标集合：S.M.A.R.T
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------------------|------|---------------|
+| diskSMARTInfoDevName | 无 | SMART 信息所属的硬盘 |
+| diskSMARTAttrName | 无 | SMART 信息属性的名称 |
+| diskSMARTAttrId | 无 | SMART 属性 ID 号 |
+| diskSMARTAttrCurrent | 无 | SMART 属性当前值 |
+| diskSMARTAttrWorst | 无 | SMART 属性最差值 |
+| diskSMARTAttrThreshold | 无 | SMART 属性阈值 |
+| diskSMARTAttrRaw | 无 | SMART 属性原始值 |
+| diskSMARTAttrStatus | 无 | SMART 信息的状态 |
+
+### 指标集合：存储空间 I/O
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------------|------|----------------------|
+| spaceIODevice | 无 | 装载此存储空间的设备名称 |
+| spaceIOReads | 无 | 自启动以来从此存储空间进行的读取访问次数 |
+| spaceIOWrites | 无 | 自启动以来对此存储空间的写入访问次数 |
+| spaceIOLA | 百分比 | 卷中硬盘的负载率 |
+| spaceIOLA1 | 百分比 | 卷中硬盘的1分钟平均负载率 |
+| spaceIOLA5 | 百分比 | 卷中硬盘的5分钟平均负载率 |
+| spaceIOLA15 | 百分比 | 卷中硬盘的15分钟平均负载率 |
+| spaceUUID | 无 | 卷的 UUID |
+
+### 指标集合：硬盘 I/O
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------------------|------|--------------------|
+| storageIODevice | 无 | 设备的名称 |
+| storageIOReads | 无 | 自启动以来从此设备进行的读取访问次数 |
+| storageIOWrites | 无 | 自启动以来对此设备进行的写入访问次数 |
+| storageIOLA | 百分比 | 硬盘负载率 |
+| storageIOLA1 | 百分比 | 硬盘的1分钟平均负载率 |
+| storageIOLA5 | 百分比 | 硬盘的5分钟平均负载率 |
+| storageIOLA15 | 百分比 | 硬盘的15分钟平均负载率 |
+| storageIODeviceSerial | 无 | 序列号 |
diff --git a/home/sidebars.json b/home/sidebars.json
index 2633815cc..1eb9b4a8c 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -198,7 +198,8 @@
"help/ipmi",
"help/hikvision_isapi",
"help/dahua",
- "help/uniview"
+ "help/uniview",
+ "help/synology_nas"
]
},
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
