sensor (Junos Telemetry Interface)

 

Syntax

Hierarchy Level

Release Information

Statement introduced in Junos OS Release 15.1F3.

Support for MPC7E, MPC8E, and MPC9E on MX Series routers added in Junos OS Release 15.1F5.

Support for FPC1 and FPC2 on PTX Series routers added in Junos OS Release 16.1R3.

Statement introduced in Junos OS Release 17.2R1 for QFX10000 switches and PTX1000 routers.

Statement introduced in Junos OS Release 17.3R1 for the Routing and Control Board (RCB) on PTX3000 routers, EX9200 switches, and MX150 routers.

Statement introduced in Junos OS Release 17.4R1 for virtual MX series (vMX) routers.

Statement introduced in Junos OS Release 18.1R1 for MX Series with MS-MICs and MS-MPCs.

Statement introduced in Junos OS Release 18.2R1 for QFX5100, QFX5110, and QFX5200 switches.

Statement introduced in Junos OS Release 18.3R1 for QFX5120-48Y and EX4650 switches.

Statement introduced in Junos OS Release 18.4R1 for EX4600 switches.

Statement introduced in Junos OS Release 18.4R1 for MX480, MX960, MX2010, MX2020, MX2008 and MX-ELM routers.

Statement introduced in Junos OS Release 19.1R1 for MX Series routers operating with MS-MIC and MS-MPC, QFX10002 switches, PTX3000, and PTX10002 routers.

Statement introduced in Junos OS Release 19.1R1 for PTX3000 routers and PTX5000 routers with FPC2.

Description

Configure a Junos Telemetry Interface sensor, which defines the parameters of a system resource to monitor and stream data. You can use regular expressions to filter the data collected. Examples include filters for logical and physical interfaces and LSP messages. To apply different filters to the same system resource, you configure multiple sensors. For example, you can configure multiple logical interface sensors and apply a different interface filter to each one.

Options

Each sensor configuration requires you to specify the following: sensor name, an export profile name, a resource identifier string that enables monitoring and streaming of data for the specified system resource, and a server name to collect data. A regular expression to filter data for the specified resource is optional.

sensor-nameSpecify a name that defines the sensor configuration. For example, for a sensor configuration that monitors all LSP events, you might choose the name lsp-mon-global. For a sensor configuration that monitors events only for an LSP named A2B, you might choose the name lsp-mon-A2B.
export-name export-profile-nameSpecify the name of an export profile that you configured at the [edit services analytics export-profile name] hierarchy level to associate with the sensor. This export profile defines the parameters for exporting telemetry data, such as a format for exported data and the rate at which data is generated for export.
Note

You can apply only one export profile to each sensor configuration.

The only supported transport protocol when you configure a sensor through the CLI is UDP.

polling-interval secondsSpecify the interval at which the Junos Telemetry Interface sensor generates data to export to the collector.

As the configured interval expires, the most recent sample collected by the sensor is gathered and forwarded to the server configured to collect data.

Note

For Packet Forwarding Engine sensors, the minimum reporting rate is 2 seconds.

Range: 1 through 3600 (1 hour)

resource resource-stringEnable the system resource to monitor and stream data. Each string corresponds to a specific system resource. The format is a file path and must be entered exactly. You can associate only one resource-string with a sensor-name. Configure a separate sensor for each system resource you want to monitor. The resource string to enable LSP monitoring can be modified to specify a specific LSP.
Note

You can configure more than one sensor to monitor the same system resource. Configuring different sensors for the same system resource allows you configure different parameters for monitoring that resource.

Table 1 lists each supported resource-identifier-string, a description of the system resource monitored, and additional configuration information.

You can also use the Telemetry Explorer tool to search for and view information about resource-identifier-string.

Table 1: resource statement Options

resource string

Description

Release Information

/junos/events

System events sensor. Starting with Junos OS Release 18.1R1, this sensor corresponds to system log messages (syslog).

