package threadnetwork

Get desktop application:
View/edit binary Protocol Buffers messages

Thread Telemetry data definition. The field range for your data definition is determined as: --------------------------------------------------------------------------- | Field Range | Logging From | [1 - 500) | Primary fields logged from OTBR-agent/OpenThread. | [500-600) | OTBR vendor fields logged from OTBR-agent/OpenThread. | Other | Reserved for now. --------------------------------------------------------------------------- Usage: Delete field: do not directly delete field. Deprecate it instead.

• optional TelemetryData.WpanStats wpan_stats = 1

• optional TelemetryData.WpanTopoFull wpan_topo_full = 2

• repeated TelemetryData.TopoEntry topo_entries = 3

• optional TelemetryData.WpanBorderRouter wpan_border_router = 4

• optional TelemetryData.WpanRcp wpan_rcp = 5

• optional TelemetryData.CoexMetrics coex_metrics = 7

• optional TelemetryData.LowPowerMetrics low_power_metrics = 8

Used in: BorderAgentInfo

• optional uint32 epskc_activations = 1

  The number of ePSKc activations

• optional uint32 epskc_deactivation_clears = 2

  The number of ePSKc deactivations due to cleared via API

• optional uint32 epskc_deactivation_timeouts = 3

  The number of ePSKc deactivations due to timeout

• optional uint32 epskc_deactivation_max_attempts = 4

  The number of ePSKc deactivations due to max connection attempts reached

• optional uint32 epskc_deactivation_disconnects = 5

  The number of ePSKc deactivations due to commissioner disconnected

• optional uint32 epskc_invalid_ba_state_errors = 6

  The number of ePSKc activation failures caused by invalid border agent state

• optional uint32 epskc_invalid_args_errors = 7

  The number of ePSKc activation failures caused by invalid argument

• optional uint32 epskc_start_secure_session_errors = 8

  The number of ePSKc activation failures caused by failed to start secure session

• optional uint32 epskc_secure_session_successes = 9

  The number of successful secure session establishment with ePSKc

• optional uint32 epskc_secure_session_failures = 10

  The number of failed secure session establishement with ePSKc

• optional uint32 epskc_commissioner_petitions = 11

  The number of active commissioner petitioned over secure session establishment with ePSKc

• optional uint32 pskc_secure_session_successes = 12

  The number of successful secure session establishment with PSKc

• optional uint32 pskc_secure_session_failures = 13

  The number of failed secure session establishement with PSKc

• optional uint32 pskc_commissioner_petitions = 14

  The number of active commissioner petitioned over secure session establishment with PSKc

• optional uint32 mgmt_active_get_reqs = 15

  The number of MGMT_ACTIVE_GET.req received

• optional uint32 mgmt_pending_get_reqs = 16

  The number of MGMT_PENDING_GET.req received

Used in: WpanBorderRouter

• optional BorderAgentCounters border_agent_counters = 1

  The border agent counters

Used in: WpanBorderRouter

• optional int64 ra_rx = 9

  The number of Router Advertisement packets received by otbr-agent on the infra link

• optional int64 ra_tx_success = 10

  The number of Router Advertisement packets successfully transmitted by otbr-agent on the infra link.

• optional int64 ra_tx_failure = 11

  The number of Router Advertisement packets failed to transmit by otbr-agent on the infra link.

• optional int64 rs_rx = 12

  The number of Router Solicitation packets received by otbr-agent on the infra link

• optional int64 rs_tx_success = 13

  The number of Router Solicitation packets successfully transmitted by otbr-agent on the infra link.

• optional int64 rs_tx_failure = 14

  The number of Router Solicitation packets failed to transmit by otbr-agent on the infra link.

• optional PacketsAndBytes inbound_unicast = 15

  The counters for inbound unicast packets

• optional PacketsAndBytes inbound_multicast = 16

  The counters for inbound multicast packets

• optional PacketsAndBytes outbound_unicast = 17

  The counters for outbound unicast packets

• optional PacketsAndBytes outbound_multicast = 18

  The counters for outbound multicast packets

• optional Nat64ProtocolCounters nat64_protocol_counters = 19

  The inbound and outbound NAT64 traffic through the border router

