# History Tracker

# History Tracker

This module includes configuration variables for History Tracker.

## Summary

| ### Macros ||
|---|---|
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gae6f4b6dba69736fd5abed7f840a65f61 32` | Specifies the maximum number of entries in BR AIL Router history. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gac34f30edd5ba1a9bede900f0f72a95f9 OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE` | Define as 1 to enable History Tracker Client module (using TMF history query to retrieve history info from other devices). |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga662a7c94d586dd142b7d3d33b94e39dd 16` | Specifies the maximum number of entries in DHCPv6-PD history. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga5888fc45c5d69105c029183ed450536e 32` | Specifies the maximum number of entries in Network Data DNS/SRP Address history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga14ebb137ecbc663679f85276305a95ec 0` | Define as 1 to enable History Tracker module. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga7ec8ec00d3b6c2551295bf3a3d1f3bea 64` | Specifies the maximum number of entries in Border Agent ePSKc history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gad0491ef02a948c29f9c6aca81adf06d9 1` | Define as 1 to exclude Thread Control message (e.g., MLE, TMF) from TX and RX history. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gafbd4b14e528725c31e6cb957c91f71ba 32` | Specifies the maximum number of entries in Network Data External Route history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga10d94eddbf398f3bb7b926cd997aa1c0 20` | Specifies the maximum number of entries in multicast IPv6 address history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gac56a4bc0d4e7997347fc6159886db91d 64` | Specifies the maximum number of entries in neighbor table history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gaa3b6bf35bd9b30b30190fa1523ef708d 32` | Specifies the maximum number of entries in Network Info (role, mode, partition ID, RLOC16) history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gac32ae49ec43e2f02099fb3208bcf8fe2 16` | Specifies the maximum number of entries in OMR Prefix history. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gafec62126707383b16538326f84240337 16` | Specifies the maximum number of entries in On-Link Prefix (on AIL) history. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga79137cefc0d9a01424d0b198a73e6e9f 32` | Specifies the maximum number of entries in Network Data On Mesh Prefix history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga887fd2410d2c2c55a72f38cfe95874ba 256` | Specifies the maximum number of entries in router table history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga1cb65c699723a407402aa2fdd73eb62a 32` | Specifies the maximum number of entries in RX history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1ga007e57b97461ee2e7792a553724a358b OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE` | Define as 1 to enable History Tracker Server module (answering received TMF history queries). |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gadeebe4fd0f6dab5f3b583613bd3992ca 32` | Specifies the maximum number of entries in TX history list. |
| `https://openthread.io/reference/config/group/config-history-tracker#group__config-history-tracker_1gadba7beb5470c4c666e7d74faa939b4e2 20` | Specifies the maximum number of entries in unicast IPv6 address history list. |

## Macros

### OPENTHREAD_CONFIG_HISTORY_TRACKER_AIL_ROUTER_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_AIL_ROUTER_LIST_SIZE 32
```
Specifies the maximum number of entries in BR AIL Router history.

Can be set to zero to configure History Tracker module not to collect any BR AIL Router info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_CLIENT_ENABLE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_CLIENT_ENABLE OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
```
Define as 1 to enable History Tracker Client module (using TMF history query to retrieve history info from other devices).

### OPENTHREAD_CONFIG_HISTORY_TRACKER_DHCP6_PD_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_DHCP6_PD_LIST_SIZE 16
```
Specifies the maximum number of entries in DHCPv6-PD history.

Can be set to zero to configure History Tracker module not to collect any DHCPv6-PD info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_DNSSRP_ADDR_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_DNSSRP_ADDR_LIST_SIZE 32
```
Specifies the maximum number of entries in Network Data DNS/SRP Address history list.

Set to zero to prevent the History Tracker module from collecting this info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE 0
```
Define as 1 to enable History Tracker module.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_EPSKC_EVENT_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_EPSKC_EVENT_SIZE 64
```
Specifies the maximum number of entries in Border Agent ePSKc history list.

Can be set to zero to configure History Tracker module not to collect any ePSKc journey info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES 1
```
Define as 1 to exclude Thread Control message (e.g., MLE, TMF) from TX and RX history.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE 32
```
Specifies the maximum number of entries in Network Data External Route history list.

Can be set to zero to configure History Tracker module not to collect route info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_MULTICAST_ADDRESS_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_MULTICAST_ADDRESS_LIST_SIZE 20
```
Specifies the maximum number of entries in multicast IPv6 address history list.

Can be set to zero to configure History Tracker module not to collect any entries.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_NEIGHBOR_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_NEIGHBOR_LIST_SIZE 64
```
Specifies the maximum number of entries in neighbor table history list.

Can be set to zero to configure History Tracker module not to collect any neighbor table history.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE 32
```
Specifies the maximum number of entries in Network Info (role, mode, partition ID, RLOC16) history list.

Can be set to zero to configure History Tracker module not to collect any entries.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_OMR_PREFIX_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_OMR_PREFIX_LIST_SIZE 16
```
Specifies the maximum number of entries in OMR Prefix history.

Can be set to zero to configure History Tracker module not to collect any OMR prefix info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_LINK_PREFIX_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_LINK_PREFIX_LIST_SIZE 16
```
Specifies the maximum number of entries in On-Link Prefix (on AIL) history.

Can be set to zero to configure History Tracker module not to collect any on-link prefix info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_MESH_PREFIX_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_MESH_PREFIX_LIST_SIZE 32
```
Specifies the maximum number of entries in Network Data On Mesh Prefix history list.

Can be set to zero to configure History Tracker module not to collect prefix info.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_ROUTER_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_ROUTER_LIST_SIZE 256
```
Specifies the maximum number of entries in router table history list.

Can be set to zero to configure History Tracker module not to collect any router table history.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_RX_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_RX_LIST_SIZE 32
```
Specifies the maximum number of entries in RX history list.

Can be set to zero to configure History Tracker module not to collect any RX history.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_SERVER_ENABLE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_SERVER_ENABLE OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE
```
Define as 1 to enable History Tracker Server module (answering received TMF history queries).

### OPENTHREAD_CONFIG_HISTORY_TRACKER_TX_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_TX_LIST_SIZE 32
```
Specifies the maximum number of entries in TX history list.

Can be set to zero to configure History Tracker module not to collect any TX history.

### OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE

```
 OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE 20
```
Specifies the maximum number of entries in unicast IPv6 address history list.

Can be set to zero to configure History Tracker module not to collect any entries.

## Resources

OpenThread API Reference topics originate from the source code, available
on [GitHub](https://github.com/openthread/openthread/tree/main/include/openthread).
For more information, or to contribute to our documentation, refer to
[Resources](https://openthread.io/resources).