NE20E-S2 V800R022C00SPC600 Diagnose

Key Performance Indicator Diagnostic Commands

display inspect system kpi-statistics
display kpi debug-info
display kpi module-info
display kpi telemetry-info
save kpi file
set kpi cycle-time
set kpi debug-switch
set kpi slot
set kpi switch

display inspect system kpi-statistics

Function

The display inspect system kpi-statistics command displays historical KPI statistics.

Format

display inspect system kpi-statistics

Parameters

None

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To check historical KPI statistics, run the display inspect system kpi-statistics command. You can then use the Aegis to analyze the statistics to determine whether the device is healthy.

Example

The actual command output varies according to the device. The command output here is only an example.

# Displays KPI indicator data information.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] display inspect system kpi-statistics
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
KPI-Name  KPI-Object  Slot  Value1  Value2  Value3  Value4  Value5  Value6  Value7  Value8  Value9  Value10  Value11  Value12  Value13  Value14  Value15  Value16  interval  Lastest-update
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
attr1     obj1        1    135     155     232     49      76      181     51      22      161     238      152      82       165      152      176      251      0         2017-05-27 07:35:49
attr2     obj1        1    195     50      67      89      34      11      243     3       24      131      91       17       10       203      103      73       0         2017-05-27 07:35:49
attr1     obj2        1    211     176     20      21      235     178     219     75      84      96       222       22      209      187      178      138      0         2017-05-27 07:35:49
attr2     obj2        1    126     192     209     21      74      86      232     136     70      75       233      28       165      183      54       91       0         2017-05-27 07:35:49
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Table 2-1564 Description of the display inspect system kpi-statistics command output

Item	Description
KPI-Name	KPI indicator name.
KPI-Object	KPI indicator object name.
Slot	Slot ID.
interval	The collection period of the KPI indicator.
Lastest-update	The most recent acquisition time.
Value	KPI indicator value.

display kpi debug-info

Function

The display kpi debug-info command displays debugging information about the KPI statistics collection task on a slot.

Format

display kpi debug-info [ slotId ]

Parameters

Parameter	Description	Value
slotId	Displays debugging information about KPI statistics in a specified slot.	-

Parameter

Description

Value

slotId

Displays debugging information about KPI statistics in a specified slot.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To check debugging information about the KPI statistics collection task on a slot, run the display kpi debug-info command. The information includes whether the statistics collection function has started, the numbers of sent and received statistical data packets, the number of abnormal statistical data packets, and the size of the CF card occupied by the data files. If slot-id is not specified, the command displays such debugging information on the master main control board.

Example

The actual command output varies according to the device. The command output here is only an example.

# Display debugging information about the KPI statistics collection task on specific slot.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] display kpi debug-info
Globle debug information:
        Buffer content error num     : 0
        Compress file fail num       : 0
        Create file fail num         : 0
        Write file fail num          : 0
        CFCARD space not enough num  : 0
        Buffer not enough num        : 0
        Is CFCARD space enough       : true
        All data file size           : 17984 Byte(0.01715 MB)
        Current buffer size          : 71688 Byte
        KPI SERVER data path         : cfcard:/lpustat
Slot 1 KPI statistics debug information:
Module debug information:
        Module[1](ID=0x1, Name=test1):
        SendMsgNum                   : 30
        SendMsgFailNum               : 0
        CallbackFuncRetFailNum       : 0
        RetDataIsNullNum             : 0
        RetDataLenIsZero             : 0
        ExceedCPUThresholdNum        : 0
        ExceedMemThresholdNum        : 0
        Module[2](ID=0x2, Name=test2):
        SendMsgNum                   : 30
        SendMsgFailNum               : 0
        CallbackFuncRetFailNum       : 0
        RetDataIsNullNum             : 0
        RetDataLenIsZero             : 0
        ExceedCPUThresholdNum        : 0
        ExceedMemThresholdNum        : 0

Table 2-1565 Description of the display kpi debug-info command output

Item	Description
Globle debug information	Global debugging information.
Buffer content error num	Number of errors in buffered contents.
Buffer not enough num	Number of times that the buffer capability becomes insufficient.
Compress file fail num	Number of file compression failures.
Create file fail num	Number of file creation failures.
Write file fail num	Number of file writing failures.
CFCARD space not enough num	Number of times that the CF card space becomes insufficient.
Is CFCARD space enough	Whether the CF card space is sufficient.
All data file size	Size of space occupied by all KPI files.
Current buffer size	Current buffer size.
KPI SERVER data path	KPI file path.
Slot 1 KPI statistics debug information	KPI debugging information of 1.
Module debug information	Module debugging information.
SendMsgNum	Number of times that KPI messages are sent.
SendMsgFailNum	Number of times that KPI messages fail to be sent.
CallbackFuncRetFailNum	Number of times that module callback function fails to be returned.
RetDataIsNullNum	Number of times that the module returns null data.
RetDataLenIsZero	Number of times that the module returns the data of zero length.
ExceedCPUThresholdNum	Number of times that collection is not performed because the CPU usage threshold is reached.
ExceedMemThresholdNum	Number of times that collection is not performed because the memory usage threshold is reached.

