import "github.com/cockroachdb/cockroach/pkg/util/log"
Package log implements logging. There are three logging styles: named, V-style, events.
The functions Info, Warning, Error, and Fatal log their arguments at the specified level. All include formatting variants like Infof.
Examples:
log.Info(ctx, "Prepare to repel boarders") log.Fatal(ctx, "Initialization failed", err) log.Infof(ctx, "client error: %s", err)
The V functions can be used to selectively enable logging at a call site. Invoking the binary with --vmodule=*=N will enable V functions at level N or higher. Invoking the binary with --vmodule="glob=N" will enable V functions at level N or higher with a filename matching glob.
Examples:
if log.V(2) {
log.Info(ctx, "Starting transaction...")
}
The Event functions log messages to an existing trace if one exists. The VEvent functions logs the message to a trace and also the log file based on the V level.
Examples:
log.VEventf(ctx, 2, "client error; %s", err)
Log output is buffered and written periodically using Flush. Programs should call Flush before exiting to guarantee all log output is written.
By default, all log statements write to files in a temporary directory. This package provides several flags that modify this behavior. These are provided via the util/log/logflags package; see InitFlags.
--logtostderr=LEVEL Logs are written to standard error as well as to files. Entries with severity below LEVEL are not written to stderr. "true" and "false" are also supported (everything / nothing). --log-dir="..." Log files will be written to this directory instead of the default target directory. --log-file-verbosity=LEVEL Entries with severity below LEVEL are not written to the log file. "true" and "false" are also supported (everything / nothing). --log-file-max-size=N Log files are rotated after reaching that size. --log-dir-max-size=N Log files are removed after log directory reaches that size.
Other flags provide aids to debugging.
--vmodule=""
The syntax of the argument is a comma-separated list of pattern=N,
where pattern is a literal file name (minus the ".go" suffix) or
"glob" pattern and N is a V level. For instance,
--vmodule=gopher*=3
sets the V level to 3 in all Go files whose names begin "gopher".
Autogenerated:
ambient_context.go backtrace_trigger.go clog.go crash_reporting.go doc.go every_n.go exit_override.go file.go flags.go get_stacks.go intercept.go log.go log.pb.go log_bridge.go log_buffer.go log_entry.go log_flush.go log_gc.go reportables.go secondary_log.go severity.go stderr_redirect.go stderr_redirect_unix.go structured.go sync_buffer.go test_log_scope.go trace.go tracebacks.go vmodule.go
const FileNamePattern = `(?P<program>[^/.]+)\.(?P<host>[^/\.]+)\.` +
`(?P<user>[^/\.]+)\.(?P<ts>[^/\.]+)\.(?P<pid>\d+)\.log`FileNamePattern matches log files to avoid exposing non-log files accidentally and it splits the details of the filename into groups for easy parsing. The log file format is
{program}.{host}.{username}.{timestamp}.{pid}.log
cockroach.Brams-MacBook-Pro.bram.2015-06-09T16-10-48Z.30209.log
All underscore in process, host and username are escaped to double underscores and all periods are escaped to an underscore. For compatibility with Windows filenames, all colons from the timestamp (RFC3339) are converted from underscores (see FileTimePattern). Note this pattern is unanchored and becomes anchored through its use in LogFilePattern.
const FilePattern = "^(?:.*/)?" + FileNamePattern + "$"
FilePattern matches log file paths.
const FileTimeFormat = "2006-01-02T15_04_05Z07:00"FileTimeFormat is RFC3339 with the colons replaced with underscores. It is the format used for timestamps in log file names. This removal of colons creates log files safe for Windows file systems.
const MessageTimeFormat = "060102 15:04:05.999999"MessageTimeFormat is the format of the timestamp in log message headers as used in time.Parse and time.Format.
var (
// DiagnosticsReportingEnabled wraps "diagnostics.reporting.enabled".
//
// "diagnostics.reporting.enabled" enables reporting of metrics related to a
// node's storage (number, size and health of ranges) back to CockroachDB.
// Collecting this data from production clusters helps us understand and improve
// how our storage systems behave in real-world use cases.
//
// Note: while the setting itself is actually defined with a default value of
// `false`, it is usually automatically set to `true` when a cluster is created
// (or is migrated from a earlier beta version). This can be prevented with the
// env var COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING.
//
// Doing this, rather than just using a default of `true`, means that a node
// will not errantly send a report using a default before loading settings.
DiagnosticsReportingEnabled = settings.RegisterBoolSetting(
"diagnostics.reporting.enabled",
"enable reporting diagnostic metrics to cockroach labs",
false,
)
// CrashReports wraps "diagnostics.reporting.send_crash_reports".
CrashReports = settings.RegisterBoolSetting(
"diagnostics.reporting.send_crash_reports",
"send crash and panic reports",
true,
)
// PanicOnAssertions wraps "debug.panic_on_failed_assertions"
PanicOnAssertions = settings.RegisterBoolSetting(
"debug.panic_on_failed_assertions",
"panic when an assertion fails rather than reporting",
false,
)
// ReportSensitiveDetails enables reporting of unanonymized data.
//
// This should not be used by anyone unwilling to share the whole cluster
// data with Cockroach Labs and various cloud services.
ReportSensitiveDetails = envutil.EnvOrDefaultBool("COCKROACH_REPORT_SENSITIVE_DETAILS", false)
)var (
ErrInvalidLengthLog = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowLog = fmt.Errorf("proto: integer overflow")
)LogFileMaxSize is the maximum size of a log file in bytes.
var LogFilesCombinedMaxSize = LogFileMaxSize * 10 // 100MiB
LogFilesCombinedMaxSize is the maximum total size in bytes for log files. Note that this is only checked when log files are created, so the total size of log files per severity might temporarily be up to LogFileMaxSize larger.
var OrigStderr = func() *os.File { fd, err := dupFD(os.Stderr.Fd()) if err != nil { panic(err) } return os.NewFile(fd, os.Stderr.Name()) }()
OrigStderr points to the original stderr stream.
var Severity_name = map[int32]string{ 0: "UNKNOWN", 1: "INFO", 2: "WARNING", 3: "ERROR", 4: "FATAL", 5: "NONE", 6: "DEFAULT", }
var Severity_value = map[string]int32{ "UNKNOWN": 0, "INFO": 1, "WARNING": 2, "ERROR": 3, "FATAL": 4, "NONE": 5, "DEFAULT": 6, }
DirSet returns true of the log directory for the main logger has been changed from its default.
func DisableTracebacks() func()
DisableTracebacks turns off tracebacks for log.Fatals. Returns a function that sets the traceback settings back to where they were. Only intended for use by tests.
func EncodeStackTrace(s *StackTrace) string
EncodeStackTrace produces a decodable string representation of the stack trace. This never fails.
Error logs to the ERROR, WARNING, and INFO logs. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Print; a newline is appended.
ErrorSource attempts to return the file:line where `i` was created if `i` has that information (i.e. if it is an errors.withStack). Returns "" otherwise.
Errorf logs to the ERROR, WARNING, and INFO logs. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
ErrorfDepth logs to the ERROR, WARNING, and INFO logs, offsetting the caller's stack frame by 'depth'. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
Event looks for an opentracing.Trace in the context and logs the given message to it. If no Trace is found, it looks for an EventLog in the context and logs the message to it. If neither is found, does nothing.
Eventf looks for an opentracing.Trace in the context and formats and logs the given message to it. If no Trace is found, it looks for an EventLog in the context and logs the message to it. If neither is found, does nothing.
ExpensiveLogEnabled is used to test whether effort should be used to produce log messages whose construction has a measurable cost. It returns true if either the current context is recording the trace, or if the caller's verbosity is above level.
NOTE: This doesn't take into consideration whether tracing is generally enabled or whether a trace.EventLog or a trace.Trace (i.e. sp.netTr) is attached to ctx. In particular, if some OpenTracing collection is enabled (e.g. LightStep), that, by itself, does NOT cause the expensive messages to be enabled. "SET tracing" and friends, on the other hand, does cause these messages to be enabled, as it shows that a user has expressed particular interest in a trace.
Usage:
if ExpensiveLogEnabled(ctx, 2) {
msg := constructExpensiveMessage() log.VEventf(ctx, 2, msg)
}
Fatal logs to the INFO, WARNING, ERROR, and FATAL logs, including a stack trace of all running goroutines, then calls os.Exit(255). It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Print; a newline is appended.
func FatalChan() <-chan struct{}FatalChan is closed when Fatal is called. This can be used to make the process stop handling requests while the final log messages and crash report are being written.
func FatalOnPanic()
FatalOnPanic recovers from a panic and exits the process with a Fatal log. This is useful for avoiding a panic being caught through a CGo exported function or preventing HTTP handlers from recovering panics and ignoring them.
Fatalf logs to the INFO, WARNING, ERROR, and FATAL logs, including a stack trace of all running goroutines, then calls os.Exit(255). It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
FatalfDepth logs to the INFO, WARNING, ERROR, and FATAL logs (offsetting the caller's stack frame by 'depth'), including a stack trace of all running goroutines, then calls os.Exit(255). It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
FinishEventLog closes the event log in the context (see WithEventLog). Concurrent and subsequent calls to record events are allowed.
func Flush()
Flush explicitly flushes all pending log I/O. See also flushDaemon() that manages background (asynchronous) flushes, and signalFlusher() that manages flushes in reaction to a user signal.
GetLogReader returns a reader for the specified filename. In restricted mode, the filename must be the base name of a file in this process's log directory (this is safe for cases when the filename comes from external sources, such as the admin UI via HTTP). In unrestricted mode any path is allowed, relative to the current directory, with the added feature that simple (base name) file names will be searched in this process's log directory if not found in the current directory.
TODO(knz): make this work for secondary loggers too.
HasSpanOrEvent returns true if the context has a span or event that should be logged to.
Info logs to the INFO log. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Print; a newline is appended.
InfoDepth logs to the INFO log, offsetting the caller's stack frame by 'depth'. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Print; a newline is appended.
Infof logs to the INFO log. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
InfofDepth logs to the INFO log, offsetting the caller's stack frame by 'depth'. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
func Intercept(ctx context.Context, f InterceptorFn)
Intercept diverts log traffic to the given function `f`. When `f` is not nil, the logging package begins operating at full verbosity (i.e. `V(n) == true` for all `n`) but nothing will be printed to the logs. Instead, `f` is invoked for each log entry.
To end log interception, invoke `Intercept()` with `f == nil`. Note that interception does not terminate atomically, that is, the originally supplied callback may still be invoked after a call to `Intercept` with `f == nil`.
LoggingToStderr returns true if log messages of the given severity sent to the main logger are also visible on stderr.
MakeMessage creates a structured log entry.
NewStdLogger creates a *stdLog.Logger that forwards messages to the CockroachDB logs with the specified severity.
The prefix appears at the beginning of each generated log line.
func PrintStackTrace(s *StackTrace) string
PrintStackTrace produces a human-readable partial representation of the stack trace.
RecoverAndReportNonfatalPanic is an alternative RecoverAndReportPanic that does not re-panic in Release builds.
RecoverAndReportPanic can be invoked on goroutines that run with stderr redirected to logs to ensure the user gets informed on the real stderr a panic has occurred.
Redact returns a redacted version of the supplied item that is safe to use in anonymized reporting.
RegisterTagFn adds a function for tagging crash reports based on the context. This is intended to be called by other packages at init time.
func ReportOrPanic(
ctx context.Context, sv *settings.Values, format string, reportables ...interface{},
)ReportOrPanic either reports an error to sentry, if run from a release binary, or panics, if triggered in tests. This is intended to be used for failing assertions which are recoverable but serious enough to report and to cause tests to fail.
Like SendCrashReport, the format string should not contain any sensitive data, and unsafe reportables will be redacted before reporting.
ReportPanic reports a panic has occurred on the real stderr.
ReportablesToSafeError inspects the given format string (taken as not needing redaction) and reportables, redacts them appropriately and returns an error that is safe to pass to anonymized reporting. The given depth is used to insert a callsite when positive.
func ResetExitFunc()
ResetExitFunc undoes any prior call to SetExitFunc.
func SendCrashReport(
ctx context.Context,
sv *settings.Values,
depth int,
format string,
reportables []interface{},
crashReportType ReportType,
)SendCrashReport posts to sentry. The `reportables` is essentially the `args...` in `log.Fatalf(format, args...)` (similarly for `log.Fatal`) or `[]interface{}{arg}` in `panic(arg)`.
The format string and those items in `reportables` which are a) an error or b) (values of or pointers to) `log.Safe` will be used verbatim to construct the error that is reported to sentry.
TODO(dt,knz,sql-team): we need to audit all sprintf'ing of values into the errors and strings passed to panic, to ensure raw user data is kept separate and can thus be elided here. For now, the type is about all we can assume is safe to report, which combined with file and line info should be at least somewhat helpful in telling us where crashes are coming from. We capture the full stacktrace below, so we only need the short file and line here help uniquely identify the error. Some exceptions, like a runtime.Error, are assumed to be fine as-is.
The crashReportType parameter adds a tag to the event that shows if the cluster did indeed crash or not.
func SendReport(
ctx context.Context,
errMsg string,
crashReportType ReportType,
extraDetails map[string]interface{},
details ...ReportableObject,
)SendReport uploads a detailed error report to sentry. Note that there can be at most one reportable object of each type in the report. For more messages, use extraDetails. The crashReportType parameter adds a tag to the event that shows if the cluster did indeed crash or not.
SetClusterID stores the Cluster ID for further reference.
TODO(knz): This should not be configured per-logger. See: https://github.com/cockroachdb/cockroach/issues/40983
SetExitFunc allows setting a function that will be called to exit the process when a Fatal message is generated. The supplied bool, if true, suppresses the stack trace, which is useful for test callers wishing to keep the logs reasonably clean.
Call with a nil function to undo.
SetSync configures whether logging synchronizes all writes. This overrides the synchronization setting for both primary and secondary loggers. This is used e.g. in `cockroach start` when an error occurs, to ensure that all log writes from the point the error occurs are flushed to logs (in case the error degenerates into a panic / segfault on the way out).
SetVModule alters the vmodule logging level to the passed in value.
SetupCrashReporter sets the crash reporter info.
ShouldSendReport returns true iff SendReport() should be called.
Shout logs to the specified severity's log, and also to the real stderr if logging is currently redirected to a file.
StartGCDaemon starts the log file GC -- this must be called after command-line parsing has completed so that no data is lost when the user configures larger max sizes than the defaults.
The logger's GC daemon stops when the provided context is canceled.
Note that secondary logger get their GC daemon started when they are allocated (NewSecondaryLogger). This assumes that secondary loggers are only allocated after command line parsing has completed too.
V returns true if the logging verbosity is set to the specified level or higher.
See also ExpensiveLogEnabled().
TODO(andrei): Audit uses of V() and see which ones should actually use the newer ExpensiveLogEnabled().
VDepth reports whether verbosity at the call site is at least the requested level.
VErrEvent either logs an error message to the log files (which also outputs to the active trace or event log) or to the trace/event log alone, depending on whether the specified verbosity level is active.
VErrEventf either logs an error message to the log files (which also outputs to the active trace or event log) or to the trace/event log alone, depending on whether the specified verbosity level is active.
func VErrEventfDepth(
ctx context.Context, depth int, level int32, format string, args ...interface{},
)VErrEventfDepth performs the same as VErrEventf but checks the verbosity level at the given depth in the call stack.
VEvent either logs a message to the log files (which also outputs to the active trace or event log) or to the trace/event log alone, depending on whether the specified verbosity level is active.
VEventf either logs a message to the log files (which also outputs to the active trace or event log) or to the trace/event log alone, depending on whether the specified verbosity level is active.
VEventfDepth performs the same as VEventf but checks the verbosity level at the given depth in the call stack.
Warning logs to the WARNING and INFO logs. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Print; a newline is appended.
Warningf logs to the WARNING and INFO logs. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
WarningfDepth logs to the WARNING and INFO logs, offsetting the caller's stack frame by 'depth'. It extracts log tags from the context and logs them along with the given message. Arguments are handled in the manner of fmt.Printf; a newline is appended.
WithEventLog creates and embeds a trace.EventLog in the context, causing future logging and event calls to go to the EventLog. The current context must not have an existing open span.
WithNoEventLog creates a context which no longer has an embedded event log.
type AmbientContext struct {
// Tracer is used to open spans (see AnnotateCtxWithSpan).
Tracer opentracing.Tracer
// contains filtered or unexported fields
}AmbientContext is a helper type used to "annotate" context.Contexts with log tags and a Tracer or EventLog. It is intended to be embedded into various server components.
Example:
type SomeServer struct {
log.AmbientContext
...
}
ac := AmbientContext{Tracer: tracing.NewTracer()}
ac.AddLogTag("n", 1)
s := &SomeServer{
AmbientContext: ac
...
}
// on an operation with context ctx
ctx = s.AnnotateCtx(ctx)
...
// run a worker
s.stopper.RunWorker(func() {
ctx := s.AnnotateCtx(context.Background())
...
})
// start a background operation
ctx, span := s.AnnotateCtxWithSpan(context.Background(), "some-op")
defer span.Finish()
...
func (ac *AmbientContext) AddLogTag(name string, value interface{})
AddLogTag adds a tag to the ambient context.
AnnotateCtx annotates a given context with the information in AmbientContext:
- the EventLog is embedded in the context if the context doesn't already have an event log or an open trace. - the log tags in AmbientContext are added (if ctx doesn't already have them). If the tags already exist, the values from the AmbientContext overwrite the existing values, but the order of the tags might change.
For background operations, context.Background() should be passed; however, in that case it is strongly recommended to open a span if possible (using AnnotateCtxWithSpan).
func (ac *AmbientContext) AnnotateCtxWithSpan( ctx context.Context, opName string, ) (context.Context, opentracing.Span)
AnnotateCtxWithSpan annotates the given context with the information in AmbientContext (see AnnotateCtx) and opens a span.
If the given context has a span, the new span is a child of that span. Otherwise, the Tracer in AmbientContext is used to create a new root span.
The caller is responsible for closing the span (via Span.Finish).
func (ac *AmbientContext) FinishEventLog()
FinishEventLog closes the event log. Concurrent and subsequent calls to record events from contexts that use this event log embedded are allowed.
func (ac *AmbientContext) LogTags() *logtags.Buffer
LogTags returns the tags in the ambient context.
ResetAndAnnotateCtx annotates a given context with the information in AmbientContext, but unlike AnnotateCtx, it drops all log tags in the supplied context before adding the ones from the AmbientContext.
func (ac *AmbientContext) SetEventLog(family, title string)
SetEventLog sets up an event log. Annotated contexts log into this event log (unless there's an open Span).
DirName overrides (if non-empty) the choice of directory in which to write logs. See createLogDirs for the full list of possible destinations. Note that the default is to log to stderr independent of this setting. See --logtostderr.
IsSet returns true iff the directory name is set.
Set implements the flag.Value interface.
String implements the flag.Value interface.
Type implements the flag.Value interface.
type Entry struct {
Severity Severity `protobuf:"varint,1,opt,name=severity,proto3,enum=cockroach.util.log.Severity" json:"severity,omitempty"`
// Nanoseconds since the epoch.
Time int64 `protobuf:"varint,2,opt,name=time,proto3" json:"time,omitempty"`
Goroutine int64 `protobuf:"varint,6,opt,name=goroutine,proto3" json:"goroutine,omitempty"`
File string `protobuf:"bytes,3,opt,name=file,proto3" json:"file,omitempty"`
Line int64 `protobuf:"varint,4,opt,name=line,proto3" json:"line,omitempty"`
Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"`
}Entry represents a cockroach structured log entry.
func FetchEntriesFromFiles(
startTimestamp, endTimestamp int64, maxEntries int, pattern *regexp.Regexp,
) ([]Entry, error)FetchEntriesFromFiles fetches all available log entries on disk that are between the 'startTimestamp' and 'endTimestamp'. It will stop reading new files if the number of entries exceeds 'maxEntries'. Log entries are further filtered by the regexp 'pattern' if provided. The logs entries are returned in reverse chronological order.
MakeEntry creates an Entry.
Format writes the log entry to the specified writer.
type EntryDecoder struct {
// contains filtered or unexported fields
}EntryDecoder reads successive encoded log entries from the input buffer. Each entry is preceded by a single big-ending uint32 describing the next entry's length.
func NewEntryDecoder(in io.Reader) *EntryDecoder
NewEntryDecoder creates a new instance of EntryDecoder.
func (d *EntryDecoder) Decode(entry *Entry) error
Decode decodes the next log entry into the provided protobuf message.
EveryN provides a way to rate limit spammy log messages. It tracks how recently a given log message has been emitted so that it can determine whether it's worth logging again.
Every is a convenience constructor for an EveryN object that allows a log message every n duration.
ShouldLog returns whether it's been more than N time since the last event.
type FileDetails struct {
Program string `protobuf:"bytes,1,opt,name=program,proto3" json:"program,omitempty"`
Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
UserName string `protobuf:"bytes,3,opt,name=user_name,json=userName,proto3" json:"user_name,omitempty"`
Time int64 `protobuf:"varint,5,opt,name=time,proto3" json:"time,omitempty"`
PID int64 `protobuf:"varint,6,opt,name=pid,proto3" json:"pid,omitempty"`
}A FileDetails holds all of the particulars that can be parsed by the name of a log file.
func ParseLogFilename(filename string) (FileDetails, error)
ParseLogFilename parses a filename into FileDetails if it matches the pattern for log files. If the filename does not match the log file pattern, an error is returned.
func (*FileDetails) Descriptor() ([]byte, []int)
func (m *FileDetails) Marshal() (dAtA []byte, err error)
func (m *FileDetails) MarshalTo(dAtA []byte) (int, error)
func (*FileDetails) ProtoMessage()
func (m *FileDetails) Reset()
func (m *FileDetails) Size() (n int)
func (m *FileDetails) String() string
func (m *FileDetails) Unmarshal(dAtA []byte) error
func (m *FileDetails) XXX_DiscardUnknown()
func (dst *FileDetails) XXX_Merge(src proto.Message)
func (m *FileDetails) XXX_Size() int
func (m *FileDetails) XXX_Unmarshal(b []byte) error
type FileInfo struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
SizeBytes int64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
ModTimeNanos int64 `protobuf:"varint,3,opt,name=mod_time_nanos,json=modTimeNanos,proto3" json:"mod_time_nanos,omitempty"`
Details FileDetails `protobuf:"bytes,4,opt,name=details,proto3" json:"details"`
}ListLogFiles returns a slice of FileInfo structs for each log file on the local node, in any of the configured log directories.
func MakeFileInfo(details FileDetails, info os.FileInfo) FileInfo
MakeFileInfo constructs a FileInfo from FileDetails and os.FileInfo.
InterceptorFn is the type of function accepted by Intercept().
ReportType is used to differentiate between an actual crash/panic and just reporting an error. This data is useful for stability purposes.
const (
// ReportTypePanic signifies that this is an actual panic.
ReportTypePanic ReportType = iota
// ReportTypeError signifies that this is just a report of an error but it
// still may include an exception and stack trace.
ReportTypeError
)ReportableObject is an interface suitable for the extra detail objects provided to SendReport().
SafeMessager is implemented by objects which have a way of representing themselves suitably redacted for anonymized reporting.
type SafeType struct {
V interface{}
// contains filtered or unexported fields
}A SafeType panic can be reported verbatim, i.e. does not leak information. A nil `*SafeType` is not valid for use and may cause panics.
Safe constructs a SafeType. It is equivalent to `Chain(v, nil)`.
Cause returns the value passed to Chain() when this SafeType was created (or nil).
Error implements error as a convenience.
Format implements fmt.Formatter.
SafeMessage implements SafeMessager. It does not recurse into the SafeType's Cause()s.
SafeType implements fmt.Stringer as a convenience.
WithCause links a safe message and a child about which nothing is assumed, but for which the hope is that some anonymized parts can be obtained from it.
type SecondaryLogger struct {
// contains filtered or unexported fields
}SecondaryLogger represents a secondary / auxiliary logging channel whose logging events go to a different file than the main logging facility.
func NewSecondaryLogger(
ctx context.Context,
dirName *DirName,
fileNamePrefix string,
enableGc bool,
forceSyncWrites bool,
enableMsgCount bool,
) *SecondaryLoggerNewSecondaryLogger creates a secondary logger.
The given directory name can be either nil or empty, in which case the global logger's own dirName is used; or non-nil and non-empty, in which case it specifies the directory for that new logger.
The logger's GC daemon stops when the provided context is canceled.
func (l *SecondaryLogger) LogSev(ctx context.Context, sev Severity, args ...interface{})
LogSev logs an event at the specified severity on a secondary logger.
func (l *SecondaryLogger) Logf(ctx context.Context, format string, args ...interface{})
Logf logs an event on a secondary logger.
const (
Severity_UNKNOWN Severity = 0
Severity_INFO Severity = 1
Severity_WARNING Severity = 2
Severity_ERROR Severity = 3
Severity_FATAL Severity = 4
// NONE is used to specify when no messages
// should be printed to the log file or stderr.
Severity_NONE Severity = 5
// DEFAULT is the end sentinel. It is used during command-line
// handling to indicate that another value should be replaced instead
// (depending on which command is being run); see cli/flags.go for
// details.
Severity_DEFAULT Severity = 6
)SeverityByName attempts to parse the passed in string into a severity. (i.e. ERROR, INFO). If it succeeds, the returned bool is set to true.
Name returns the string representation of the severity (i.e. ERROR, INFO).
Set is part of the flag.Value interface.
type StackTrace = raven.Stacktrace
StackTrace is an object suitable for inclusion in errors that can ultimately be reported with ReportInternalError() or similar.
func DecodeStackTrace(s string) (*StackTrace, bool)
DecodeStackTrace produces a stack trace from the encoded string. If decoding fails, a boolean false is returned. In that case the caller is invited to include the string in the final reportable object, as a fallback (instead of discarding the stack trace entirely).
func NewStackTrace(depth int) *StackTrace
NewStackTrace generates a stacktrace suitable for inclusion in error reports.
type TestLogScope struct {
// contains filtered or unexported fields
}TestLogScope represents the lifetime of a logging output. It ensures that the log files are stored in a directory specific to a test, and asserts that logging output is not written to this directory beyond the lifetime of the scope.
func Scope(t tShim) *TestLogScope
Scope creates a TestLogScope which corresponds to the lifetime of a logging directory. The logging directory is named after the calling test. It also disables logging to stderr.
func ScopeWithoutShowLogs(t tShim) *TestLogScope
ScopeWithoutShowLogs ignores the -show-logs flag and should be used for tests that require the logs go to files.
func (l *TestLogScope) Close(t tShim)
Close cleans up a TestLogScope. The directory and its contents are deleted, unless the test has failed and the directory is non-empty.
| Path | Synopsis |
|---|---|
| logflags |
Package log imports 46 packages (graph) and is imported by 547 packages. Updated 2019-10-17. Refresh now. Tools for package owners.