github.com/facebookincubator/go-belt@v0.0.0-20230703220935-39cd348f1a38/tool/experimental/tracer/span_option.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 tracer
    14  
    15  import (
    16  	"time"
    17  
    18  	"github.com/facebookincubator/go-belt/pkg/field"
    19  )
    20  
    21  // SpanOption is an option which modifies a Span.
    22  //
    23  // If some option is not supported by a specific
    24  // implementation of the Tracer, then it is just ignored.
    25  type SpanOption interface {
    26  	_x(*Span)
    27  }
    28  
    29  // SpanOptionRole defines who is the issuer of this specific Span,
    30  // which might be useful in some implementations of distributed tracing.
    31  type SpanOptionRole string
    32  
    33  const (
    34  	spanOptionRoleUndefined = SpanOptionRole("") //nolint:deadcode,unused,varcheck
    35  	RoleClient              = SpanOptionRole("client")
    36  	RoleServer              = SpanOptionRole("server")
    37  )
    38  
    39  func (SpanOptionRole) _x(*Span) {}
    40  
    41  // SpanOptionStart overrides the starting timestamp of the Span.
    42  type SpanOptionStart time.Time
    43  
    44  func (SpanOptionStart) _x(*Span) {}
    45  
    46  // SpanOptionAddFields adds more structured fields to the Span.
    47  //
    48  // Note: some distributing tracers may not support logging this data.
    49  type SpanOptionAddFields field.Fields
    50  
    51  func (SpanOptionAddFields) _x(*Span) {}
    52  
    53  // SpanOptionResetFields resets structured fields within the Span to an empty set.
    54  type SpanOptionResetFields struct{}
    55  
    56  func (SpanOptionResetFields) _x(*Span) {}