display kpi module-info

Function

The display kpi module-info command displays information about the registered statistics collection modules on a specific board.

Format

display kpi module-info slot slotId

Parameters

Parameter	Description	Value
slot slotId	Specifies a slot ID.	-

Parameter

Description

Value

slot slotId

Specifies a slot ID.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

Usage Scenario

The display kpi module-info slot <slotId> command is used to check whether a module is registered, and check the name, statistics collection period, function status, running time, CPU usage threshold, and memory usage threshold of each module. After running the set kpi cycle-time <timeValue> slot <slotId> module <moduleId>, set kpi switch { on | off } slot { <slotId> | all } module { all | <moduleId> }, and set kpi cpu-threshold <cpuThdValue> slot { <slotId> | all } or set kpi memory-threshold <memThdValue> slot { <slotId> | all } commands to change the statistics collection period, function status, and CPU or memory threshold, you can run the display kpi module-info slot <slotId> command to check whether the change takes effect.

Example

The actual command output varies according to the device. The command output here is only an example.

# Display information about the registered statistics collection modules on the board in slot 1.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] display kpi module-info slot 1
Slot 1 KPI statistics module information:
No.  ModID  ModName  Cycle(s)  Switch  Cur-Run(ms)  Max-Run(ms)  Ave-Run(ms)  Cpu-Thd(%)  Mem-Thd(%)
------------------------------------------------------------------------------------------------------- 
1     0x1    test1    20        on        0          3              0            70          70 
2     0x2    test2    20        on        0          1              0            70          70
 -------------------------------------------------------------------------------------------------------

Table 2-1566 Description of the display kpi module-info command output

Item	Description
Slot 1 KPI statistics module information	KPI model data of 1.
No.	Sequence number.
ModID	ID of the registered statistics collection module.
ModName	Name of the registered statistics collection module.
Cycle(s)	Statistics collection period of the module, in seconds.
Switch	Whether the statistics collection function of the module is enabled: on: The statistics collection function of the module is enabled. off: The statistics collection function of the module is disabled.
Cur-Run(ms)	Running duration of the statistics collection task.
Max-Run(ms)	Maximum running duration of the statistics collection task.
Ave-Run(ms)	Average running duration of statistics collection tasks.
Cpu-Thd(%)	CPU usage threshold. If the CPU usage collected in the KPI statistics collection task is higher than the threshold, the system disables CPU usage-sensitive modules. If the CPU usage falls below the threshold, the system enables these modules.
Mem-Thd(%)	Memory usage threshold. If the memory usage collected in the KPI statistics collection task is higher than the threshold, the system disables memory usage-sensitive modules. If the memory usage falls below the threshold, the system enables these modules.

display kpi telemetry-info

Function

The display kpi telemetry-info command displays information about the KPI module for which a Telemetry collection task is started.

Format

display kpi telemetry-info [ module module-id ]

Parameters

Parameter	Description	Value
module module-id	Model ID.	The value ranges from 0x1 to 0xffff, in hexadecimal notation. The default value is 0x0.

Parameter

Description

Value

module module-id

Model ID.

The value ranges from 0x1 to 0xffff, in hexadecimal notation. The default value is 0x0.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

After a Telemetry collection task is started, you can run this command to query the statistics about the KPI module for fault locating.

Example

The actual command output varies according to the device. The command output here is only an example.

# Displays all KPI module information for the Telemetry collection task.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] display kpi telemetry-info
Module[1](ID=0x64, Name=CPUP):
  Current buffer size  : 36
  Send msg number      : 0
  Send msg fail number : 0
  Drop msg number      : 0
  Task ID list         : 1

Table 2-1567 Description of the display kpi telemetry-info command output

Item	Description
Current buffer size	Current cache data size, in bytes.
Send msg number	Number of messages that are successfully sent.
Send msg fail number	Number of messages that fail to be sent.
Drop msg number	Number of discarded messages.
Task ID list	ID list of bound tasks.

save kpi file

Function

The save kpi file command saves KPI statistics to a file.

Format

save kpi file

Parameters

None

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To save KPI statistics to a file, run the save kpi file command.

The file save path is specified by the custom table and can be downloaded via FTP to view locally.