• optional Nat64ErrorCounters nat64_error_counters = 20

  Error counters for NAT64 translator on the border router

• optional PacketsAndBytes inbound_internet = 21

  The counter for inbound Internet when DHCPv6 PD enabled

• optional PacketsAndBytes outbound_internet = 22

  The counter for outbound Internet when DHCPv6 PD enabled

Used in: WpanBorderRouter

• optional Nat64State prefix_manager_state = 1

• optional Nat64State translator_state = 2

Used in: TelemetryData

• optional uint32 count_tx_request = 1

  Use uint32 instead of int64 to save space for payload, and align with the raw data size.

• optional uint32 count_tx_grant_immediate = 2

• optional uint32 count_tx_grant_wait = 3

• optional uint32 count_tx_grant_wait_activated = 4

• optional uint32 count_tx_grant_wait_timeout = 5

• optional uint32 count_tx_grant_deactivated_during_request = 6

• optional uint32 tx_average_request_to_grant_time_us = 7

• optional uint32 count_rx_request = 8

• optional uint32 count_rx_grant_immediate = 9

• optional uint32 count_rx_grant_wait = 10

• optional uint32 count_rx_grant_wait_activated = 11

• optional uint32 count_rx_grant_wait_timeout = 12

• optional uint32 count_rx_grant_deactivated_during_request = 13

• optional uint32 count_rx_grant_none = 14

• optional uint32 rx_average_request_to_grant_time_us = 15

Used in: WpanBorderRouter

• DHCP6_PD_STATE_UNSPECIFIED = 0

• DHCP6_PD_STATE_DISABLED = 1

  DHCPv6 PD is disabled on the border router.

• DHCP6_PD_STATE_STOPPED = 2

  DHCPv6 PD is enabled but won't try to request and publish a prefix.

• DHCP6_PD_STATE_RUNNING = 3

  DHCPv6 PD is enabled and will try to request and publish a prefix.

Used in: WpanBorderRouter

• optional DnsServerResponseCounters response_counters = 1

  The counters of response codes sent by the DNS server

• optional uint32 resolved_by_local_srp_count = 2

  The number of DNS queries resolved at the local SRP server

• optional UpstreamDnsQueryState upstream_dns_query_state = 3

  The state of upstream DNS query

Used in: DnsServerInfo

• optional uint32 success_count = 1

  The number of successful responses

• optional uint32 server_failure_count = 2

  The number of server failure responses

• optional uint32 format_error_count = 3

  The number of format error responses

• optional uint32 name_error_count = 4

  The number of name error responses

• optional uint32 not_implemented_count = 5

  The number of 'not implemented' responses

• optional uint32 other_count = 6

  The number of other responses

• optional uint32 upstream_dns_queries = 7

  The number of queries handled by Upstream DNS server.

• optional uint32 upstream_dns_responses = 8

  The number of responses handled by Upstream DNS server.

• optional uint32 upstream_dns_failures = 9

  The number of upstream DNS failures.

Used in: TopoEntry

• optional int64 seconds = 1

  Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

• optional int32 nanos = 2

  Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.

Message to indicate the information of external routes in network data.

Used in: WpanBorderRouter

• optional bool has_default_route_added = 1

  Indicates whether the a zero-length prefix (::/0) added from this BR

• optional bool has_ula_route_added = 2

  Indicates whether the a ULA prefix (fc00::/7) added from this BR

• optional bool has_others_route_added = 3

  Indicates whether the other prefixes (other than "::/0" or "fc00::/7") added from this BR. (BR is a managed infrastructure router).

Used in: WpanBorderRouter

• optional string name = 1

• optional bool is_up = 2

• optional bool is_running = 3

• optional bool is_multicast = 4

• optional uint32 link_local_address_count = 5

• optional uint32 unique_local_address_count = 6

• optional uint32 global_unicast_address_count = 7

• optional uint32 peer_br_count = 8

  Indicates how many peer BRs (connected to the same Thread mesh network) are on the infra link.

Used in: LowPowerMetrics

• optional int32 link_margin = 1

• optional int32 rssi = 2

Used in: TelemetryData

• repeated LinkMetricsEntry link_metrics_entries = 1

Used in: WpanBorderRouter

