package
0.0.0-20250304205544-71af207b4383
Repository: https://github.com/mongodb/jasper.git
Documentation: pkg.go.dev

# Functions

GetGlobalLoggerRegistry returns the global logger registry.
MakeCreation takes a command string and returns an equivalent Create struct that would spawn a process corresponding to the given command string.
MergeAbortingPassthroughPostHooks produces a post hook that returns the error of the first post hook passed that does not return nil.
MergeAbortingPostHooks produces a post hook that returns the first error returned by one of it's argument functions, and returns nil if no function returns an error.
MergePostHooks runs all post hooks, collecting the errors and merging them.
MergePreHooks produces a single PreHook function that runs all defined prehooks.
NewBasicLoggerRegistry returns a new LoggerRegistry implementation.
NewBuildloggerV2LoggerProducer returns a LoggerProducer for creating Buildlogger v2 loggers.
NewDefaultLoggerProducer returns a LoggerProducer backed by DefaultLoggerOptions.
NewDefaultLoggingPreHook uses the global grip logger to log a debug message at the specified priority level.
NewFileLoggerProducer returns a LoggerProducer backed by FileLoggerOptions.
NewInheritedLoggerProducer returns a LoggerProducer for creating inherited loggers.
NewInMemoryLoggerProducer returns a LoggerProducer for creating in-memory loggers.
NewLoggerConfig returns a LoggerConfig with the given info.
NewLoggingPreHook provides a logging message for debugging purposes that prints information from the creation options.
NewLoggingPreHookFromSender produces a logging prehook that wraps a sender.
NewSafeSender returns a grip send.Sender with the given base options.
NewSplunkLoggerProducer returns a LoggerProducer for creating Splunk loggers.

# Constants

All is a filter that is satisfied by any process.
ArchiveAuto is an ArchiveFormat that does not force any particular type of archive format.
ArchiveTarGz is an ArchiveFormat for gzipped tar archives.
ArchiveZip is an ArchiveFormat for Zip archives.
DefaultLogName is the default name for logs emitted by Jasper.
Failed refers to processes that have terminated unsuccessfully.
LogBuildloggerV2 is the name for the Buildlogger v2 logger.
LogDefault is the name for the default logger.
LogFile is the name for the file logger.
Constants representing formats for logging.
Constants representing formats for logging.
Constants representing formats for logging.
Constants representing formats for logging.
Constants representing logging payload formats for SendMessages.
Constants representing logging payload formats for SendMessages.
Constants representing logging payload formats for SendMessages.
LogInherited is the name for the inherited logger.
LogInMemory is the name for the in-memory logger.
LogSplunk is the name for the Splunk logger.
ProcessImplementationBasic suggests that the process constructor use a basic implementation.
ProcessImplementationBlocking suggests that the process constructor use a blocking implementation.
Constants representing valid formats for RawLoggerConfig.
Constants representing valid formats for RawLoggerConfig.
Constants representing valid formats for RawLoggerConfig.
Running is a filter for processes that have not yet completed and are still running.
Successful refers to processes that have terminated successfully.
Terminated is the opposite of the Running filter.

# Structs

Archive encapsulates options related to management of archive files.
BaseOptions are the base options necessary for setting up most loggers.
BufferOptions packages options for whether or not a Logger should be buffered and the duration and size of the respective buffer in the case that it should be.
BuildloggerV2Options encapsulates the options for creating a Buildlogger v2 logger.
Cache represent the configuration options for the LRU cache.
CachedLogger is the cached item representing a process's output.
Command represents jasper.Command options that are configurable by the user.
Create contains options related to starting a process.
DefaultLoggerOptions encapsulates the options for creating a logger that logs to the native standard streams (i.e.
Download represents the options to download a file to a given path and optionally extract its contents.
FileLoggerOptions encapsulates the options for creating a file logger.
InheritedLoggerOptions encapsulates the options for creating a logger inherited from the globally-configured grip logger.
InMemoryLoggerOptions encapsulates the options for creating an in-memory logger.
LoggerConfig represents the necessary information to construct a new grip send.Sender.
LoggingPayload captures the arguments to the SendMessages operation.
MongoDBDownload represents the options to download MongoDB on a target platform.
Output provides a common way to define and represent the output behavior of a evergreen/subprocess.Command operation.
Remote represents options to SSH into a remote machine.
RemoteConfig represents the arguments to connect to a remote host.
SafeSender wraps a grip send.Sender and its base sender, ensuring that the base sender is closed correctly.
SplunkLoggerOptions encapsulates the options for creating a Splunk logger.
WriteFile represents the options necessary to write to a file.

# Interfaces

LoggerProducer produces a Logger interface backed by a grip logger.
LoggerRegistry is an interface that stores reusable logger factories.

# Type aliases

ArchiveFormat represents an archive file type.
CommandPostHook describes a common function type to run after the command completes and processes its error, potentially overriding the output of the command.
CommandPreHook describes a common function type to run before sub-commands in a command object and can modify the state of the command.
Filter is type for classifying and grouping types of processes in filter operations, such as that found in List() on Managers.
LogFormat specifies a certain format for logging by Jasper.
LoggerProducerFactory creates a new instance of a LoggerProducer implementation.
LoggingPayloadFormat is an set enumerated values describing the formating or encoding of the payload data.
RawLoggerConfig wraps byte slice and implements the json and bson Marshaler and Unmarshaler interfaces.
RawLoggerConfigFormat describes the format of the raw logger configuration.