artdaq built-in metric catalog

The following metrics are defined by the artdaq core:

Metric Name	Level	Units	Metric Mode	File:Line	Application(s)	Data Type	Description
Fragment Count	1	fragments	LastPoint	BoardReaderCore.cc:499	BoardReader	unsigned	Number of Fragments sent by this BoardReader
Fragment Rate	1	fragments/sec	Average	BoardReaderCore.cc:500	BoardReader	double	Fragment Rate (sent from BR)
Average Fragment Size	2	bytes/fragment	Average	BoardReaderCore.cc:501	BoardReader	double	Average size of Fragments sent from BoardReader
Data Rate	2	bytes/sec	Average	BoardReaderCore.cc:502	BoardReader	double	Rate of data sending from BoardReader
Avg Input Wait Time	3	seconds/fragment	Average	BoardReaderCore.cc:517	BoardReader	double	Average time spent in getNext calls (retrieving Fragment from CommandableFragmentGenerator)
Avg BoardReader Sync Wait Time	3	seconds/fragment	Average	BoardReaderCore.cc:524	BoardReader	double	DEPRECATED: Amount of time spent waiting at MPI_Barrier
Avg Output Wait Time	3	seconds/fragment	Average	BoardReaderCore.cc:531	BoardReader	double	Average time spent sending Fragments
Avg Frags Per Read	4	fragments/read	Average	BoardReaderCore.cc:538	BoardReader	double	Average number of Fragments returned from getNext
DAQ Transition Time	4	s	Accumulate	Commandable.cc:53 (Multiple locations)	ALL	double	Total time elapsed while in a transition
Last Timestamp	1	Ticks	LastPoint	CommandableFragmentGenerator.cc:313	BoardReader	unsigned long	Timestamp of last Fragment received
Avg Data Acquisition Time	3	s	Average	CommandableFragmentGenerator.cc:601	BoardReader	double	Average amount of time spent in getNext_ when using data thread
Buffer Depth Fragments	1	fragments	LastPoint	CommandableFragmentGenerator.cc:749	BoardReader	int	Number of Fragments in the data buffer (if used)
Buffer Depth Bytes	1	bytes	LastPoint	CommandableFragmentGenerator.cc:750	BoardReader	unsigned long	Total size of the data buffer (if used)
Total Receive Time From Rank	5	s	Accumulate	DataReceiverManager.cc:301	EB, DL, DI	double	Total amount of time spent receiving Fragments from this Rank
Total Receive Size From Rank	5	B	Accumulate	DataReceiverManager.cc:302	EB, DL, DI	unsigned long	Data size received from this rank
Total Receive Rate From Rank	5	B/s	Average	DataReceiverManager.cc:303	EB, DL, DI	double	Data rate from this rank
Header Receive Time From Rank	5	s	Accumulate	DataReceiverManager.cc:305	EB, DL, DI	double	Amount of time spent receiving Fragment headers from this rank (may include some waiting time, up to receive timeout)
Header Receive Size From Rank	5	B	Accumulate	DataReceiverManager.cc:306	EB, DL, DI	unsigned long	Size of Fragment headers received from this rank
Header Receive Rate From Rank	5	B/s	Average	DataReceiverManager.cc:307	EB, DL, DI	double	Rate of Fragment header transfer from this rank. May include up to receive timeout in waiting time.
Data Receive Time From Rank	5	s	Accumulate	DataReceiverManager.cc:310	EB, DL, DI	double	Amount of time spent receiving Fragment data from this rank.
Data Receive Size From Rank	5	B	Accumulate	DataReceiverManager.cc:311	EB, DL, DI	unsigned long	Amount of Fragment data received from this rank (not including headers).
Data Receive Rate From Rank	5	B/s	Average	DataReceiverManager.cc:312	EB, DL, DI	double	Data transfer rate from this rank (excluding headers and Fragment wait time).
Data Receive Count From Rank	3	fragments	LastPoint	DataReceiverManager.cc:314	EB, DL, DI	unsigned long	Number of Fragments received from this rank.
Total Shared Memory Wait Time From Rank	3	s	Accumulate	DataReceiverManager.cc:316	EB, DL, DI	double	Amount of time spent waiting for an available buffer in Shared Memory for Fragments from this rank.
Avg Shared Memory Wait Time From Rank	3	s	Average	DataReceiverManager.cc:317	EB, DL, DI	double	Average amount of time spent waiting for an available buffer in Shared Memory for Fragments from this rank.
Avg Fragment Wait Time From Rank	3	s	Average	DataReceiverManager.cc:318	EB, DL, DI	double	Average amount of time spent waiting for Fragments from this rank (i.e. time between receive of last Fragment and arrival of next Fragment header).
Data Send Time to Rank	5	s	Accumulate	DataSenderManager.cc:546	BR, EB, DL	double	Total time spent sending to this rank.
Data Send Size to Rank	5	B	Accumulate	DataSenderManager.cc:547	BR, EB, DL	unsigned long	Fragment size sent to this rank.
Data Send Rate to Rank	5	B/s	Average	DataSenderManager.cc:548	BR, EB, DL	double	Average rate of sending to this rank.
Data Send Count to Rank	3	fragments	LastPoint	DataSenderManager.cc:549	BR, EB, DL	unsigned long	Number of Fragments sent to this rank.
Routing Table Size	2	events	LastPoint	DataSenderManager.cc:557	BR, EB, DL	unsigned long	Number of entries in the Routing Table
Avg Routing Wait Time	2	s	Average	DataSenderManager.cc:564	BR, EB, DL	double	Average time spent waiting for routing information.
Metric Calls	4	metrics	AccumulateAndRate	MetricManager.cc:411	ALL	unsigned long	Number of Metric calls processed
Missed Metric Calls	4	metrics	AccumulateAndRate	MetricManager.cc:414	ALL	unsigned long	Number of Metric calls discarded due to rate limitations.
Request Response Time	2	seconds	Average	RequestReceiver.cc:316	BR, EB	double	Average amount of time spent between arrival of request and that request being marked complete.
Avg Table Acknowledge Time	3	seconds	Average	RoutingMasterCore.cc:511	RoutingMaster	double	Average time from first attempt to send the table until all acknowledgements received.
Table Update Count	1	updates	LastPoint	RoutingMasterCore.cc:782	RoutingMaster	unsigned long	Number of routing table updates sent.
Table Update Rate	1	updates/sec	Average	RoutingMasterCore.cc:783	RoutingMaster	double	Average rate of table updates.
Average Sender Acknowledgement Time	3	seconds	Average	RoutingMasterCore.cc:784	RoutingMaster	double	DEPRECATED: Amount of time spent sending event tables divided by number of sender ranks receiving tables.
Receiver Token Count	1	updates	LastPoint	RoutingMasterCore.cc:792	RoutingMaster	unsigned long	Number of tokens received.
Receiver Token Rate	1	updates/sec	Average	RoutingMasterCore.cc:793	RoutingMaster	double	Average rate of incoming tokens.
Total Receiver Token Wait Time	3	seconds	Average	RoutingMasterCore.cc:794	RoutingMaster	double	Total time spent waiting for tokens from receivers.
Table Update Interval	3	s	Average	RoutingMasterCore.cc:802	RoutingMaster	double	Average interval between table updates based on RoutingMaster rate calculation.
Input Fragment Rate	1	Fragments/s	Rate	SharedMemoryEventManager.cc:191	EB, DL, DI	double	Rate of Fragment Headers going into Shared Memory
Run Number	1	Run:Subrun	LastPoint	SharedMemoryEventManager.cc:753, 766	EB, DL, DI	double	Current Run and Subrun. Value will be run + subrun/10000
Incomplete Event Count	1	events	LastPoint	SharedMemoryEventManager.cc:858	EB, DL, DI	unsigned long	Number of events in the Shared Memory which are awaiting Fragments. **This metric was renamed “Open Event Count” to reduce confusion
Pending Event Count	1	events	LastPoint	SharedMemoryEventManager.cc:859	EB, DL, DI	unsigned long	Number of events which are complete but not yet released to art.
Incomplete Event Rate	3	events/s	Rate	SharedMemoryEventManager.cc:1089	EB, DL, DI	double	Rate of incomplete events released to art
Event Rate	1	Events/s	Rate	SharedMemoryEventManager.cc:1171	EB, DL, DI	double	Rate of events released to art
Average Event Size	1	Bytes	Average	SharedMemoryEventManager.cc:1173	EB, DL, DI	double	Average size of events released to art
Average Event Building Time	1	s	Average	SharedMemoryEventManager.cc:1174	EB, DL, DI	double	Average amount of time between reception of first Fragment and event’s release to art (complete or incomplete).
Events Released to art this run	1	Events	LastPoint	SharedMemoryEventManager.cc:1178	EB, DL, DI	unsigned long	Number of events released to art in the current run.
Incomplete Events Released to art this run	1	Events	LastPoint	SharedMemoryEventManager.cc:1179	EB, DL, DI	unsigned long	Number of incomplete events released to art in the current run.
Events Released to art this subrun	2	Events	LastPoint	SharedMemoryEventManager.cc:1180	EB, DL, DI	unsigned long	Number of events released to art in the current subrun.
Incomplete Events Released to art this subrun	2	Events	LastPoint	SharedMemoryEventManager.cc:1181	EB, DL, DI	unsigned long	Number of incomplete events released to art in the current subrun.
Tokens sent	2	Tokens	LastPoint	SharedMemoryEventManager.cc:1182	EB, DL, DI	unsigned long	Number of Routing Tokens sent in the current run
Shared Memory Full Buffers	2	buffers	LastPoint	SharedMemoryEventManager.cc:1192	EB, DL, DI	int	Number of buffers currently in the “Full” state, awaiting an art process.
Shared Memory Available Buffers	2	buffers	LastPoint	SharedMemoryEventManager.cc:1193	EB, DL, DI	int	Number of buffers currently in the “Empty” state, available for new events.
Shared Memory Pending Buffers	2	buffers	LastPoint	SharedMemoryEventManager.cc:1194	EB, DL, DI	int	Number of buffers currently in the “Writing” state. Should be equal to the “Open Event Count”.
Shared Memory Reading Buffers	2	buffers	LastPoint	SharedMemoryEventManager.cc:1195	EB, DL, DI	int	Number of buffers currently in the “Reading” state. Should never exceed the number of art processes attached to the Shared Memory.
Shared Memory Full %	2	%	LastPoint	SharedMemoryEventManager.cc:1198	EB, DL, DI	double	Percentage of Shared Memory occupied by complete events waiting on art.
Shared Memory Available %	2	%	LastPoint	SharedMemoryEventManager.cc:1199	EB, DL, DI	double	Percentage of Shared Memory available for new events.
Avg Processing Time	2	s	Average	SharedMemoryReader.hh:458	art	double	Average time between calls to readNext
Avg Input Wait Time	3	s	Average	SharedMemoryreader.hh:459	art	double	Average amount of time between the start of the read loop to obtaining the event
Avg Read Time	3	s	Average	SharedMemoryReader.hh:460	art	double	Average amount of time needed to copy event out of shared memory and put products in principal
bytesRead	3	B	LastPoint	SharedMemoryReader.hh:461	art	unsigned long	Number of bytes read by art
queue%Used	5	%	LastPoint	SharedMemoryReader.hh:462	art	unsigned long	Percentage of shared memory that is full
Fragments Sent	3	Events	LastPoint	ToySimulator_generator.cc:124	BoardReader	unsigned long	Number of Fragments generated by ToySimulator

Notes:

1. BR: BoardReader, EB: EventBuilder, DL: DataLogger, DI: Dispatcher
2. When multiple Applications are listed, whether or not a given component is activated depends on system configuration (i.e. RequestReceiver will not be used by EventBuilders unless the system is “multi-tiered”)
3. DataLogger and Dispatcher metrics may refer to “Fragments”, what they actually mean is “art Events wrapped in Fragments for data transfer”