The sensor must be used with an export-profile that has a reporting-rate of 0,

To subscribe for specific events, you can subscribe for /junos/events/event[id=‘EVENT_NAME’] where event EVENT_NAME is the event id that you are interested in. Alternatively, you can subscribe to any XPATH Many event names can be found in the messages log file.

Junos OS 18.1R1 and later on all JTI platforms.

/junos/services/ip-tunnel/usage/

Packet forwarding engine packet statistics sensor.

The statistics counters are used to report various network element performance metrics in a scalable and efficient way, providing visibility into packet forwarding engine errors and drops.

A timestamp indicating when the counters were last reset is included with all the exported data to allow collectors to determine if and when a reset event happened; for example, if the packet forwarding engine hardware restarted.

Exported statistics are similar to the output of the operation mode command show nhdb hw dynamic-ip-tunnels.

Junos OS 17.4R1 and later on MX Series routers.

/junos/services/label-switched-path/usage/

Packet Forwarding Engine sensor for LSP statistics. Starting with Junos OS Release 17.4R1 on MX Series and PTX Series routers only, statistics for bypass LSPs are also exported. Previously, only statistics for ingress LSPs were exported.

For bypass LSPs, the following are exported:

  • Bypass LSP originating at the ingress router of the protected LSP

  • Bypass LSP originating at the transit router of the protected LSP

  • Bypass LSP protecting the transit LSP as well as the locally originated LSP

When the bypass LSP is active, traffic is exported both on the bypass LSP and the ingress (protected) LSP.

On MX Series routers only, bidirectional LSPs for ultimate-hop popping (UHP) are also supported.

Note: You can modify /junos/services/label-switched-path/usage/ to specify a specific LSP. Add __instance__/lsp-name to the end of the resource string identifier. For example, to monitor and stream data for LSP statistics for an LSP named mirror-to-murano-1, enter the following: /junos/services/label-switched-path/usage/

__instance__/mirror-to-murano-1
. If you do not specify a specific LSP name, the system resource monitors and streams data for all LSPs.

When you enable a sensor for LSP statistics, you must also configure the sensor-based-stats statement at the [edit protocols mpls] hierarchy level. MX Series routers must also operate in enhanced mode. If not enabled by default, configure either the enhanced-ip statement or the enhanced-ethernet statement at the [edit chassis network-services] hierarchy level.

Junos OS Release 15.1F6 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches and PTX1000 routers.

Junos OS Release 17.3 and later on EX9200 and QFX5110 switches.

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

Junos OS Release 19.1R1 and later on QFX10002 Switches and PTX10002 Routers

/junos/services/segment-routing/sid/usage/

Source Packet Routing in Networking (SPRING) sensorSfor transit statistics. SPRING is also known as segment routing.

Before statistics can be exported, you must first enable them by including the sensor-based-stats statement at the [edit protocols isis source-packet-routing] hierarchy level. For more information, see Enabling Export of Transit SPRING Statistics.

Junos OS Release 19.1R1 and later on PTX3000 routers and PTX5000 with FPC2

/junos/services/spu/delegated-rpm/

Delegated Realtime Performance Monitoring (RPM) service sensor. Delegated RPM is a mode where RPM probe generation and measurement calculation are done by MS-MIC and MS-MPC cards. This hardware assistance allows a very high scale of concurrent RPM probes.

You can use the resulting data from this sensor to improve network design and optimize traffic engineering. Data can also be used to detect problems in individual devices as well as in the overall network and the traffic carried by it.

JTI sensor support for other RPM modes was added in Junos OS Release 18.3R1.

This sensor has the following limitations:

  • Configuring multiple export profiles for the same resource for delegated RPM may not provide expected results.

  • Multiple sensors for single resource-path (such as delegated RPM) is not supported.

  • Due to an egress packet-size limitation, history outputs are limited to 5 per RPM test.

  • The sensor exports one RPM test record per export packet.