Example

# Save KPI statistics to a file.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] save kpi file

set kpi cycle-time

Function

The set kpi cycle-time command sets a KPI statistics collection period for a module on a specific slot.

Format

set kpi cycle-time timeValue slot slotId module moduleId

Parameters

Parameter	Description	Value
timeValue	Specifies a KPI statistics collection period.	The value is an integer ranging from 60 to 65535, in seconds. The default value is 60.
slot slotId	Specifies the slot ID.	-
module moduleId	Specifies a module ID.	The value ranges from 0x0 to 0xffff, in hexadecimal notation. The default value is 0x0.

Parameter

Description

Value

timeValue

Specifies a KPI statistics collection period.

The value is an integer ranging from 60 to 65535, in seconds. The default value is 60.

slot slotId

Specifies the slot ID.

module moduleId

Specifies a module ID.

The value ranges from 0x0 to 0xffff, in hexadecimal notation. The default value is 0x0.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To set a KPI statistics collection period for a module on a specific slot, run the set kpi cycle-time command to facilitate fault locating or device debugging.

Example

# Set the KPI statistics collection period to 73s for the module ff93 on slot 1.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] set kpi cycle-time 73 slot 1 module ff93

set kpi debug-switch

Function

The set kpi debug-switch command enables the debugging function for a slot.

Format

set kpi debug-switch { error | event | all | none } [ slotId ]

Parameters

Parameter	Description	Value
error	Specifies the function of error debugging.	-
event	Specifies the function of event debugging.	-
all	All the function of debugging.	-
none	Disables all debugging functions.	-
slotId	Specifies the slot ID of a board for which the debugging function needs to be enabled.	-

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To enable the debugging function for a main control board or interface board, run the set kpi debug-switch command. The command output helps you perform patch debugging and troubleshoot faults.

Example

# Change the value of the error debugging function for the board in the specified slot.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] set kpi debug-switch error

set kpi slot

Function

The set kpi slot slot command sets CPU usage thresholds or memory usage thresholds for KPI statistics collection.

The undo set kpi slot command restores the default settings.

By default, both the CPU and memory usage thresholds are 70%.

Format

set kpi cpu-threshold cpuThdValue slot { slotId | all }

set kpi memory-threshold memThdValue slot { slotId | all }

undo set kpi cpu-threshold cpuThdValue slot { slotId | all }

undo set kpi memory-threshold memThdValue slot { slotId | all }

Parameters

Parameter	Description	Value
slotId	Slot ID.	-
all	All slots.	-
memory-threshold memThdValue	Specifies a CPU usage threshold.	The value is an integer ranging from 1 to 100, in percentage.
cpu-threshold cpuThdValue	Specifies a memory usage threshold.	The value is an integer ranging from 1 to 100, in percentage.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To set CPU and memory usage thresholds for KPI statistics collection, run the set kpi cpu-threshold and the set kpi memory-threshold commands. When the CPU or memory usage KPI statistics threshold is reached, the device stops collecting statistics about non-CPU or non-memory usage indicators.

Example

# Set the CPU usage threshold for KPI statistics collection to 80% for all slots.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] set kpi cpu-threshold 80 slot all

# Set the memory usage threshold for KPI statistics collection to 80% for the board in the specified slot.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] set kpi memory-threshold 80 slot X

set kpi switch

Function

The set kpi switch command configure the KPI collection function.

By default, KPI collection is disabled.

Format

set kpi switch { on | off } slot { slotId | all } module { all | moduleId }

Parameters

Parameter	Description	Value
on	Indicates that enable the KPI collection function.	-
off	Indicates that disable the KPI collection function.	-
slot slotId	Slot ID.	-
all	All slots or all modules.	-
module moduleId	Indicates the ID of a module.	The value ranges from 0x0 to 0xffff, in hexadecimal notation. The default value is 0x0.

Views

Diagnostic view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
perf-mgr	debug

Usage Guidelines

To enable or disable KPI collection for a specific or all modules on a specific or all interface boards, run the set kpi switch command. If the function is enabled, the command output helps you perform fault locating and device debugging.

Example

# Enable KPI collection for the module ff75 on slot 1.

<HUAWEI> system-view
[~HUAWEI] diagnose
[~HUAWEI-diagnose] set kpi switch off slot 1 module ff75

display inspect system kpi-statistics
display kpi debug-info
display kpi module-info
display kpi telemetry-info
save kpi file
set kpi cycle-time
set kpi debug-switch
set kpi slot
set kpi switch

Translation

Favorite

Download

Update Date：2022-12-20

Document ID：EDOC1100282152

Downloads：265

Average rating：0.0Points

Digital Signature File

digtal sigature tool