Description of server health metrics

Request to get the settings:

https://[server_address]:[port]/settings/health/?sid=[session_id]

Response:

{
    "name" : "health",
    "type" : "Health",
    "subdirs" : [

    ],
    "values" : [
        "additionspack_level",
        "amerge_error",
        "architecture",
        "archive_last_error",
        "automatic_update_state",
        "channels_bitrate_exceeded",
        "channels_board_online",
        "channels_board_total",
        "channels_detector_error",
        "channels_detector_warning",
        "channels_network_online",
        "channels_network_total",
        "cloud_client_accounts",
        "cloud_client_username",
        "cloud_have_error",
        "cloud_last_error",
        "cloud_server_accounts",
        "cloud_login_sid",
        "cpu_usage",
        "crash_count",
        "crash_count_update",
        "custom_indicators",
        "db_connected",
        "db_is_slow",
        "db_last_error",
        "disks_error_count",
        "disks_is_slow",
        "disks_last_error"
        "disks_stalled",
        "disks_stat_amerge_main_days",
        "disks_stat_amerge_main_gb",
        "disks_stat_amerge_subs_days",
        "disks_stat_amerge_subs_gb",
        "disks_stat_hwmerge_days",
        "disks_stat_hwmerge_gb",
        "disks_stat_main_days",
        "disks_stat_main_gb",
        "disks_stat_priv_days",
        "disks_stat_priv_gb",
        "disks_stat_subs_days",
        "disks_stat_subs_gb",
        "features",
        "gpu_usage",
        "grabberpack_level",
        "icon",
        "ifconfig_error",
        "ip_devices_connected",
        "ip_devices_total",
        "iscsi_error",
        "license_expires_in_sec",
        "license_info",
        "license_type",
        "licensed_unloaded_plugins",
        "lm_connected",
        "lm_last_error",
        "lm_licenses_lacked",
        "local_operator",
        "local_rpchttp_sid",
        "network_error_node",
        "network_last_error",
        "network_really_connected",
        "network_should_be_connected",
        "nvr_subtype",
        "nvr_type",
        "os_version",
        "pg_move_count",
        "platform_name",
        "plugins_ok",
        "plugins_warning",
        "scripts_ok",
        "scripts_total",
        "server_ok",
        "servicepack_level",
        "startup_ts",
        "travi_stat_count",
        "user_defined_health_indicator",
        "user_defined_indicator",
        "watchdog"
    ]
} 

Retrieve a value (R):

https://[server_address]:[port]/settings/health/[setting]?sid=[session_id]

Write a value (W):

https://[server_address]:[port]/settings/health/[setting]=[value]?sid=[session_id]

Table 111. 

values Description Type   TRASSIR
additionspack_level

Additions pack version

string R ≥4.0
amerge_error

There is an archive synchronization error on server:

1 - yes, 0 - no

integer R ≥4.0
architecture

Server architecture

string R ≥3.2
archive_last_error

Last archive error

string R ≥4.0
automatic_update_state

Auto update state

integer R ≥3.1
channels_bitrate_exceeded

Error - Bitrate exceeded on channel:

1 - yes, 0 - no

integer R ≥4.0
channels_board_online

The number of channels working through the video capture card

integer R ≥3.1
channels_board_total

Total amount of channels on video capture card

integer R ≥3.1
channels_detector_error

Server has channels with detector errors:

1 - yes, 0 - no

integer R ≥4.0
channels_detector_warning

Server has channels with detector warnings:

1 - yes, 0 - no

integer R ≥4.0
channels_network_online

Number of network channels online

integer R ≥3.1
channels_network_total

Network channels total

integer R ≥3.1
cloud_client_accounts

TRASSIR Cloud account in client

string R ≥4.0
cloud_client_username

TRASSIR Cloud username on client

integer R ≥3.1
cloud_have_error

Cloud has errors:

1 - yes, 0 - no

integer R ≥3.3
cloud_last_error

Last cloud error

string R ≥3.3
cloud_server_accounts

TRASSIR Cloud accounts on server

string R ≥4.0
cloud_login_sid

Current cloud session ID

    3.3
cpu_usage

CPU load

real R ≥3.1
crash_count   integer R ≥3.1
crash_count_update   integer R ≥3.1
custom_indicators