Junos OS Release 19.1R1 and later on MX Series routers operating with MS-MIC and MS-MPC

/junos/services/spu/ipsec-vpn

UDP-based PIC sensors. Starting with Junos OS Release 18.1R1, this sensor provides visibility for IPSec services on different service complexes and nodes.

Exported data is defined using an IP address and a UDP port. When an export interval expires, the most recent statistics collected by the sensors are gathered, placed in the payload of a UDP packet, and forwarded to a collector. A timestamp indicating when counters are read is included with the exported data to allow collectors to collate data. The timestamp also can determine if and when an event happened, such as a PIC hardware restart or if counters were cleared by means of the CLI.

Junos OS 18.1R1 on MX Series with MS-MICs and MS-MPCs

/junos/services/spu/servicesets

Sensor to export service set statistics.

These sensors provide visibility for services on different service complexes and nodes (for example, IPSec services). Exported data is defined using an IP address and a UDP port. When an export interval expires, the most recent statistics collected by the sensors are gathered, placed in the payload of a UDP packet, and forwarded to a collector. A timestamp indicating when counters are read is included with the exported data to allow collectors to collate data. The timestamp also can determine if and when an event happened, such as a PIC hardware restart or if counters were cleared by means of the CLI.

Junos OS 18.2R1 on MX Series with MS-MICs and MS-MPCs

/junos/services/spu/sessions

Sensor to export session statistics.

These sensors provide visibility for services on different service complexes and nodes (for example, IPSec services). Exported data is defined using an IP address and a UDP port. When an export interval expires, the most recent statistics collected by the sensors are gathered, placed in the payload of a UDP packet, and forwarded to a collector. A timestamp indicating when counters are read is included with the exported data to allow collectors to collate data. The timestamp also can determine if and when an event happened, such as a PIC hardware restart or if counters were cleared by means of the CLI.

Junos OS 18.2R1 on MX Series with MS-MICs and MS-MPCs

/junos/system/linecard/node-slicing/af-fab-stats/

Sensor to export abstracted fabric (AF) interface specific load-balancing and fabric queue statistics. This sensor is only supported for a node virtualization configuration on MX series routers with an AF Interface as the connecting link between guest network functions (GNFs). The sensor also reports aggregated statistics across all AF interfaces hosted on a source packet forwarding engine of local GNFs along with the fabric statistics for all traffic ingressing from and egressing to the fabric from that the packet forwarding engine.

Junos OS Release 18.4R1 and later on MX480, MX960, MX2008, MX2010, MX2020, and MX-ELM routers

/junos/system/linecard/cpu/memory/

Packet Forwarding Engine sensor for CPU memory.

Junos OS Release 16.1R3 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches and PTX1000 routers.

Junos OS Release 17.3R1 and later on EX9200 and QFX5110 switches.

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

Junos OS Release 19.1R1 and later on QFX10002 Switches and PTX10002 Routers

/junos/system/linecard/firewall/

Packet Forwarding Engine sensor for firewall filter counters and policer counters. Each line card reports counters separately.

Note: Hierarchical policer statistics are collected for MX Series routers only. Traffic-class counter statistics are collected for PTX Series routers and QFX10000 switches only.

Firewall counters are exported even if the interface to which the firewall filer is attached is down.

Junos OS Release 15.1F5 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches.

Junos OS Release 17.3R1 and later on PTX1000 routers and EX9200 switches and QFX5110 switches..

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

/junos/system/linecard/interface/

Packet Forwarding Engine sensor for physical interface traffic.

Note: For PTX Series routers, for a specific interface, queue statistics are exported for each line card. For MX series routers, interface queue statistics are exported only from the slot on which an interface is configured.

For Aggregated Ethernet interfaces, statistics are exported for the member physical interfaces. You must aggregate the counters at the destination server, or collector.

If a physical interface is administratively down or operationally down, interface counters are not exported.

