Cisco Cisco Videoscape Voyager Vantage 3.2 User Guide
17
Cisco Systems, Inc.
www.cisco.com
Configuration
Introduction
The Vantage Diagnostics configuration file, diagnostics.ini, provides the configuration parameters for the operation of the
diagnostics. The file is available from BFS in the path bfs://msoconfig/rtn/<hubid>/diagnostics.ini. All parameters
included in diagnostics.ini are set in <name>=<value> format, with each name-value pair separated by a new line.
diagnostics. The file is available from BFS in the path bfs://msoconfig/rtn/<hubid>/diagnostics.ini. All parameters
included in diagnostics.ini are set in <name>=<value> format, with each name-value pair separated by a new line.
Vantage reads this file from BFS during initialization, loads it for reference in the folder /rtn/DWS, and configures itself
according to the parameters specified in the file. Vantage also keeps the diagnostics.ini file up to date with any BFS
changes.
according to the parameters specified in the file. Vantage also keeps the diagnostics.ini file up to date with any BFS
changes.
Note:
JSON Diagnostics requires that the diagnostics.ini file exist in /rtn/DWS and that all parameters be present and
have valid values. If the configuration file is missing or incomplete, Vantage disables JSON Diagnostics.
The following example shows typical contents for a configuration.ini file.
[PUBLIC_CONFIG]
http-port-public=10086
#
[ASYNC_CONFIG]
diaglog-size-kb=2000
diag-copies=20
diag-carry-over=200
circular-buffer-size-objs=2000
http-post-rate=2
http-post-burst-interval=2
http-url-collector=http://10.10.1.3:10083/diagnostics/osd/pages
#
[LOG_FWD]
DL_MSP_MPLAYER=DLOGL_NORMAL
DL_MSP_AVPM=DLOGL_ERROR
DL_SPM_VODCTLG=DLOGL_NORMAL
In this example, http://10.10.1.3:10083/diagnostics/osd/pages is the collector URL on the headend network. The three
files specified in the [LOG_FWD] section (DL_MSP_MPLAYER=DLOGL_NORMAL, DL_MSP_AVPM=DLOGL_ERROR, and
DL_SPM_VODCTLG=DLOGL_NORMAL) are pushed to this URL by each set-top in the network.
files specified in the [LOG_FWD] section (DL_MSP_MPLAYER=DLOGL_NORMAL, DL_MSP_AVPM=DLOGL_ERROR, and
DL_SPM_VODCTLG=DLOGL_NORMAL) are pushed to this URL by each set-top in the network.
Configuration and Performance
The transfer of diagnostic and logging information from each set-top to the headend unavoidably reduces the bandwidth
available for content delivery. Conditions such as a persistent defect in a set-top or remote control can trigger aggressive
error logging activity, and with that, the potential to noticeably degrade performance.
available for content delivery. Conditions such as a persistent defect in a set-top or remote control can trigger aggressive
error logging activity, and with that, the potential to noticeably degrade performance.
To help reduce any such impact, JSON Diagnostics includes configuration parameters that limit the size of an individual
log file, and that specify which error logs are included for transfer to the headend. These and other configuration options
are described below.
log file, and that specify which error logs are included for transfer to the headend. These and other configuration options
are described below.
Configuration Parameters
The following table describes all configuration parameters and identifies their default values and value ranges.