User indicators

string RW ≥3.2
db_connected

Database connected:

1 - yes, 0 - no

integer R ≥3.1
db_is_slow

Error - Databases work slowly:

1 - yes, 0 - no

integer R ≥3.1
db_last_error

Last database error occurred

string R ≥3.1
disks_error_count

Disks errors:

1 - yes, 0 - no

integer R ≥3.1
disks_is_slow

Error - Disks work slowly:

1 - yes, 0 - no

integer R ≥3.1
disks_last_error

Last disk error

string R ≥3.1
disks_stalled   string R ≥4.0
disks_stat_amerge_main_days

Calculated value of main streams synchronization, days

real R ≥4.0
disks_stat_amerge_main_gb

Calculated value of main streams synchronization, gigabytes

real R ≥4.0
disks_stat_amerge_subs_days

Calculated value of sub streams synchronization, days

real R ≥4.0
disks_stat_amerge_subs_gb

Calculated value of sub streams synchronization, gigabytes

real R ≥4.0
disks_stat_hwmerge_days

Calculated value of the device archive merge, days

real R ≥4.0
disks_stat_hwmerge_gb

Calculated value of the device archive merge, GB

real R ≥4.0
disks_stat_main_days

Calculated value of main stream archive depth, days

real R ≥3.1
disks_stat_main_gb

Calculated value of main stream archive depth, gigabytes

real R ≥3.1
disks_stat_priv_days

Calculated value of privileged channels archive depth, days

real R ≥3.1
disks_stat_priv_gb

Calculated value of privileged channels archive depth, gigabytes

real R ≥3.1
disks_stat_subs_days

Calculated value of sub stream archive depth, days

real R ≥3.1
disks_stat_subs_gb

Calculated value of sub stream archive depth, gigabytes

real R ≥3.1
features   string R ≥4.0
gpu_usage

Video processor load, per cent

real R ≥4.0
grabberpack_level

ID devices driver version

string R ≥3.1
icon

Path to the icon:

:/settings/thermometer.png

string R ≥3.1
ifconfig_error   string R ≥3.1
ip_devices_connected

Number of connected and working IP devices

integer R ≥3.1
ip_devices_total

Total amount of connected IP devices

integer R ≥3.1
iscsi_error

Network storage connection error

integer R ≥3.1
license_expires_in_sec

License expiration time, seconds

integer R ≥4.0
license_info

License info

string R ≥4.0
license_type

License type

string R ≥4.0
licensed_unloaded_plugins   string R ≥4.0
lm_connected

License server connected:

1 - yes, 0 - no

integer R ≥4.0
lm_last_error

Last error of the license server connection

string R ≥4.0
lm_licenses_lacked

Remaining server licenses

string R ≥4.0
local_rpchttp_sid   string R ≥4.0
network_error_node   string R ≥3.1
network_last_error

Last network error

string R ≥3.1
network_really_connected

Number of successful network connections

integer R ≥3.1
network_should_be_connected

Total amount of network connections

integer R ≥3.1
nvr_subtype

NVR subtype

string R ≥4.1
nvr_type

NVR type

string R ≥4.0
os_version

Operating system

string R ≥4.0
pg_move_count   integer R ≥4.1
platform_name

The name of the platform on which the server is running

string R ≥4.0
plugins_ok

Plugins work without mistakes:

1 - yes, 0 - no

integer R ≥4.1
plugins_warning

Plugins have errors:

1 - yes, 0 - no

integer R ≥4.1
scripts_ok

Scripts work without mistakes:

1 - yes, 0 - no

integer R ≥3.1
scripts_total

Number of scripts on server

integer R ≥3.1
server_ok

Server works without mistakes:

1 - yes, 0 - no

integer R ≥3.1
servicepack_level

Main plugins version

string R ≥3.1
startup_ts

TRASSIR launch date and time in UNIX time format

string R ≥3.1
travi_stat_count   string R ≥4.1
user_defined_health_indicator

User health indicator

integer RW ≥4.1
user_defined_indicator

User indicator

integer RW ≥3.2
watchdog

TRASSIR started via watchdog

1 - yes, 0 - no

integer R ≥3.1