• optional MdnsResponseCounters host_registration_responses = 1

  The response counters of host registrations

• optional MdnsResponseCounters service_registration_responses = 2

  The response counters of service registrations

• optional MdnsResponseCounters host_resolution_responses = 3

  The response counters of host resolutions

• optional MdnsResponseCounters service_resolution_responses = 4

  The response counters of service resolutions

• optional uint32 host_registration_ema_latency_ms = 5

  The EMA latency of host registrations in milliseconds

• optional uint32 service_registration_ema_latency_ms = 6

  The EMA latency of service registrations in milliseconds

• optional uint32 host_resolution_ema_latency_ms = 7

  The EMA latency of host resolutions in milliseconds

• optional uint32 service_resolution_ema_latency_ms = 8

  The EMA latency of service resolutions in milliseconds

Used in: MdnsInfo

• optional uint32 success_count = 1

  The number of successful responses

• optional uint32 not_found_count = 2

  The number of 'not found' responses

• optional uint32 invalid_args_count = 3

  The number of 'invalid arg' responses

• optional uint32 duplicated_count = 4

  The number of 'duplicated' responses

• optional uint32 not_implemented_count = 5

  The number of 'not implemented' responses

• optional uint32 unknown_error_count = 6

  The number of unknown error responses

• optional uint32 aborted_count = 7

  The number of aborted responses

• optional uint32 invalid_state_count = 8

  The number of invalid state responses

Used in: BorderRoutingCounters

• optional Nat64PacketCounters unknown = 1

• optional Nat64PacketCounters illegal_packet = 2

• optional Nat64PacketCounters unsupported_protocol = 3

• optional Nat64PacketCounters no_mapping = 4

Used in: WpanBorderRouter

• optional uint64 mapping_id = 1

• optional bytes hashed_ipv6_address = 2

• optional Nat64ProtocolCounters counters = 3

Used in: Nat64ErrorCounters

• optional int64 ipv4_to_ipv6_packets = 1

• optional int64 ipv6_to_ipv4_packets = 2

Used in: BorderRoutingCounters, Nat64Mapping

• optional Nat64TrafficCounters tcp = 1

• optional Nat64TrafficCounters udp = 2

• optional Nat64TrafficCounters icmp = 3

Used in: BorderRoutingNat64State

• NAT64_STATE_UNSPECIFIED = 0

• NAT64_STATE_DISABLED = 1

• NAT64_STATE_NOT_RUNNING = 2

• NAT64_STATE_IDLE = 3

• NAT64_STATE_ACTIVE = 4

Used in: Nat64ProtocolCounters

• optional int64 ipv4_to_ipv6_packets = 1

• optional int64 ipv4_to_ipv6_bytes = 2

• optional int64 ipv6_to_ipv4_packets = 3

• optional int64 ipv6_to_ipv4_bytes = 4

• NODE_TYPE_UNSPECIFIED = 0

• NODE_TYPE_ROUTER = 1

• NODE_TYPE_END = 2

• NODE_TYPE_SLEEPY_END = 3

• NODE_TYPE_MINIMAL_END = 4

• NODE_TYPE_OFFLINE = 5

• NODE_TYPE_DISABLED = 6

• NODE_TYPE_DETACHED = 7

• NODE_TYPE_NL_LURKER = 16

• NODE_TYPE_COMMISSIONER = 32

• NODE_TYPE_LEADER = 64

Used in: BorderRoutingCounters

• optional int64 packet_count = 1

• optional int64 byte_count = 2

Used in: WpanBorderRouter

• optional uint32 num_platform_ra_received = 1

  The number of platform generated RA handled by ApplyPlatfromGeneratedRa.

• optional uint32 num_platform_pio_processed = 2

  The number of PIO processed for adding OMR prefixes.

• optional uint32 last_platform_ra_msec = 3

  The timestamp of last processed RA message.

Used in: WpanRcp

• optional uint32 rcp_interface_type = 1

• optional uint64 transferred_frames_count = 2

• optional uint64 transferred_valid_frames_count = 3

• optional uint64 transferred_garbage_frames_count = 4

• optional uint64 rx_frames_count = 5

• optional uint64 rx_bytes_count = 6

• optional uint64 tx_frames_count = 7

