| commit | 2798cc9c05e04d84d57f1d627db5cde1099aaeba | [log] [tgz] |
|---|---|---|
| author | Abtin Keshavarzian <abtink@google.com> | Thu Aug 12 15:47:26 2021 -0700 |
| committer | GitHub <noreply@github.com> | Thu Aug 12 15:47:26 2021 -0700 |
| tree | 7f970bbcc31317193a10742f0d0fd55589c30f1a | |
| parent | 59f7a9aed641bbcce2f06f38e380c8b76b0bcf00 [diff] |
[utils] adding `HistoryTracker` module (#6807) This commit adds History Tracker feature and its CLI support. This feature records history of different events as the Thread network operates (e.g., history of RX and TX IPv6 messages or network info changes). Recorded entries are timestamped. When the history list is read, the timestamps are given as the entry age relative to the time the list is being read. For example in CLI a timestamp can be shown as `02:31:50.628 ago` indicating the entry was recorded 2 hours, 31 min, 50 sec, and 628 msec ago. Number of days is added for events that are older than 24 hours, e.g., `31 days 03:00:23.931 ago`. Timestamps use millisecond accuracy and are tacked up to 49 days. If an event is older than 49 days, the entry is still tracked in the list but the timestamp is shown as old or `more than 49 days ago`. The `HistoryTracker` currently maintains 3 lists. The Network Info history tracks changes to Device Role, Mode, RLOC16 and Partition ID. The RX/TX history list records information about the received/sent IPv6 messages: - Message type (UDP, TCP, ICMP6 (and its subtype), etc.) - Source and destination IPv6 addresses and port numbers - IPv6 payload length - The message checksum (for UDP, TCP, or ICMP6). - Whether or not the link-layer security was used - Message priority: low, norm, high, net (for control messages) - Short address (RLOC16) of neighbor who send/received the msg - Received Signal Strength (in dBm) for RX only - Radio link info (15.4/TREL) on which msg was sent/received (useful when `OPENTHREAD_CONFIG_MULTI_RADIO` is enabled) Config `HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES` can be used to configure `HistoryTracker` to exclude Thread Control message (e.g., MLE, TMF) from TX and RX history. The number of entries recorded for each history list is configurable through a set of OpenThread config options, e.g., number of entries in Network Info history list is specified by OpenThread config option `OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE`. The `HistoryTracker` will keep the most recent entries overwriting oldest ones when the list gets full. This commit also adds support for `HistoryTracker` in CLI. The CLI commands provide two style for printing the history information: A table format (more human-readable) and list style (better suited for parsing by machine/code). `README_HISTORY.md` is added to document the commands and the info provided by each history list entry. This commit also adds `test_history_tracker.py` test-case which covers the behavior of `HistoryTracker`.
OpenThread released by Google is...
...an open-source implementation of the Thread networking protocol. Google Nest has released OpenThread to make the technology used in Nest products more broadly available to developers to accelerate the development of products for the connected home.
...OS and platform agnostic, with a narrow platform abstraction layer and a small memory footprint, making it highly portable. It supports both system-on-chip (SoC) and network co-processor (NCP) designs.
...a Thread Certified Component, implementing all features defined in the Thread 1.1.1 specification, including all Thread networking layers (IPv6, 6LoWPAN, IEEE 802.15.4 with MAC security, Mesh Link Establishment, Mesh Routing) and device roles, as well as Border Router support.
More information about Thread can be found at threadgroup.org. Thread is a registered trademark of the Thread Group, Inc.
All end-user documentation and guides are located at openthread.io. If you're looking to do things like...
...then openthread.io is the place for you.
Note: For users in China, end-user documentation is available at openthread.google.cn.
If you're interested in contributing to OpenThread, read on.
We would love for you to contribute to OpenThread and help make it even better than it is today! See our Contributing Guidelines for more information.
Contributors are required to abide by our Code of Conduct and Coding Conventions and Style Guide.
OpenThread follows the Semantic Versioning guidelines for release cycle transparency and to maintain backwards compatibility. OpenThread's versioning is independent of the Thread protocol specification version but will clearly indicate which version of the specification it currently supports.
OpenThread is released under the BSD 3-Clause license. See the LICENSE file for more information.
Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group.
There are numerous avenues for OpenThread support:
openthread tagThe openthread-users Google Group is the recommended place for users to discuss OpenThread and interact directly with the OpenThread team.