package
7.17.28
Repository: https://github.com/elastic/beats.git
Documentation: pkg.go.dev

# Functions

IsTraceFSAvailable returns nil if a tracefs or debugfs supporting KProbes is available at the well-known paths.
IsTraceFSAvailableAt returns nil if the path passed is a mounted tracefs or debugfs that supports KProbes.
NewCPUSetFromExpression creates a new CPUSet from a range expression.
NewCPUSetFromFile creates a new CPUSet from the contents of a file.
NewDumpDecoder returns a new decoder that will dump all the arguments as a byte slice.
NewMapDecoder creates a new decoder that will parse raw tracing events into a map[string]interface{}.
NewPerfChannel creates a new perf channel in order to receive events from one or more probes.
NewStructDecoder creates a new decoder that will parse raw tracing events into a struct.
NewTraceFS creates a new accessor for the event tracing feature.
NewTraceFSWithPath creates a new accessor for the event tracing feature at the given path.
WithBufferSize configures the capacity of the channel used to pass tracing events (PerfChannel.C()).
WithErrBufferSize configures the capacity of the channel used to pass errors.
WithLostBufferSize configures the capacity of the channel used to pass lost event notifications (PerfChannel.LostC()).
WithPollTimeout configures for how long the reader thread can block waiting for events.
WithRingSizeExponent configures the size, in pages, of the ringbuffers used by the kernel to pass events to userspace.
WithTID configures the thread ID to monitor.
WithTimestamp enables the returned tracing events to be timestamped.

# Constants

FieldTypeInteger describes a fixed-size integer field.
FieldTypeMeta describes the metadata.
FieldTypeRaw describes a field of raw bytes.
FieldTypeString describes a string field.
IsolatedCPUsPath is only present when CPU isolation is active, for example using the `isolcpus` kernel argument.
OfflineCPUsPath is the path to the system file listing the offline CPUs.
OnlineCPUsPath is the path to the system file listing the online CPUs.
PossibleCPUsPath is the path to the system file listing the CPUs that can be brought online.
PresentCPUsPath is the path to the system file listing the CPUs that are identified as present.
TypeKProbe represents a KProbe.
TypeKRetProbe represents a regular KRetProbe.
TypeUProbe represents a UProbe.
TypeURetProbe represents a URetProbe.

# Variables

ErrAlreadyRunning error is returned when a PerfChannel has already started after a call to run.
ErrNotRunning error is returned by PerfChannel#Close when it has not been started.
ErrUnsupported error indicates that perf_event_open is not available in the current kernel.
MachineEndian is either binary.BigEndian or binary.LittleEndian, depending on the current architecture.

# Structs

CPUSet represents a group of CPUs.
Field describes a field returned by a event tracing probe.
Metadata struct contains the information stored in a trace event header.
PerfChannel represents a channel to receive perf events.
Probe represents a probe ([KU](Ret)?Probe).
ProbeFormat describes a Probe and the serialisation format used to encode its arguments into a tracing event.
TraceFS is an accessor to manage event tracing via tracefs or debugfs.

# Interfaces

Decoder decodes raw events into an usable type.

# Type aliases

AllocateFn is the type of a function that allocates a custom struct to be used with StructDecoder.
FieldType describes the type of a field in a event tracing probe.
PerfChannelConf instances change the configuration of a perf channel.
ProbeType represents the type of a probe.