Viewing State and Statistics Files

Enhanced PTP User Guide (UG1602)

Document ID
UG1602
Release Date
2022-10-18
Revision
1.0 English

On a server using sfptpd, PTP alarms, status and performance data is accumulated in files created in the following directory:

/var/lib/sfptpd

From these files you can monitor the performance and status of sfptpd and the PTP server.

The following table lists statistics files created by sfptpd.

Table 1. Statistics Files Created by sfptpd
Filename Persistent Description See
freq-correction-system YES Contains the frequency correction value used to discipline the server system clock. Frequency Correction Files
freq-correction-<UUID> YES Contains the frequency correction value used to discipline the clock identified by the UUID identifier. Frequency Correction Files
interfaces NO Identifies all adapters, and their timestamping capabilities. Interfaces File
ptp-nodes NO Identifies all PTP clocks present in the network. PTP Nodes File
state-system NO The contents of this file depend on the current PTP mode. In slave mode this file contains historical offset and status data for the slave server. State Files
state-<sync_module> or state-<clock_UUID> NO Contains status information relevant to the identified sync module or clock. State Files
stats-system NO Contains accumulated PTP performance data for the server including counts of the PTP message types sent and received. Stats Files
stats-<sync_module> or stats-<clock_UUID> NO

Contains aggregated/summarized synchronization data for the identified sync module or clock.

From version 3.2.1 stats files are automatically generated and in txt and JSON formats.

Stats Files
topology NO

PTP clock hierarchy diagram showing all clocks local to the slave server and PTP network elements between the slave and master clock.

Identifies the timestamping mode (HW or SW).

Displays active PTP alarms.

Topology file
version NO Contains the sfptpd version. Version File

File Persistence

Of all the files created, the freq-correction-* files are persistent and will be preserved over sfptpd restart and over server reboot. All other files are non-persistent and are created when sfptpd is started.

File Update Rate

The topology file and ptp-nodes file will update immediately to reflect changes in the ptp network topology or alarm conditions.

Alarms will also be updated immediately in clock state files.

Stats files are updated every 60 seconds.