Issuing an operational clear command, such as clear interfaces statistics all, does not reset statistics exported by the line card.

Junos OS Release 15.1F3 and later on PTX Series routers only. Support introduced for MX Series routers in Junos OS Release 15.1F5.

Junos OS Release 17.2R1 and later on QFX10000 switches and PTX1000 routers.

Junos OS Release 17.3R1 and later on EX9200 switches, QFX5110 switches and MX150 routers.

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

Junos OS Release 19.1R1 and later on QFX10002 Switches and PTX10002 Routers

/junos/system/linecard/interface/logical/usage/

Packet Forwarding Engine sensor for logical interface statistics.

Note: If a logical interface is operationally down, interface statistics continue to be exported.

Issuing an operational clear command, such as clear interfaces statistics all, does not reset statistics exported by the line card.

Note: Locally injected packets from the Routing Engine are not exported.

Junos OS Release 15.1F5 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches.

Junos OS Release 17.3R1 and later on EX9200 and QFX5110 switches

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

/junos/system/linecard/interface/traffic/

Packet Forwarding Engine sensor for physical interface traffic. Exports all fields from /junos/system/linecard/interface/ except queue statistics

This additional sensor can reduce the reap time for non-queue data for platforms supporting VoQ architecture.

To export traffic and queue data for physical interfaces, use /junos/system/linecard/interface/. To export queue fields only, use /junos/system/linecard/interface/queue/.

Junos OS Release 18.3R1 and later on PTX Series and ACX Series routers and EX Series, MX Series, and QFX Series switches.

/junos/system/linecard/interface/queue/

Packet Forwarding Engine sensor for physical interface traffic. Exports all queue fields from /junos/system/linecard/interface/.

To export traffic and queue data for physical interfaces, use /junos/system/linecard/interface/. To export traffic fields only, use /junos/system/linecard/interface/traffic/.

Junos OS Release 18.3R1 and later on PTX Series and ACX Series routers and EX Series, MX Series, and QFX Series switches.

/junos/system/linecard/npu/memory/

Packet Forwarding Engine sensor for network processing unit (NPU) memory.

Junos OS Release 16.1R3 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches.

Junos OS Release 17.3R1 and later on EX9200 switches.

Junos OS Release 19.1R1 and later on QFX10002 Switches and PTX10002 Routers

/junos/system/linecard/npu/utilization/

Packet Forwarding Engine sensor for NPU processor utilization.

Junos OS Release 16.1R3 and later.

Junos OS Release 17.2R1 and later on QFX10000 switches.

Junos OS Release 17.3R1 and later on EX9200 switches.

/junos/npu-memory/

Sensor that exports both NPU memory statistics from the Packet Forwarding Engine and flow-label statistics from the Routing Engine.

To export only flow-label statistics, include the junos/npu-memory/flabel-memory/ resource string.

Junos OS Release 16.1R3 and later on PTX Series routers only.

Note: Junos OS Release 17.2R1 and later on PTX1000 routers.

/junos/system/linecard/services/inline-jflow/

Packet Forwarding Engine sensor for performance metrics of the inline flow sampling process, such as the number of active flows and the number of exported flows.

Junos OS Release 16.1R3 and later on MX series and PTX series routers only.

Junos OS Release and later on EX9200 switches, PTX1000 routers, and MX150 routers.

/junos/system/linecard/optics/

Packet Forwarding Engine sensor for various optical performance metrics, such as transmit and receive power levels.

Junos OS Release 17.1R1 and later.

Junos OS Release and later 17.2R1 on QFX10000 switches.

Junos OS Release 17.3R1 and later on EX9200 switches and PTX1000 routers.

/junos/system/linecard/qmon/

Sensor for queue depth statistics for ingress and egress queue traffic. Statistics are exported directly from the line card.

This sensor only supports single -streaming. Configuring this sensor to stream to multiple servers is not supported. If multiple servers are configured, no data is sent to any of the configured servers.

