github.com/facebookincubator/go-belt@v0.0.0-20230703220935-39cd348f1a38/tool.go (about)

     1  // Copyright 2022 Meta Platforms, Inc. and affiliates.
     2  //
     3  // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
     4  //
     5  // 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
     6  //
     7  // 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
     8  //
     9  // 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    10  //
    11  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    12  
    13  package belt
    14  
    15  import (
    16  	"github.com/facebookincubator/go-belt/pkg/field"
    17  )
    18  
    19  // Tool is an abstract observability tool. It could be a Logger, metrics, tracing or anything else.
    20  type Tool interface {
    21  	// Flush forces to flush all buffers.
    22  	Flush()
    23  
    24  	// WithContextFields sets new context-defined fields. Supposed to be called
    25  	// only by an Belt.
    26  	//
    27  	// allFields contains all fields as a chain of additions in a reverse-chronological order,
    28  	// while newFieldsCount tells about how much of the fields are new (since last
    29  	// call of WithContextFields). Thus if one will call
    30  	// field.Slice(allFields, 0, newFieldsCount) they will get only the new fields.
    31  	// At the same time some Tool-s may prefer just to re-set all the fields instead of adding
    32  	// only new fields (due to performance reasons) and they may just use `allFields`.
    33  	WithContextFields(allFields *field.FieldsChain, newFieldsCount int) Tool
    34  
    35  	// WithTraceIDs sets new context-defined TraceIDs. Supposed to be called
    36  	// only by an Belt.
    37  	//
    38  	// traceIDs and newTraceIDsCount has similar properties as allFields and newFieldsCount
    39  	// in the WithContextFields method.
    40  	WithTraceIDs(traceIDs TraceIDs, newTraceIDsCount int) Tool
    41  }
    42  
    43  // Tools is a collection of observability Tool-s.
    44  type Tools map[ToolID]Tool
    45  
    46  // GetByID returns a Tool of a specified ID. Returns an untyped nil if such Tool is not set.
    47  func (tools Tools) GetByID(toolID ToolID) Tool {
    48  	return tools[toolID]
    49  }