go.temporal.io/server@v1.23.0/common/log/interface.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  //go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination interface_mock.go
    26  
    27  package log
    28  
    29  import (
    30  	"go.temporal.io/server/common/log/tag"
    31  )
    32  
    33  type (
    34  	// Logger is the logging interface.
    35  	// Usage example:
    36  	//  logger.Info("hello world",
    37  	//          tag.WorkflowNextEventID(123),
    38  	//          tag.WorkflowActionWorkflowStarted,
    39  	//          tag.WorkflowNamespaceID("test-namespace-id")),
    40  	//	 )
    41  	//  Note: msg should be static, do not use fmt.Sprintf() for msg. Anything dynamic should be tagged.
    42  	Logger interface {
    43  		Debug(msg string, tags ...tag.Tag)
    44  		Info(msg string, tags ...tag.Tag)
    45  		Warn(msg string, tags ...tag.Tag)
    46  		Error(msg string, tags ...tag.Tag)
    47  		DPanic(msg string, tags ...tag.Tag)
    48  		Panic(msg string, tags ...tag.Tag)
    49  		Fatal(msg string, tags ...tag.Tag)
    50  	}
    51  
    52  	// Implement WithLogger interface with With method which should return new instance of logger with prepended tags.
    53  	// If WithLogger is not implemented on logger, internal (not very efficient) preppender is used.
    54  	// Create prepended logger example:
    55  	//  logger = log.With(
    56  	//          logger,
    57  	//          tag.WorkflowNextEventID(123),
    58  	//          tag.WorkflowActionWorkflowStarted,
    59  	//          tag.WorkflowNamespaceID("test-namespace-id"))
    60  	//  ...
    61  	//  logger.Info("hello world")
    62  	WithLogger interface {
    63  		With(tags ...tag.Tag) Logger
    64  	}
    65  
    66  	// If logger implements SkipLogger then Skip method will be called and extraSkip parameter will have
    67  	// number of extra stack trace frames to skip (useful to log caller func file/line).
    68  	SkipLogger interface {
    69  		Skip(extraSkip int) Logger
    70  	}
    71  
    72  	// Special logger types for use with fx
    73  	SnTaggedLogger  Logger
    74  	ThrottledLogger Logger
    75  )