The following example shows a configuration for single-streaming that will send data:

sensor qmon { 
server-name TEMP; 
export-name export-common; 
resource /junos/system/linecard/qmon/; 
}

The following example shows a multiple-server configuration that will not send data:

sensor qmon { 
server-name TEMP; 
server-name digi1;
server-name digi2;
export-name export-common; 
resource /junos/system/linecard/qmon/; 
}

Note: Issuing an operational clear command, such as clear interfaces statistics all, does not reset the statistics exported by the line card.

Junos OS Release 17.1R1 and later on MX Series routers on MPC7E, MPC8E, and MPC9E only.

Junos OS 17.3R1 and later on EX9200 switches.

Note: virtual MX Series (vMX) routers are not supported.

/junos/system/linecard/qmon-sw/

Sensor for congestion and latency monitoring statistics.

Junos OS Release 18.2R1 and later on QFX5100, QFX5110, and QFX5200 Switches

Junos OS Release 18.3R1 and later on QFX5120-48Y and EX4650 Switches

Junos OS Release 18.4R1 and later on EX4600 Switches

/junos/system/linecard/fabric/

Sensor for fabric statistics.

The following types of statistics can be exported:

  • Fabric statistics for Packet Forwarding Engine pairs (resource-filter option is not supported)

  • FPC fabric statistics

  • Control Board and Switch Fabric Board fabric statistics.

Junos OS Release 17.2R1 and later on MX Series routers only.

Junos OS Release 17.3R1 and later on EX9200 switches.

Note: virtual MX Series (vMX) routers are not supported.

/junos/system/linecard/packet/usage/

Sensor for Packet Forwarding Engine Statistics. This sensor exports statistics for counters and provides visibility into Packet Forwarding Engine error and drop statistics.

Junos OS Release 17.4R1 and later on MX Series and PTX Series routers.

/junos/services/segment-routing/interface/ingress/usage/

/junos/services/segment-routing/interface/egress/usage/

/junos/services/segment-routing/sid/usage/

Sensors for aggregate segment routing traffic with IS-IS.

The first path exports inbound traffic. The second path exports outbound traffic. The third path exports inbound segment routing traffic for each segment identifier.

Note: When you enable a sensor for segment routing statistics, you must also configure the sensor-based-stats statement at the [edit protocols isis source-packet-routing] hierarchy level. MX Series and PTX Series routers must also operate in enhanced mode. On MX Series routers, If not enabled by default, configure either the enhanced-ip statement or the enhanced-ethernet statement at the [edit chassis network-services] hierarchy level. On PTX Series routers, configure the enhanced-mode statement at the [edit chassis network-services] hierarchy level.

Junos OS Release 17.4 and later on MX Series and PTX5000 routers.

resource-filter regular-expression(Optional) Specify a regular expression to filter data for a specific resource. For example, you can filter for a specific set of logical or physical interfaces, firewall filters, or LSP messages. When you configure a system resource to monitor and stream data globally—that is, systemwide—you do not need to include a regular expression.

Examples of regular expressions to filter data exported through sensor configuration:

  • Logical interface statistics sensor—et-2/0/7:1*

  • LSP events sensor—lsp-from-A-to-B*

  • Firewall filter counters sensor—f_testl*

server-name [ streaming- server-names ] Specify one or more servers to transport data for collection. Include at least one server-name configured at the [edit services analytics streaming-server server-name] hierarchy level.
Note

Starting in Junos OS Release 15.1F6, you can configure as many as four streaming servers for a single sensor configuration. In previous releases, you can specify only one streaming server for each configured sensor. To specify more than one streaming server for a sensor, you must enclose the names in brackets.

Required Privilege Level

interface—To view this statement in the configuration.

interface-control—To add this statement to the configuration.

Related Documentation

Release History Table
Release
Description
Statement introduced in Junos OS Release 19.1R1 for PTX3000 routers and PTX5000 routers with FPC2.