• optional uint64 tx_bytes_count = 8

Used in: WpanRcp

• optional uint32 rcp_timeout_count = 1

• optional uint32 rcp_reset_count = 2

• optional uint32 rcp_restoration_count = 3

• optional uint32 spinel_parse_error_count = 4

• optional int32 rcp_firmware_update_count = 5

• optional uint32 thread_stack_uptime = 6

The address mode used by the SRP server

Used in: SrpServerInfo

• SRP_SERVER_ADDRESS_MODE_UNSPECIFIED = 0

• SRP_SERVER_ADDRESS_MODE_UNICAST = 1

• SRP_SERVER_ADDRESS_MODE_STATE_ANYCAST = 2

Used in: WpanBorderRouter

• optional SrpServerState state = 1

  The state of the SRP server

• optional uint32 port = 2

  Listening port number

• optional SrpServerAddressMode address_mode = 3

  The address mode {unicast, anycast} of the SRP server

• optional SrpServerRegistrationInfo hosts = 4

  The registration information of hosts on the SRP server

• optional SrpServerRegistrationInfo services = 5

  The registration information of services on the SRP server

• optional SrpServerResponseCounters response_counters = 6

  The counters of response codes sent by the SRP server

Used in: SrpServerInfo

• optional uint32 fresh_count = 1

  The number of active hosts/services registered on the SRP server.

• optional uint32 deleted_count = 2

  The number of hosts/services in 'Deleted' state on the SRP server.

• optional uint64 lease_time_total_ms = 3

  The sum of lease time in milliseconds of all active hosts/services on the SRP server.

• optional uint64 key_lease_time_total_ms = 4

  The sum of key lease time in milliseconds of all active hosts/services on the SRP server.

• optional uint64 remaining_lease_time_total_ms = 5

  The sum of remaining lease time in milliseconds of all active hosts/services on the SRP server.

• optional uint64 remaining_key_lease_time_total_ms = 6

  The sum of remaining key lease time in milliseconds of all active hosts/services on the SRP server.

Used in: SrpServerInfo

• optional uint32 success_count = 1

  The number of successful responses

• optional uint32 server_failure_count = 2

  The number of server failure responses

• optional uint32 format_error_count = 3

  The number of format error responses

• optional uint32 name_exists_count = 4

  The number of 'name exists' responses

• optional uint32 refused_count = 5

  The number of refused responses

• optional uint32 other_count = 6

  The number of other responses

Used in: SrpServerInfo

• SRP_SERVER_STATE_UNSPECIFIED = 0

• SRP_SERVER_STATE_DISABLED = 1

• SRP_SERVER_STATE_RUNNING = 2

• SRP_SERVER_STATE_STOPPED = 3

Used in: TelemetryData

• optional uint32 rloc16 = 2

• optional uint32 link_quality_in = 3

  link quality with data range: 0~3.

• optional int32 average_rssi = 4

  the most recent RSSI measurement (8 bit).

• optional Duration age = 5

• optional bool rx_on_when_idle = 6

• optional bool full_function = 7

• optional bool secure_data_request = 8

• optional bool full_network_data = 9

• optional int32 last_rssi = 10

• optional uint32 link_frame_counter = 11

• optional uint32 mle_frame_counter = 12

• optional bool is_child = 13

• optional Duration timeout = 14

• optional uint32 network_data_version = 15

• optional float mac_frame_error_rate = 16

• optional float ip_message_error_rate = 17

• optional int32 version = 18

Used in: WpanBorderRouter

• optional bool is_trel_enabled = 1

  Whether TREL is enabled.

• optional uint32 num_trel_peers = 2

  The number of TREL peers.

• optional TrelPacketCounters counters = 3

  TREL packet counters

Used in: TrelInfo

• optional uint64 trel_tx_packets = 1

  The number of packets successfully transmitted through TREL

• optional uint64 trel_tx_bytes = 2

  The number of bytes successfully transmitted through TREL

• optional uint64 trel_tx_packets_failed = 3

  The number of packet transmission failures through TREL

• optional uint64 tre_rx_packets = 4

  The number of packets successfully received through TREL

• optional uint64 trel_rx_bytes = 5

  The number of bytes successfully received through TREL

