Configuring Telemetry Static Subscription
Telemetry static subscription indicates that a device functioning as a client initiates a connection to a collector functioning as a server to send data collected.
Usage Scenario
The controller uses commands to configure devices that support Telemetry, subscribe to data sources, and collect data. The protocol used to send data can be gRPC or UDP.
If the connection between a device and the collection is interrupted, the device connects to the collector and sends data again. However, the data sampled when the connection is being re-established is lost.
After an active/standby switchover is performed or the system saves Telemetry service configurations and restarts, the Telemetry service reloads its configurations and continues to run. However, the data sampled during the restart or active/standby switchover is lost. This poses high pressure on devices. Therefore, Telemetry static subscription is often used for coarse-grained data collection.
- Configuring a Destination Collector
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a destination group and specify a destination collector to which the data is sent. - Configuring the Data to Be Sampled or a Customized Event
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a sampling sensor group and specify a sampling path and filter criteria. - Creating a Subscription
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a subscription to associate the configured destination group with the configured sampling sensor group so that data can be sent to the collector. - Verifying the Telemetry Configuration
After configuring Telemetry static subscription to the data sampled or a customized event, check information about the sampling sensor group, destination group, and subscription.
Configuring a Destination Collector
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a destination group and specify a destination collector to which the data is sent.
Context
When static subscription is configured, a device functions as a client and a collector functions as a server. To statically subscribe to the data sampled or a customized event, you need to configure the IP address and port number of a destination collector, and the protocol and encryption mode for data sending.
Procedure
- Run system-view
The system view is displayed.
- Run telemetry
The Telemetry view is displayed.
- Run destination-group destination-name
A destination group to which the data sampled is sent is created, and the Destination-group view is displayed.
- Run ipv4-address ip-address port port [ vpn-instance vpn-instance ] [ protocol { grpc [ no-tls ] | udp } ]
An IP address and a port number are configured for the destination collector, and a protocol and an encryption mode are configured for data sending.
NOTE:
This command can be run for no more than five times for each destination group.
Both this command and the protocol command in the Subscription view can be run to configure a protocol and encryption mode for the target collector. If the target collector is associated with the subscription, command configurations take effect based on the following rules:If the protocol command has been run in the Subscription view, the protocol and encryption mode configured in the Subscription view take effect.
If the protocol command is not run in the Subscription view, the protocol and encryption mode configured in the Destination-group view take effect.
- Run commit
The configuration is committed.
Configuring the Data to Be Sampled or a Customized Event
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a sampling sensor group and specify a sampling path and filter criteria.
Context
When static subscription is configured, a device functions as a client and a collector functions as a server. To statically subscribe to the data sampled or a customized event, you need to configure a source of the data to be sampled.
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.
Procedure
- Configure the data to be sampled.
- Run sensor-path path { [ condition express op-field field op-type op op-value value [ { and | or } op-type op op-value value ] ] | [ policy reset-when-start ] } *
A sampling path is configured for the Telemetry sensor group.
NOTE:
A maximum of five sampling paths can be configured for a sampling sensor group, including sampling paths configured using the sensor-path and sensor-path self-defined-event 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.
If the sampling sensor group is subscribed and configured with redundancy suppression, sampling paths with filter criteria specified cannot be configured in this sampling sensor group.
This parameter is supported only when the sampling path is huawei-qos:qos/qosPortQueueStatInfos/qosPortQueueStatInfo.
- Run sensor-path path { [ condition express op-field field op-type op op-value value [ { and | or } op-type op op-value value ] ] | [ policy reset-when-start ] } *
- Configure a customized event.
- Run sensor-path path self-defined-event condition express op-field field op-type op op-value value [ { and | or } op-type op op-value value ] { [ suppress-period period ] | [ level level ] }* [ description description ]
A Telemetry customized event is configured.
NOTE:
A maximum of five 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.
If a sampling sensor group is subscribed to and configured with redundancy suppression, Telemetry customized events cannot be configured in this sampling sensor group.
- Run sensor-path path self-defined-event condition express op-field field op-type op op-value value [ { and | or } op-type op op-value value ] { [ suppress-period period ] | [ level level ] }* [ description description ]
Creating a Subscription
When you configure Telemetry static subscription to the data sampled or a customized event, you need to create a subscription to associate the configured destination group with the configured sampling sensor group so that data can be sent to the collector.
Context
When static subscription is configured, a device functions as a client and a collector functions as a server. To statically subscribe to the data sampled or a customized event, you need to create a subscription to set up a data sending channel. The protocol used to send data can be gRPC or UDP.
To configure an SSL policy for a client so that the server and client establish a secure SSL connection, you must ensure that an SSL policy has been created. For details about how to create an SSL policy, see "Configuring and Binding an SSL Policy" in "Basic Configuration" in the configuration guide.
Procedure
- Create a static subscription based on gRPC.
- Run sensor-group sensor-name [ sample-interval sample-interval [ suppress-redundant [ heartbeat-interval heartbeat-interval ] ] ]
A sampling sensor group is associated with the subscription, and a sampling interval, a heartbeat interval, and redundancy suppression are configured for the sampling sensor group.
NOTE:
If a sampling path of the associated sampling sensor group has threshold filter criteria, redundancy suppression cannot be configured. That is, threshold filtering and redundancy suppression are mutually exclusive.
- Run destination-group destination-name
A destination group is associated with the subscription.
NOTE:
A maximum of five destination groups can be associated with each subscription using this command. Five IP addresses and five port numbers can be configured for each destination group.
- (Optional) Run dscp dscp-value
A DSCP value is set for data packets sent.
NOTE:
When network data transmission is stable, Telemetry does not need to change the DSCP value of the data packets sent. When packet loss occurs during data transmission, you can configure a DSCP value in the Telemetry view for the data packets sent. You can improve the priority of packet transmission to ensure the quality of network data transmission.
- (Optional) Run protocol { grpc [ no-tls ] | udp }
A protocol and encryption mode are configured for the target collector that is associated with this subscription.
NOTE:
Both this command and the ipv4-address command in the Destination-group view can configure a protocol and encryption mode for the target collector. If the target collector is associated with the subscription, command configurations take effect based on the following rules:If this command has been run, the protocol and encryption mode configured by running this command in the Subscription view take effect.
If this command is not run, the protocol and encryption mode configured by running the ipv4-address command in the Destination-group view take effect.
- (Optional) Configure an SSL policy for the client or
enable the client to perform SSL verification on the server.
NOTE:
The certificate to be loaded must be supported by both the client and server.
Run quit
Return to the Telemetry view.
Run quit
Return to the system view.
Run grpc
The gRPC view is displayed.
Run grpc client
The gRPC client view is displayed.
Run ssl-policy ssl-policy-name [ verify-cn cn-name ]
An SSL policy is configured for the client during Telemetry static subscription.
NOTE:
If the no-tls parameter has been configured by running the ipv4-address or protocol (Subscription view) command and taken effect, the TLS encryption mode is not used. In this case, the client-specific SSL policy configured by running this command does not take effect.
Run ssl-verify peer
A client is enabled to perform SSL verification on a server during Telemetry static subscription.
NOTE:
If the no-tls parameter has been configured by running the ipv4-address or protocol (Subscription view) command and taken effect, the TLS encryption mode is not used. In this case, the configuration that enables the client to perform SSL verification on a server does not take effect.
- Run sensor-group sensor-name [ sample-interval sample-interval [ suppress-redundant [ heartbeat-interval heartbeat-interval ] ] ]
- Create a static subscription based on UDP.
- Run sensor-group sensor-name [ sample-interval sample-interval [ suppress-redundant [ heartbeat-interval heartbeat-interval ] ] ]
A sampling sensor group is associated with the subscription, and a sampling interval, a heartbeat interval, and redundancy suppression are configured for the sampling sensor group.
NOTE:
If a sampling path of the associated sampling sensor group has threshold filter criteria, redundancy suppression cannot be configured. That is, threshold filtering and redundancy suppression are mutually exclusive.
- Run destination-group destination-name
A destination group is associated with the subscription.
NOTE:
A maximum of five destination groups can be associated with each subscription using this command. Five IP addresses and five port numbers can be configured for each destination group.
- (Optional) Run local-source-address ipv4 ip-address [ port port ]
A source IP address and a port number are configured for UDP-based data sending.
NOTE:
The configured source IP address must be an existing service interface IP address. Otherwise, services may be interrupted.
- (Optional) Run dscp dscp-value
A DSCP value is set for data packets sent.
NOTE:
When network data transmission is stable, Telemetry does not need to change the DSCP value of the data packets sent. When packet loss occurs during data transmission, you can configure a DSCP value in the Telemetry view for the data packets sent. You can improve the priority of packet transmission to ensure the quality of network data transmission.
- (Optional) Run protocol { grpc [ no-tls ] | udp }
A protocol and encryption mode are configured for the target collector that is associated with this subscription.
NOTE:
Both this command and the ipv4-address command in the Destination-group view can configure a protocol and encryption mode for the target collector. If the target collector is associated with the subscription, command configurations take effect based on the following rules:If this command has been run, the protocol and encryption mode configured by running this command in the Subscription view take effect.
If this command is not run, the protocol and encryption mode configured by running the ipv4-address command in the Destination-group view take effect.
- Run sensor-group sensor-name [ sample-interval sample-interval [ suppress-redundant [ heartbeat-interval heartbeat-interval ] ] ]
Verifying the Telemetry Configuration
After configuring Telemetry static subscription to the data sampled or a customized event, check information about the sampling sensor group, destination group, and subscription.
Procedure
- Run the display telemetry sensor [ sensor-name ] command to check the sampling sensor information.
- Run the display telemetry destination [ destination-name ] command to check information about a destination group to which the data sampled is sent.
- Run the display telemetry subscription [ subscription-name ] command to check the subscription information.
- Run the display telemetry sensor-path command to check the sampling path of a Telemetry sensor.
Example
<HUAWEI> display telemetry sensor group1
----------------------------------------------------------------------------------------
Sensor-name:group1
1. Sensor-path : huawei-devm:devm/cpuInfos/cpuInfo
Sensor-type : sample
Path-state : NA
Op-field : -
Op-type1 : -
Op-value1 : -
Relation : -
Op-type2 : -
Op-value2 : -
Policy : -
2. Sensor-path : huawei-devm:devm/cpuInfos/cpuInfo
Sensor-type : self-defined-event
Path-state : NA
Op-field : systemCpuUsage
Op-type1 : le
Op-value1 : 10
Relation : and
Op-type2 : gt
Op-value2 : 90
Self defined event :
Level : 7
Suppress-period : 20
Description : event1
3. Sensor-path : huawei-mpls:TNLREROUTED
Sensor-type : event
Path-state : NA
4. Sensor-path : huawei-sem:hwCPUUtilizationResume
Sensor-type : alarm
Path-state : NA
----------------------------------------------------------------------------------------
<HUAWEI> display telemetry destination 1
----------------------------------------------------------------------------------------
Dest-name Dest-addr Dest-port State Vpn-name Protocol Istls FailedReason
----------------------------------------------------------------------------------------
1 10.135.84.185 50000 RESOLVED - GRPC NO-TLS NA
----------------------------------------------------------------------------------------
<HUAWEI> display telemetry subscription 1
---------------------------------------------------------------------------
Sub-name : 1
Dscp : 0
Protocol : GRPC
Encoding : GPB
Send bytes : 0
Send packets : 0
Total send delay : 0
Total send error : 0
Total send drop : 302
Total other error : 0
Last send-time : 2017-08-31 15:42:35
Sensor group:
----------------------------------------------------------------------
Sensor-name Sample-interval(ms) Heart-interval(s) Suppression State
----------------------------------------------------------------------
senso1 60000 - NO RESOLVED
----------------------------------------------------------------------
Destination group:
----------------------------------------------------------------------
Dest-name Dest-IP Dest-port State Vpn-name Protocol
----------------------------------------------------------------------
dest1 10.135.84.185 50000 RESOLVED - GRPC
----------------------------------------------------------------------
Sub-state : PASSIVE
---------------------------------------------------------------------------
Total subscription number is : 1
<HUAWEI> display telemetry sensor-path
Sample(S) : Serial sample.
Sample(P) : Parallel sample.
Parallel sampled data may not be sent through UDP in out-of-band mode.
------------------------------------------------------------------------------------------------------------------
Type MinPeriod(ms) MaxEachPeriod Path
------------------------------------------------------------------------------------------------------------------
Event -- -- huawei-bfd:hwBfdSessDown
Event -- -- huawei-bfd:hwBfdSessUp
Alarm -- -- huawei-bgp:BACKWARD
Alarm -- -- huawei-bgp:ESTABLISHED
Sample(S) 10000 -- huawei-devm:devm/cpuInfos/cpuInfo
Sample(S) 10000 -- huawei-devm:devm/memoryInfos/memoryInfo
Sample(S) 10000 -- huawei-ifm:ifm/interfaces/interface
Sample(P) 100 20 huawei-ifm:ifm/interfaces/interface/ifClearedStat
Sample(S) 10000 -- huawei-ifm:ifm/interfaces/interface/ifDynamicInfo
Sample(P) 100 20 huawei-ifm:ifm/interfaces/interface/ifStatistics
Sample(P) 1000 20 huawei-ifm:ifm/interfaces/interface/ifStatistics/ethPortErrSts
Sample(S) 100 20 huawei-ifm:interfaces/interface
Alarm -- -- huawei-isiscomm:isisAdjacencyChange
Alarm -- -- huawei-mpls:Session-Down-MIB
Alarm -- -- huawei-mpls:Session-Up-MIB
Event -- -- huawei-mpls:TNLREROUTED
Sample(S) 10000 -- huawei-mpls:mpls/mplsTe/rsvpTeTunnels/rsvpTeTunnel/tunnelPaths/tunnelPath
Alarm -- -- huawei-mpls:mplsLdpSessionDown
Alarm -- -- huawei-ospfv2:ospfNbrStateChange
Alarm -- -- huawei-ospfv2:ospfVirtNbrStateChange
Alarm -- -- huawei-ospfv3:ospfv3NbrStateChange
Alarm -- -- huawei-sem:hwCPUUtilizationResume
Alarm -- -- huawei-sem:hwCPUUtilizationRisingAlarm
Alarm -- -- huawei-sem:hwStorageUtilizationResume
Alarm -- -- huawei-sem:hwStorageUtilizationRisingAlarm
------------------------------------------------------------------------------------------------------------------
