caproto.server.stats.MemoryTracingHelper

class caproto.server.stats.MemoryTracingHelper(*args, filters: List[Filter] | None = None, **kwargs)

A helper which quickly allows for tracing memory usage and allocations on a caproto server instance.

Parameters:

prefixstr

Prefix for all PVs in the group

macrosdict, optional

Dictionary of macro name to value

parentPVGroup, optional

Parent PVGroup

namestr, optional

Name for the group, defaults to the class name

statesdict, optional

A dictionary of states used for channel filtering. See https://epics.anl.gov/base/R3-15/5-docs/filters.html

filterslist of tracemalloc.Filter, optional

Filters to apply to the snapshot. Defaults to TRACEMALLOC_FILTERS.

MemoryTracingHelper pvproperties

Attribute	Suffix	Docs	Type	Notes	Alarm Group
diff_results	TraceDiffResults	Trace diff from snapshot to snapshot	str (waveform)	Read-only Length(20000)
enable_tracing	EnableTracing	Enable/disable in-depth memory analysis	ENUM (bo)
top_allocations	TraceTopAllocations	Top allocations in snapshot	str (waveform)	Read-only Length(20000)
trace_count	TraceCount	Number of top allocations to view	int (ao)

Methods

group_read(instance)	Generic read called for channels without get defined
group_write(instance, value)	Generic write called for channels without put defined

Attributes

default_values
type_map
type_map_read_only
filters
pvdb
attr_pvdb
attr_to_pvname
groups

pvproperty methods