Used in: DnsServerInfo

• UPSTREAMDNS_QUERY_STATE_UNSPECIFIED = 0

• UPSTREAMDNS_QUERY_STATE_ENABLED = 1

• UPSTREAMDNS_QUERY_STATE_DISABLED = 2

Used in: TelemetryData

• optional BorderRoutingCounters border_routing_counters = 1

  Border routing counters

• optional SrpServerInfo srp_server = 2

  Information about the SRP server

• optional DnsServerInfo dns_server = 3

  Information about the DNS server

• optional MdnsInfo mdns = 4

  Information about the mDNS publisher

• optional BorderRoutingNat64State nat64_state = 6

  Information about the state of components of NAT64

• repeated Nat64Mapping nat64_mappings = 7

  Information about the mappings of NAT64 translator

• optional Dhcp6PdState dhcp6_pd_state = 8

  DHCPv6 PD state

• optional bytes hashed_pd_prefix = 9

  DHCPv6 PD prefix

• optional PdProcessedRaInfo pd_processed_ra_info = 10

  DHCPv6 PD processed RA Info

• optional TrelInfo trel_info = 11

  Information about TREL.

• optional InfraLinkInfo infra_link_info = 12

  Information about the infra link

• optional ExternalRoutes external_route_info = 13

  Information about the external routes in network data.

• optional BorderAgentInfo border_agent_info = 14

  Information about the Border Agent

Used in: TelemetryData

• optional RcpStabilityStatistics rcp_stability_statistics = 1

• optional RcpInterfaceStatistics rcp_interface_statistics = 2

Used in: TelemetryData

• optional int32 phy_rx = 1

• optional int32 phy_tx = 2

• optional int32 mac_unicast_rx = 3

• optional int32 mac_unicast_tx = 4

• optional int32 mac_broadcast_rx = 5

• optional int32 mac_broadcast_tx = 6

• optional int32 mac_tx_ack_req = 7

• optional int32 mac_tx_no_ack_req = 8

• optional int32 mac_tx_acked = 9

• optional int32 mac_tx_data = 10

• optional int32 mac_tx_data_poll = 11

• optional int32 mac_tx_beacon = 12

• optional int32 mac_tx_beacon_req = 13

• optional int32 mac_tx_other_pkt = 14

• optional int32 mac_tx_retry = 15

• optional int32 mac_rx_data = 16

• optional int32 mac_rx_data_poll = 17

• optional int32 mac_rx_beacon = 18

• optional int32 mac_rx_beacon_req = 19

• optional int32 mac_rx_other_pkt = 20

• optional int32 mac_rx_filter_whitelist = 21

• optional int32 mac_rx_filter_dest_addr = 22

• optional int32 mac_tx_fail_cca = 23

• optional int32 mac_rx_fail_decrypt = 24

• optional int32 mac_rx_fail_no_frame = 25

• optional int32 mac_rx_fail_unknown_neighbor = 26

• optional int32 mac_rx_fail_invalid_src_addr = 27

• optional int32 mac_rx_fail_fcs = 28

• optional int32 mac_rx_fail_other = 29

• optional int32 ip_tx_success = 30

• optional int32 ip_rx_success = 31

• optional int32 ip_tx_failure = 32

• optional int32 ip_rx_failure = 33

• optional uint32 node_type = 34

• optional uint32 channel = 35

• optional int32 radio_tx_power = 36

• optional float mac_cca_fail_rate = 37

Used in: TelemetryData

• optional uint32 rloc16 = 1

• optional uint32 router_id = 2

• optional uint32 leader_router_id = 3

• optional bytes leader_address = 5

• optional uint32 leader_weight = 6

• optional uint32 leader_local_weight = 7

• optional bytes network_data = 8

• optional uint32 network_data_version = 9

• optional bytes stable_network_data = 10

• optional uint32 stable_network_data_version = 11

• optional uint32 preferred_router_id = 12

• optional uint32 partition_id = 13

• optional uint32 child_table_size = 14

• optional uint32 neighbor_table_size = 15

• optional int32 instant_rssi = 16

• optional uint64 extended_pan_id = 17

• optional uint32 peer_br_count = 18

  Indicates the number peer BR in Thread mesh network (from network data)