# Packages
No description provided by the author
# Functions
DetectFormatFrom uses the start of a marshalled header to determine what unmarshaller should be used to decode the header and all following samples.
No description provided by the author
GuessEndpointDescription guesses the transport type and format of the given endpoint target.
GuessEndpointType guesses the EndpointType for the given target.
No description provided by the author
IsConsoleOutput returns true if the given processor will output to the standard output when started.
IsFileClosedError returns true, if the given error likely originates from intentionally closing a file, while it is still being read concurrently.
IsValidFilename tries to infer in a system-independent way, if the given path is a valid file name.
NewBufferedWriteCloser creates a BufferedWriteCloser instance wrapping the writer parameter.
NewConsoleSink creates a SampleSink that writes to the standard output.
NewConsoleSource creates a SampleSource that reads from the standard input.
NewEndpointFactory returns an EndpointFactory object filled with default values.
NewFileGroup returns a new FileGroup instance.
No description provided by the author
NewTcpListenerSource creates a new instance of TCPListenerSource listening on the given TCP endpoint.
RequiredValues the number of Values that should be large enough to hold the end-result after processing a Sample by all intermediate SampleProcessors.
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
This is arbitrary and was chosen human-readable for convenience.
BinarySeparator is the character separating fields in the marshalled output of BinaryMarshaller.
Must not collide with DefaultCsvTimeColumn, but have same length.
No description provided by the author
No description provided by the author
CsvDateFormat is the format used by CsvMarshaller to marshall the timestamp of samples.
CsvNewline is used by CsvMarshaller after outputting the header line and each sample.
CsvSeparator is the character separating fields in the marshalled output of CsvMarshaller.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MaxOutputFileErrors is the number of retries that are accepted before giving up to open a new output file.
Needed for auto-detecting stream format.
MkdirsPermissions defines the permission bits used when creating new directories for storing output files.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TextMarshallerDateFormat is the date format used by TextMarshaller to print the timestamp of each sample.
TextMarshallerDefaultSpacing is the default spacing between the columns printed by TextMarshaller.
TextMarshallerHeaderChar is used as fill-character in the header line preceding each sample marshalled by TextMarshaller.
No description provided by the author
No description provided by the author
# Variables
StopWalking can be returned from the walk function parameter for WalkFiles to indicate, that the tree should not be walked any further down the current directory.
No description provided by the author
# Structs
AbstractMarshallingSampleOutput is a partial implementation of MarshallingSampleOutput with a simple implementation of SetMarshaller().
AbstractSampleOutput is a partial implementation of SampleProcessor intended for processors that output samples to an external data sink (e.g.
AbstractSampleProcessor provides a few basic methods for implementations of SampleProcessor.
AbstractSampleSource is a partial implementation of SampleSource that stores the SampleProcessor and closes the outgoing SampleProcessor after all samples have been generated.
AbstractTcpSink is a helper type for TCP-based SampleSink implementations.
AbstractUnmarshallingSampleSource extends AbstractSampleSource by adding configuration fields required for unmarshalling samples.
No description provided by the author
BinaryMarshaller marshalled every sample to a dense binary format.
BufferedWriteCloser is a helper type that wraps a bufio.Writer around a io.WriteCloser, while still implementing the io.WriteCloser interface and forwarding all method calls to the correct receiver.
ClosedSampleSource implements SampleSource, but instead generating samples, it immediately closes.
CsvMarshaller marshals Headers and Samples to a CSV format.
DroppingSampleProcessor implements the SampleProcessor interface by dropping any incoming samples.
EmptySampleSource implements SampleSource but does not generate any samples.
EndpointDescription describes a data endpoint, regardless of the data direction (input or output).
EndpointFactory creates SampleSink and SampleSource instances for a SamplePipeline.
FileGroup provides utility functionality when dealing with a group of files sharing the same directory, file prefix and file extension.
FileSink is an implementation of SampleSink that writes output Headers and Samples to a given file.
FileSource is an implementation of UnmarshallingSampleSource that reads samples from one or more files.
Header defines the structure of samples that belong to this header.
HeaderChecker is a helper type for implementations of SampleSink to find out, when the incoming header changes.
HttpServerSink implements the SampleSink interface as an HTTP server.
No description provided by the author
KeyValuePair represents a key-value string pair.
NoopProcessor is an empty implementation of SampleProcessor.
ParallelSampleHandler is a configuration type that is included in SampleReader and SampleWriter.
ProcessorTaskWrapper can be used to convert an instance of SampleProcessor to a golib.Task.
ReaderSource implements the SampleSource interface by reading Headers and Samples from an arbitrary io.ReadCloser instance.
Sample contains an array of Values, a timestamp, and a string-to-string map of tags.
SampleAndHeader is a convenience type combining pointers to a Sample and a Header.
SampleHeaderIndex builds a `map[string]int` index of the fields of a Header instance.
SampleInputStream represents one input stream of Headers and Samples that reads and parses data from one io.ReadCloser instance.
SampleMetadata is a helper type containing the timestamp and the tags of a Sample.
SampleOutputStream represents one open output stream that marshals and writes Headers and Samples in parallel.
SamplePipeline reads data from a source and pipes it through zero or more SampleProcessor instances.
SampleReader is used to read Headers and Samples from an io.Reader, parallelizing the reading and parsing procedures.
SampleRing is a one-way circular queue of Sample instances.
SampleWriter implements parallel writing of Headers and Samples to an instance of io.WriteCloser.
No description provided by the author
No description provided by the author
No description provided by the author
SourceTaskWrapper can be used to convert an instance of SampleSource to a golib.Task.
SynchronizedReadCloser is a helper type to wrap *os.File and synchronize calls to Read() and Close().
SynchronizingSampleSink is a SampleSink implementation that allows multiple goroutines to write data to the same sink and synchronizes these writes through a mutex.
No description provided by the author
TCPConnCounter contains the TcpConnLimit configuration parameter that optionally defines a limit for the number of TCP connection that are accepted or initiated by the SampleSink and SampleSource implementations using TCP connections.
TCPListenerSink implements the SampleSink interface through a TCP server.
TCPListenerSource implements the SampleSource interface as a TCP server.
TCPSink implements SampleSink by sending the received Headers and Samples to a given remote TCP endpoint.
TCPSource implements the SampleSource interface by connecting to a list of remote TCP endpoints and downloading Header and Sample data from there.
TcpWriteConn is a helper type for TCP-base SampleSink implementations.
TextMarshaller marshals Headers and Samples to a human readable test format.
No description provided by the author
UnmarshalledHeader extends a Header by adding a flag that indicated whether the unmarshalled samples will contain tags or not.
WriteCascade is a helper type for more concise Write code by avoiding error checks on every Write() invocation.
WriterSink implements SampleSink by writing all Headers and Samples to a single io.WriteCloser instance.
# Interfaces
No description provided by the author
BidiMarshaller is a bidirectional marshaller that combines the Marshaller and Unmarshaller interfaces.
ConsoleSampleSink is a marking interface for SampleSink implementations that notifies the framework that the sink writes to the standard output.
Marshaller is an interface for converting Samples and Headers into byte streams.
MarshallingSampleOutput is a SampleProcessor that outputs the received samples to a byte stream that is generated by a Marshaller instance.
MergeableProcessor is an extension of SampleProcessor, that also allows merging two processor instances of the same time into one.
ReadSampleHandler defines a hook for modifying unmarshalled Samples.
No description provided by the author
ResizingSampleProcessor is a helper interface that can be implemented by SampleProcessors in order to make RequiredValues() more reliable.
SampleProcessor is the basic interface to receive and process samples.
A SampleSink receives samples and headers to do arbitrary operations on them.
SampleSource is the interface used for producing Headers and Samples.
No description provided by the author
Unmarshaller is an interface for reading Samples and Headers from byte streams.
UnmarshallingSampleSource extends SampleSource and adds a configuration setter that gives access to the samples that are read by this data source.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
String is a trivial implementation of the fmt.Stringer interface.
Value is a type alias for float64 and defines the type for metric values.