# 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 custom-custom monitoring os-operating system monitoring
category: os
# The monitoring type eg: linux windows tomcat mysql aws...
app: freebsd
# The monitoring i18n name
name:
  zh-CN: FreeBSD操作系统
  en-US: OS FreeBSD
  ja-JP: OS FreeBSD
# 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-ssh'> SSH 协议</a> 对 FreeBSD 操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。<br>您可以点击“<i>新建 FreeBSD</i>”并配置HOST端口账户等相关参数进行添加，支持SSH账户密码或密钥认证。或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat uses <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-ssh'> SSH protocol</a> to monitors FreeBSD operating system's general performance metrics such as cpu, memory, disk, basic, interface, disk_free, top_process etc. <br>You can click the "<i>New FreeBSD</i>" and config host port and other related params to add, auth support password or secretKey. Or import an existing setup through the "<i>More Actions</i>" menu.
  zh-TW: Hertzbeat 使用 <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-ssh'> SSH 协议</a> 對 FreeBSD 操作系统的通用性能指標 (系統信息、CPU、內存、磁盤、網卡、文件系統、TOP資源進程等) 進行採集監控。<br>您可以點擊“<i>新建 FreeBSD</i>”並配置HOST端口賬戶等相關參數進行添加，支持SSH賬戶密碼或密鑰認證。或者選擇“<i>更多操作</i>”，導入已有配寘。
  ja-JP: Hertzbeat は <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-ssh'> SSHプロトコルを介して</a> Centosシステムの一般的なパフォーマンスのメトリック監視します。<br>「<i>新規 FreeBSD</i>」をクリックしてホストなどのパラメタを設定した後、新規することができます。SSHまたはキー認証をサポートします。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn//docs/help/freebsd
  en-US: https://hertzbeat.apache.org/docs/help/freebsd
# 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: 22
  # 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: '[400,200000]'
    # required-true or false
    required: false
    # default value
    defaultValue: 6000
  # field-param field key
  - field: reuseConnection
    # name-param field display i18n name
    name:
      zh-CN: 复用连接
      en-US: Reuse Connection
      ja-JP: コネクション再利用
    # type-param field type(most mapping the html input type)
    type: boolean
    # required-true or false
    required: true
    defaultValue: true
  # field-param field key
  - field: useProxy
    # name-param field display i18n name
    name:
      zh-CN: 使用代理
      en-US: Use Proxy Connection
      ja-JP: プロキシコネクション利用
    # type-param field type(most mapping the html input type)
    type: boolean
    # required-true or false
    required: true
    defaultValue: false
  # field-param field key
  - field: username
    # name-param field display i18n name
    name:
      zh-CN: 用户名
      en-US: Username
      ja-JP: ユーザー名
    # 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: true
  # field-param field key
  - field: password
    # name-param field display i18n name
    name:
      zh-CN: 密码
      en-US: Password
      ja-JP: パスワード
    # type-param field type(most mapping the html input tag)
    type: password
    # required-true or false
    required: false
  # field-param field key
  - field: privateKey
    # name-param field display i18n name
    name:
      zh-CN: 私钥
      en-US: PrivateKey
      ja-JP: 秘密鍵
    # type-param field type(most mapping the html input type)
    type: textarea
    placeholder: -----BEGIN RSA PRIVATE KEY-----
    # required-true or false
    required: false
    # hide param-true or false
    hide: true
  # field-param field key
  - field: privateKeyPassphrase
    # name-param field display i18n name
    name:
      zh-CN: 密钥短语
      en-US: PrivateKey PassPhrase
      ja-JP: 秘密鍵フレーズ
    # type-param field type(most mapping the html input type)
    type: password
    # required-true or false
    required: false
    # hide param-true or false
    hide: true
  # field-param field key
  - field: proxyHost
    # name-param field display i18n name
    name:
      zh-CN: 代理主机
      en-US: Proxy Host
      ja-JP: プロキシホスト
    # type-param field type(most mapping the html input type)
    type: text
    # required-true or false
    required: false
    # hide param-true or false
    hide: true
  - field: proxyPort
    # name-param field display i18n name
    name:
      zh-CN: 代理端口
      en-US: Proxy 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: false
    # hide param-true or false
    hide: true
    # default value
    defaultValue: 22
  # field-param field key
  - field: proxyUsername
    # name-param field display i18n name
    name:
      zh-CN: 代理用户名
      en-US: Proxy Username
      ja-JP: プロキシユーザー名
    # 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
    # hide param-true or false
    hide: true
  # field-param field key
  - field: proxyPassword
    # name-param field display i18n name
    name:
      zh-CN: 代理密码
      en-US: Proxy Password
      ja-JP: プロキシパスワード
    # type-param field type(most mapping the html input tag)
    type: password
    # required-true or false
    required: false
    # hide param-true or false
    hide: true
  # field-param field key
  - field: proxyPrivateKey
    # name-param field display i18n name
    name:
      zh-CN: 代理主机私钥
      en-US: proxyPrivateKey
      ja-JP: プロキシ秘密鍵
    # type-param field type(most mapping the html input type)
    type: textarea
    placeholder: -----BEGIN RSA PRIVATE KEY-----
    # required-true or false
    required: false
    # hide param-true or false
    hide: true
