sensor-path

Function

The sensor-path command configures the sampling path for a Telemetry sensor.

The undo sensor-path command deletes the sampling path of a Telemetry sensor.

The sensor-path self-defined-event command configures a Telemetry customized event.

The undo sensor-path self-defined-event command deletes a Telemetry customized event.

By default, no sampling path or Telemetry customized event is configured.

Format

sensor-path path

sensor-path path self-defined-event

undo sensor-path path

undo sensor-path path self-defined-event

Parameters

Parameter	Description	Value
path	Specifies a sampling path name. For a sampling path that contains an interface name, Telemetry can add the filtering field [name=interface-type interface-number] to the sampling path, for example, huawei-ifm:ifm/interfaces/interface[name="GigabitEthernet0/1/1"]. name is a filtering field. A maximum of five filtering conditions can be configured for a path. The condition filtering field must be the key field in the node. The filtering field is added at the interface level instead of the last layer of the sampling path. Telemetry also supports fuzzy match for an interface name in a sampling path. An interface name must end with an asterisk () and contain only one asterisk (). For example: GigabitEthernet0/1/: indicates all interfaces with the prefix of GigabitEthernet0/1/. GigabitEthernet0/: indicates all interfaces with the prefix of GigabitEthernet0/. GigabitEthernet: indicates all interfaces with the prefix of GigabitEthernet. GigabitEt: indicates all interfaces with the prefix of GigabitEt. *: indicates all device interfaces supported by the services corresponding to a sampling path.	The value is a string of 1 to 511 case-sensitive characters.
self-defined-event	Specifies a Telemetry customized event.	-

Parameter

Description

Value

path

Specifies a sampling path name.

For a sampling path that contains an interface name, Telemetry can add the filtering field [name=interface-type interface-number] to the sampling path, for example, huawei-ifm:ifm/interfaces/interface[name="GigabitEthernet0/1/1"].

name is a filtering field. A maximum of five filtering conditions can be configured for a path.
The condition filtering field must be the key field in the node.
The filtering field is added at the interface level instead of the last layer of the sampling path.

Telemetry also supports fuzzy match for an interface name in a sampling path. An interface name must end with an asterisk (*) and contain only one asterisk (*). For example:

GigabitEthernet0/1/*: indicates all interfaces with the prefix of GigabitEthernet0/1/.
GigabitEthernet0/*: indicates all interfaces with the prefix of GigabitEthernet0/.
GigabitEthernet*: indicates all interfaces with the prefix of GigabitEthernet.
GigabitEt*: indicates all interfaces with the prefix of GigabitEt.
*: indicates all device interfaces supported by the services corresponding to a sampling path.

The value is a string of 1 to 511 case-sensitive characters.

self-defined-event

Specifies a Telemetry customized event.

Views

Sensor group view

Default Level

3: Management level

Task Name and Operations

Task Name	Operations
telemetry	write

Usage Guidelines

Usage Scenario

To enable a sensor to sample specific data sources and filter specific data, run the sensor-path command to configure one or more sensor paths.

You can configure a Telemetry customized event. If a performance indicator of a resource object that Telemetry monitors exceeds the user-defined threshold, the customized event is reported to the collector in time for service policy determination.

Precautions

A maximum of 64 sampling paths can be configured for a sampling sensor group, including sampling paths configured using the sensor-path self-defined-event and sensor-path commands. When the number of sampling paths reaches the upper limit, the device displays a message indicating that the maximum number of paths is reached.

A sampling path name can be configured in a maximum of 10 sampling sensor groups at the same time. When the number of sampling paths reaches the upper limit, the device displays a message indicating that the maximum number of paths is reached.

Example

# Configure a Telemetry sampling sensor path.

<HUAWEI> system-view
[~HUAWEI] telemetry
[~HUAWEI-telemetry] sensor-group test
[*HUAWEI-telemetry-sensor-group-test] sensor-path huawei-ifm:ifm/interfaces/interface

# Configure a Telemetry customized event.

<HUAWEI> system-view
[~HUAWEI] telemetry
[~HUAWEI-telemetry] sensor-group test
[*HUAWEI-telemetry-sensor-group-test] sensor-path huawei-ifm:ifm/interfaces/interface self-defined-event