package
0.0.0-20250225160627-a5c4e050d9d8
Repository: https://github.com/mongodb/ftdc.git
Documentation: pkg.go.dev
# Functions
MakeCustom creates a Custom slice with the specified size hint.
NewBasicCollector produces a collector implementation that adds Performance points to the underlying FTDC collector.
NewGroupedRecorder blends the single and the interval recorders, but it persists during the EndIteration call only if the specified interval has elapsed.
NewHistogramGroupedRecorder captures data and stores them with a histogram format.
No description provided by the author
NewHistogramRecorder collects data and stores them with a histogram format.
No description provided by the author
NewIntervalCollector constructs a Collector collapses events as in the other collector implementations, but will record at most a single event per interval.
NewIntervalHistogramRecorder has similar semantics to histogram Grouped recorder, but has a background process that persists data on the specified on the specified interval rather than as a side effect of the EndTest call.
NewIntervalRecorder has similar semantics to histogram Grouped recorder, but has a background process that persists data on the specified on the specified interval rather than as a side effect of the EndTest call.
NewPassthroughCollector constructs a collector that does not sum Performance events and just passes them directly to the underlying collector.
NewRandomSamplingCollector constructs a Collector that uses a psudorandom number generator (go's standard library math/rand) to select how often to record an event.
NewRawRecorder records a new event every time that the EndIteration method is called.
NewSamplingCollector constructs a collector that has the same semantics as the basic, adding all sampled documents together, but only persisting every n-th sample to the underlying collector.
NewShimRecorder takes a recorder and acts as a thin recorder, using the TimeManager interface for relevant Begin & End values.
NewSingleHistogramRecorder collects data and stores them with a histogram format.
NewSingleRecorder records a single event every time the EndTest method is called, and otherwise just adds all counters and timing information to the underlying point.
NewSynchronizedCollector wraps another collector and wraps all required calls with the correct lock.
NewSynchronizedRecorder wraps a recorder implementation that is not concurrent safe in a recorder implementation that provides safe concurrent access without modifying the semantics of the recorder.
# Structs
CustomPoint represents a computed statistic as a key value pair.
Performance represents a single raw event in a metrics collection system for performance metric collection system.
PerformanceCounters refer to the number of operations/events or total of things since the last collection point.
No description provided by the author
PerformanceGauges holds simple counters that aren't expected to change between points, but are useful as annotations of the experiment or or descriptions of events in the system configuration.
PerformanceHDR the same as the Performance structure, but with all time duration and counter values stored as histograms.
PerformanceTimers refers to all of the timing data for this event.
No description provided by the author
# Interfaces
Collector wraps the ftdc.Collector interface and adds specific awareness of the Performance type from this package.
Recorder describes an interface that tests can use to track metrics and events during performance testing or normal operation.
TimerManager is a subset of the testing.B tool, used to manage setup code.
# Type aliases
Custom is a collection of data points designed to store computed statistics at an interval.