# collect metrics config list
metrics:
  # metrics - basic, inner monitoring metrics (responseTime - response time)
  - name: basic
    i18n:
      zh-CN: 系统基本信息
      en-US: Basic Info
      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
    # collect metrics content
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: hostname
        type: 1
        label: true
        i18n:
          zh-CN: 主机名称
          en-US: Host Name
          ja-JP: ホスト名
      - field: version
        type: 1
        i18n:
          zh-CN: 操作系统版本
          en-US: System Version
          ja-JP: システムバージョン
      - field: uptime
        type: 1
        i18n:
          zh-CN: 启动时间
          en-US: Uptime
          ja-JP: アップタイム
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: ssh
    # the config content when protocol is ssh
    ssh:
      # ssh host: ipv4 ipv6 domain
      host: ^_^host^_^
      # ssh port
      port: ^_^port^_^
      # ssh username
      username: ^_^username^_^
      # ssh password
      password: ^_^password^_^
      # ssh private key
      privateKey: ^_^privateKey^_^
      # ssh private key passphrase
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      # ssh run collect script
      script: uname -r ; hostname ; uptime | awk -F "," '{print $1}' | sed  "s/ //g"
      # ssh response data parse type: oneRow, multiRow
      parseType: oneRow

  - name: cpu
    i18n:
      zh-CN: CPU 信息
      en-US: CPU Info
      ja-JP: CPU情報
    priority: 1
    fields:
      - field: info
        type: 1
        i18n:
          zh-CN: 型号
          en-US: Info
          ja-JP: バージョン
      - field: cores
        type: 0
        i18n:
          zh-CN: 核数
          en-US: Cores
          ja-JP: コア数
      - field: interrupt
        type: 0
        i18n:
          zh-CN: 中断数
          en-US: Interrupt
          ja-JP: 割り込み数
      - field: load
        type: 1
        i18n:
          zh-CN: 负载
          en-US: Load
          ja-JP: ロード
      - field: context_switch
        type: 0
        i18n:
          zh-CN: 上下文切换
          en-US: Context Switch
          ja-JP: コンテキストスイッチ
      - field: usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 使用率
          en-US: Usage
          ja-JP: 使用率
    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
    aliasFields:
      - info
      - cores
      - load
      - interrupt
      - context_switch
      - idle
    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
    # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
    calculates:
      - info=info
      - cores=cores
      - load=load
      - interrupt=interrupt
      - context_switch=context_switch
      - usage=100-idle
    protocol: ssh
    ssh:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      privateKey: ^_^privateKey^_^
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      script: "dmesg | grep -i cpu | awk 'NR==1';sysctl hw.ncpu | awk '{print $2}';uptime | sed 's/,/ /g' | awk '{for(i=NF-2;i<=NF;i++)print $i }' | xargs;vmstat 1 1 | awk 'NR==3{print $11}';vmstat 1 1 | awk 'NR==3{print $12}';vmstat 1 2 | awk 'NR==4{print $15}'"
      parseType: oneRow

  - name: memory
    i18n:
      zh-CN: 内存信息
      en-US: Memory Info
      ja-JP: メモリ情報
    priority: 2
    fields:
      - field: physmem
        type: 0
        unit: Mb
        i18n:
          zh-CN: 物理内存
          en-US: Physics Memory
          ja-JP: 物理メモリ
      - field: usermem
        type: 0
        unit: Mb
        i18n:
          zh-CN: 用户内存
          en-US: User Program Memory
          ja-JP: ユーザープログラムメモリ
      - field: realmem
        type: 0
        unit: Mb
        i18n:
          zh-CN: 实际内存
          en-US: Real Memory
          ja-JP: 実際のメモリ
      - field: availmem
        type: 0
        unit: Mb
        i18n:
          zh-CN: 可用内存
          en-US: Available Memory
          ja-JP: 使用可能なメモリ
      - field: usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 内存使用率
          en-US: Memory Usage
          ja-JP: メモリ使用率
    aliasFields:
      - physmem
      - usermem
      - realmem
      - availmem
    calculates:
      - physmem=physmem
      - usermem=usermem
      - realmem=realmem
      - availmem=availmem
      - usage=((realmem - availmem) / realmem) * 100
    units:
      - physmem=B->MB
      - usermem=B->MB
      - realmem=B->MB
      - availmem=B->MB
    protocol: ssh
    ssh:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      privateKey: ^_^privateKey^_^
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      script: sysctl hw | egrep 'hw.(phys|user|real)' | awk '{print $2}';dmesg | grep memory | grep avail | awk '{print $4}';
      parseType: oneRow

  - name: disk_free
    i18n:
      zh-CN: 文件系统
      en-US: Disk Free
      ja-JP: ディスク情報
    priority: 3
    fields:
      - field: filesystem
        type: 1
        i18n:
          zh-CN: 文件系统
          en-US: Filesystem
          ja-JP: ファイルシステム
      - field: used
        type: 0
        unit: Mb
        i18n:
          zh-CN: 已使用量
          en-US: Used
          ja-JP: 使用済み
      - field: available
        type: 0
        unit: Mb
        i18n:
          zh-CN: 可用量
          en-US: Available
          ja-JP: 利用可能
      - field: usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 使用率
          en-US: Usage
          ja-JP: 使用率
      - field: mounted
        type: 1
        label: true
        i18n:
          zh-CN: 挂载点
          en-US: Mounted
          ja-JP: マウント
    protocol: ssh
    ssh:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      privateKey: ^_^privateKey^_^
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      script: df -m | tail -n +2 | awk 'BEGIN{ print "filesystem used available usage mounted"} {print $1,$3,$4,$5,$6}'
      parseType: multiRow

  - name: top_cpu_process
    i18n:
      zh-CN: Top10 CPU 进程
      en-US: Top10 CPU Process
      ja-JP: トップ10 CPUプロセス
    priority: 4
    fields:
      - field: pid
        type: 1
        label: true
        i18n:
          zh-CN: 进程ID
          en-US: PID
          ja-JP: プロセスID
      - field: cpu_usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: CPU占用率
          en-US: CPU Usage
          ja-JP: CPU使用率
      - field: mem_usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 内存占用率
          en-US: Memory Usage
          ja-JP: メモリ使用率
      - field: command
        type: 1
        i18n:
          zh-CN: 执行命令
          en-US: Command
          ja-JP: 指令
    protocol: ssh
    ssh:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      privateKey: ^_^privateKey^_^
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      script: ps aux | sort -k3nr | awk 'BEGIN{ print "pid cpu_usage mem_usage command" } {printf "%s %s %s ", $2, $3, $4; for (i=11; i<=NF; i++) { printf "%s", $i; if (i < NF) printf " "; } print ""}' | head -n 11
      parseType: multiRow

  - name: top_mem_process
    i18n:
      zh-CN: Top10 内存进程
      en-US: Top10 Memory Process
      ja-JP: トップ10 メモリプロセス
    priority: 5
    fields:
      - field: pid
        type: 1
        label: true
        i18n:
          zh-CN: 进程ID
          en-US: PID
          ja-JP: プロセスID
      - field: mem_usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 内存占用率
          en-US: Memory Usage
          ja-JP: メモリ使用率
      - field: cpu_usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: CPU占用率
          en-US: CPU Usage
          ja-JP: CPU使用率
      - field: command
        type: 1
        i18n:
          zh-CN: 执行命令
          en-US: Command
          ja-JP: 指令
    protocol: ssh
    ssh:
      host: ^_^host^_^
      port: ^_^port^_^
      username: ^_^username^_^
      password: ^_^password^_^
      privateKey: ^_^privateKey^_^
      privateKeyPassphrase: ^_^privateKeyPassphrase^_^
      timeout: ^_^timeout^_^
      reuseConnection: ^_^reuseConnection^_^
      # whether to use proxy server for ssh connection
      useProxy: ^_^useProxy^_^
      # ssh proxy host: ipv4 domain
      proxyHost: ^_^proxyHost^_^
      # ssh proxy port
      proxyPort: ^_^proxyPort^_^
      # ssh proxy username
      proxyUsername: ^_^proxyUsername^_^
      # ssh proxy password
      proxyPassword: ^_^proxyPassword^_^
      # ssh proxy private key
      proxyPrivateKey: ^_^proxyPrivateKey^_^
      script: ps aux | sort -k4nr | awk 'BEGIN{ print "pid cpu_usage mem_usage command" } {printf "%s %s %s ", $2, $3, $4; for (i=11; i<=NF; i++) { printf "%s", $i; if (i < NF) printf " "; } print ""}' | head -n 11
      parseType: multiRow