vendor: github.com/opentracing/opentracing-go v1.2.0

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-11-17 11:57:17 +01:00 committed by Tibor Vass
parent 74d93d1fa2
commit 2c694b3233
15 changed files with 356 additions and 76 deletions

View File

@ -55,7 +55,7 @@ github.com/morikuni/aec 39771216ff4c63d11f5e604076f9
github.com/opencontainers/go-digest ea51bea511f75cfa3ef6098cc253c5c3609b037a # v1.0.0 github.com/opencontainers/go-digest ea51bea511f75cfa3ef6098cc253c5c3609b037a # v1.0.0
github.com/opencontainers/image-spec d60099175f88c47cd379c4738d158884749ed235 # v1.0.1 github.com/opencontainers/image-spec d60099175f88c47cd379c4738d158884749ed235 # v1.0.1
github.com/opencontainers/runc ff819c7e9184c13b7c2607fe6c30ae19403a7aff # v1.0.0-rc92 github.com/opencontainers/runc ff819c7e9184c13b7c2607fe6c30ae19403a7aff # v1.0.0-rc92
github.com/opentracing/opentracing-go 1361b9cd60be79c4c3a7fa9841b3c132e40066a7 github.com/opentracing/opentracing-go d34af3eaa63c4d08ab54863a4bdd0daa45212e12 # v1.2.0
github.com/pkg/errors 614d223910a179a466c1767a985424175c39b465 # v0.9.1 github.com/pkg/errors 614d223910a179a466c1767a985424175c39b465 # v0.9.1
github.com/prometheus/client_golang 6edbbd9e560190e318cdc5b4d3e630b442858380 # v1.6.0 github.com/prometheus/client_golang 6edbbd9e560190e318cdc5b4d3e630b442858380 # v1.6.0
github.com/prometheus/client_model 7bc5445566f0fe75b15de23e6b93886e982d7bf9 # v0.2.0 github.com/prometheus/client_model 7bc5445566f0fe75b15de23e6b93886e982d7bf9 # v0.2.0

View File

@ -1,21 +1,201 @@
The MIT License (MIT) Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Copyright (c) 2016 The OpenTracing Authors TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
Permission is hereby granted, free of charge, to any person obtaining a copy 1. Definitions.
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all "License" shall mean the terms and conditions for use, reproduction,
copies or substantial portions of the Software. and distribution as defined by Sections 1 through 9 of this document.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR "Licensor" shall mean the copyright owner or entity authorized by
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, the copyright owner that is granting the License.
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER "Legal Entity" shall mean the union of the acting entity and all
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, other entities that control, are controlled by, or are under common
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE control with that entity. For the purposes of this definition,
SOFTWARE. "control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2016 The OpenTracing Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -8,8 +8,8 @@ This package is a Go platform API for OpenTracing.
## Required Reading ## Required Reading
In order to understand the Go platform API, one must first be familiar with the In order to understand the Go platform API, one must first be familiar with the
[OpenTracing project](http://opentracing.io) and [OpenTracing project](https://opentracing.io) and
[terminology](http://opentracing.io/documentation/pages/spec.html) more specifically. [terminology](https://opentracing.io/specification/) more specifically.
## API overview for those adding instrumentation ## API overview for those adding instrumentation
@ -27,7 +27,7 @@ The simplest starting point is `./default_tracer.go`. As early as possible, call
import ".../some_tracing_impl" import ".../some_tracing_impl"
func main() { func main() {
opentracing.InitGlobalTracer( opentracing.SetGlobalTracer(
// tracing impl specific: // tracing impl specific:
some_tracing_impl.New(...), some_tracing_impl.New(...),
) )
@ -35,7 +35,7 @@ The simplest starting point is `./default_tracer.go`. As early as possible, call
} }
``` ```
##### Non-Singleton initialization #### Non-Singleton initialization
If you prefer direct control to singletons, manage ownership of the If you prefer direct control to singletons, manage ownership of the
`opentracing.Tracer` implementation explicitly. `opentracing.Tracer` implementation explicitly.
@ -161,3 +161,11 @@ Tracing system implementors may be able to reuse or copy-paste-modify the `basic
## API compatibility ## API compatibility
For the time being, "mild" backwards-incompatible changes may be made without changing the major version number. As OpenTracing and `opentracing-go` mature, backwards compatibility will become more of a priority. For the time being, "mild" backwards-incompatible changes may be made without changing the major version number. As OpenTracing and `opentracing-go` mature, backwards compatibility will become more of a priority.
## Tracer test suite
A test suite is available in the [harness](https://godoc.org/github.com/opentracing/opentracing-go/harness) package that can assist Tracer implementors to assert that their Tracer is working correctly.
## Licensing
[Apache 2.0 License](./LICENSE).

24
vendor/github.com/opentracing/opentracing-go/ext.go generated vendored Normal file
View File

@ -0,0 +1,24 @@
package opentracing
import (
"context"
)
// TracerContextWithSpanExtension is an extension interface that the
// implementation of the Tracer interface may want to implement. It
// allows to have some control over the go context when the
// ContextWithSpan is invoked.
//
// The primary purpose of this extension are adapters from opentracing
// API to some other tracing API.
type TracerContextWithSpanExtension interface {
// ContextWithSpanHook gets called by the ContextWithSpan
// function, when the Tracer implementation also implements
// this interface. It allows to put extra information into the
// context and make it available to the callers of the
// ContextWithSpan.
//
// This hook is invoked before the ContextWithSpan function
// actually puts the span into the context.
ContextWithSpanHook(ctx context.Context, span Span) context.Context
}

View File

@ -0,0 +1,17 @@
package ext
import (
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/log"
)
// LogError sets the error=true tag on the Span and logs err as an "error" event.
func LogError(span opentracing.Span, err error, fields ...log.Field) {
Error.Set(span, true)
ef := []log.Field{
log.Event("error"),
log.Error(err),
}
ef = append(ef, fields...)
span.LogFields(ef...)
}

View File

@ -1,6 +1,6 @@
package ext package ext
import opentracing "github.com/opentracing/opentracing-go" import "github.com/opentracing/opentracing-go"
// These constants define common tag names recommended for better portability across // These constants define common tag names recommended for better portability across
// tracing systems and languages/platforms. // tracing systems and languages/platforms.
@ -47,40 +47,40 @@ var (
// Component is a low-cardinality identifier of the module, library, // Component is a low-cardinality identifier of the module, library,
// or package that is generating a span. // or package that is generating a span.
Component = stringTagName("component") Component = StringTagName("component")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// Sampling hint // Sampling hint
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// SamplingPriority determines the priority of sampling this Span. // SamplingPriority determines the priority of sampling this Span.
SamplingPriority = uint16TagName("sampling.priority") SamplingPriority = Uint16TagName("sampling.priority")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// Peer tags. These tags can be emitted by either client-side of // Peer tags. These tags can be emitted by either client-side or
// server-side to describe the other side/service in a peer-to-peer // server-side to describe the other side/service in a peer-to-peer
// communications, like an RPC call. // communications, like an RPC call.
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// PeerService records the service name of the peer. // PeerService records the service name of the peer.
PeerService = stringTagName("peer.service") PeerService = StringTagName("peer.service")
// PeerAddress records the address name of the peer. This may be a "ip:port", // PeerAddress records the address name of the peer. This may be a "ip:port",
// a bare "hostname", a FQDN or even a database DSN substring // a bare "hostname", a FQDN or even a database DSN substring
// like "mysql://username@127.0.0.1:3306/dbname" // like "mysql://username@127.0.0.1:3306/dbname"
PeerAddress = stringTagName("peer.address") PeerAddress = StringTagName("peer.address")
// PeerHostname records the host name of the peer // PeerHostname records the host name of the peer
PeerHostname = stringTagName("peer.hostname") PeerHostname = StringTagName("peer.hostname")
// PeerHostIPv4 records IP v4 host address of the peer // PeerHostIPv4 records IP v4 host address of the peer
PeerHostIPv4 = ipv4Tag("peer.ipv4") PeerHostIPv4 = IPv4TagName("peer.ipv4")
// PeerHostIPv6 records IP v6 host address of the peer // PeerHostIPv6 records IP v6 host address of the peer
PeerHostIPv6 = stringTagName("peer.ipv6") PeerHostIPv6 = StringTagName("peer.ipv6")
// PeerPort records port number of the peer // PeerPort records port number of the peer
PeerPort = uint16TagName("peer.port") PeerPort = Uint16TagName("peer.port")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// HTTP Tags // HTTP Tags
@ -88,46 +88,46 @@ var (
// HTTPUrl should be the URL of the request being handled in this segment // HTTPUrl should be the URL of the request being handled in this segment
// of the trace, in standard URI format. The protocol is optional. // of the trace, in standard URI format. The protocol is optional.
HTTPUrl = stringTagName("http.url") HTTPUrl = StringTagName("http.url")
// HTTPMethod is the HTTP method of the request, and is case-insensitive. // HTTPMethod is the HTTP method of the request, and is case-insensitive.
HTTPMethod = stringTagName("http.method") HTTPMethod = StringTagName("http.method")
// HTTPStatusCode is the numeric HTTP status code (200, 404, etc) of the // HTTPStatusCode is the numeric HTTP status code (200, 404, etc) of the
// HTTP response. // HTTP response.
HTTPStatusCode = uint16TagName("http.status_code") HTTPStatusCode = Uint16TagName("http.status_code")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// DB Tags // DB Tags
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// DBInstance is database instance name. // DBInstance is database instance name.
DBInstance = stringTagName("db.instance") DBInstance = StringTagName("db.instance")
// DBStatement is a database statement for the given database type. // DBStatement is a database statement for the given database type.
// It can be a query or a prepared statement (i.e., before substitution). // It can be a query or a prepared statement (i.e., before substitution).
DBStatement = stringTagName("db.statement") DBStatement = StringTagName("db.statement")
// DBType is a database type. For any SQL database, "sql". // DBType is a database type. For any SQL database, "sql".
// For others, the lower-case database category, e.g. "redis" // For others, the lower-case database category, e.g. "redis"
DBType = stringTagName("db.type") DBType = StringTagName("db.type")
// DBUser is a username for accessing database. // DBUser is a username for accessing database.
DBUser = stringTagName("db.user") DBUser = StringTagName("db.user")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// Message Bus Tag // Message Bus Tag
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// MessageBusDestination is an address at which messages can be exchanged // MessageBusDestination is an address at which messages can be exchanged
MessageBusDestination = stringTagName("message_bus.destination") MessageBusDestination = StringTagName("message_bus.destination")
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// Error Tag // Error Tag
////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////
// Error indicates that operation represented by the span resulted in an error. // Error indicates that operation represented by the span resulted in an error.
Error = boolTagName("error") Error = BoolTagName("error")
) )
// --- // ---
@ -163,48 +163,53 @@ func RPCServerOption(client opentracing.SpanContext) opentracing.StartSpanOption
// --- // ---
type stringTagName string // StringTagName is a common tag name to be set to a string value
type StringTagName string
// Set adds a string tag to the `span` // Set adds a string tag to the `span`
func (tag stringTagName) Set(span opentracing.Span, value string) { func (tag StringTagName) Set(span opentracing.Span, value string) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }
// --- // ---
type uint32TagName string // Uint32TagName is a common tag name to be set to a uint32 value
type Uint32TagName string
// Set adds a uint32 tag to the `span` // Set adds a uint32 tag to the `span`
func (tag uint32TagName) Set(span opentracing.Span, value uint32) { func (tag Uint32TagName) Set(span opentracing.Span, value uint32) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }
// --- // ---
type uint16TagName string // Uint16TagName is a common tag name to be set to a uint16 value
type Uint16TagName string
// Set adds a uint16 tag to the `span` // Set adds a uint16 tag to the `span`
func (tag uint16TagName) Set(span opentracing.Span, value uint16) { func (tag Uint16TagName) Set(span opentracing.Span, value uint16) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }
// --- // ---
type boolTagName string // BoolTagName is a common tag name to be set to a bool value
type BoolTagName string
// Add adds a bool tag to the `span` // Set adds a bool tag to the `span`
func (tag boolTagName) Set(span opentracing.Span, value bool) { func (tag BoolTagName) Set(span opentracing.Span, value bool) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }
type ipv4Tag string // IPv4TagName is a common tag name to be set to an ipv4 value
type IPv4TagName string
// Set adds IP v4 host address of the peer as an uint32 value to the `span`, keep this for backward and zipkin compatibility // Set adds IP v4 host address of the peer as an uint32 value to the `span`, keep this for backward and zipkin compatibility
func (tag ipv4Tag) Set(span opentracing.Span, value uint32) { func (tag IPv4TagName) Set(span opentracing.Span, value uint32) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }
// SetString records IP v4 host address of the peer as a .-separated tuple to the `span`. E.g., "127.0.0.1" // SetString records IP v4 host address of the peer as a .-separated tuple to the `span`. E.g., "127.0.0.1"
func (tag ipv4Tag) SetString(span opentracing.Span, value string) { func (tag IPv4TagName) SetString(span opentracing.Span, value string) {
span.SetTag(string(tag), value) span.SetTag(string(tag), value)
} }

View File

@ -1,7 +1,12 @@
package opentracing package opentracing
type registeredTracer struct {
tracer Tracer
isRegistered bool
}
var ( var (
globalTracer Tracer = NoopTracer{} globalTracer = registeredTracer{NoopTracer{}, false}
) )
// SetGlobalTracer sets the [singleton] opentracing.Tracer returned by // SetGlobalTracer sets the [singleton] opentracing.Tracer returned by
@ -11,22 +16,27 @@ var (
// Prior to calling `SetGlobalTracer`, any Spans started via the `StartSpan` // Prior to calling `SetGlobalTracer`, any Spans started via the `StartSpan`
// (etc) globals are noops. // (etc) globals are noops.
func SetGlobalTracer(tracer Tracer) { func SetGlobalTracer(tracer Tracer) {
globalTracer = tracer globalTracer = registeredTracer{tracer, true}
} }
// GlobalTracer returns the global singleton `Tracer` implementation. // GlobalTracer returns the global singleton `Tracer` implementation.
// Before `SetGlobalTracer()` is called, the `GlobalTracer()` is a noop // Before `SetGlobalTracer()` is called, the `GlobalTracer()` is a noop
// implementation that drops all data handed to it. // implementation that drops all data handed to it.
func GlobalTracer() Tracer { func GlobalTracer() Tracer {
return globalTracer return globalTracer.tracer
} }
// StartSpan defers to `Tracer.StartSpan`. See `GlobalTracer()`. // StartSpan defers to `Tracer.StartSpan`. See `GlobalTracer()`.
func StartSpan(operationName string, opts ...StartSpanOption) Span { func StartSpan(operationName string, opts ...StartSpanOption) Span {
return globalTracer.StartSpan(operationName, opts...) return globalTracer.tracer.StartSpan(operationName, opts...)
} }
// InitGlobalTracer is deprecated. Please use SetGlobalTracer. // InitGlobalTracer is deprecated. Please use SetGlobalTracer.
func InitGlobalTracer(tracer Tracer) { func InitGlobalTracer(tracer Tracer) {
SetGlobalTracer(tracer) SetGlobalTracer(tracer)
} }
// IsGlobalTracerRegistered returns a `bool` to indicate if a tracer has been globally registered
func IsGlobalTracerRegistered() bool {
return globalTracer.isRegistered
}

5
vendor/github.com/opentracing/opentracing-go/go.mod generated vendored Normal file
View File

@ -0,0 +1,5 @@
module github.com/opentracing/opentracing-go
go 1.14
require github.com/stretchr/testify v1.3.0

View File

@ -1,14 +1,19 @@
package opentracing package opentracing
import "golang.org/x/net/context" import "context"
type contextKey struct{} type contextKey struct{}
var activeSpanKey = contextKey{} var activeSpanKey = contextKey{}
// ContextWithSpan returns a new `context.Context` that holds a reference to // ContextWithSpan returns a new `context.Context` that holds a reference to
// `span`'s SpanContext. // the span. If span is nil, a new context without an active span is returned.
func ContextWithSpan(ctx context.Context, span Span) context.Context { func ContextWithSpan(ctx context.Context, span Span) context.Context {
if span != nil {
if tracerWithHook, ok := span.Tracer().(TracerContextWithSpanExtension); ok {
ctx = tracerWithHook.ContextWithSpanHook(ctx, span)
}
}
return context.WithValue(ctx, activeSpanKey, span) return context.WithValue(ctx, activeSpanKey, span)
} }
@ -41,17 +46,20 @@ func SpanFromContext(ctx context.Context) Span {
// ... // ...
// } // }
func StartSpanFromContext(ctx context.Context, operationName string, opts ...StartSpanOption) (Span, context.Context) { func StartSpanFromContext(ctx context.Context, operationName string, opts ...StartSpanOption) (Span, context.Context) {
return startSpanFromContextWithTracer(ctx, GlobalTracer(), operationName, opts...) return StartSpanFromContextWithTracer(ctx, GlobalTracer(), operationName, opts...)
} }
// startSpanFromContextWithTracer is factored out for testing purposes. // StartSpanFromContextWithTracer starts and returns a span with `operationName`
func startSpanFromContextWithTracer(ctx context.Context, tracer Tracer, operationName string, opts ...StartSpanOption) (Span, context.Context) { // using a span found within the context as a ChildOfRef. If that doesn't exist
var span Span // it creates a root span. It also returns a context.Context object built
// around the returned span.
//
// It's behavior is identical to StartSpanFromContext except that it takes an explicit
// tracer as opposed to using the global tracer.
func StartSpanFromContextWithTracer(ctx context.Context, tracer Tracer, operationName string, opts ...StartSpanOption) (Span, context.Context) {
if parentSpan := SpanFromContext(ctx); parentSpan != nil { if parentSpan := SpanFromContext(ctx); parentSpan != nil {
opts = append(opts, ChildOf(parentSpan.Context())) opts = append(opts, ChildOf(parentSpan.Context()))
span = tracer.StartSpan(operationName, opts...)
} else {
span = tracer.StartSpan(operationName, opts...)
} }
span := tracer.StartSpan(operationName, opts...)
return span, ContextWithSpan(ctx, span) return span, ContextWithSpan(ctx, span)
} }

View File

@ -122,16 +122,19 @@ func Float64(key string, val float64) Field {
} }
} }
// Error adds an error with the key "error" to a Span.LogFields() record // Error adds an error with the key "error.object" to a Span.LogFields() record
func Error(err error) Field { func Error(err error) Field {
return Field{ return Field{
key: "error", key: "error.object",
fieldType: errorType, fieldType: errorType,
interfaceVal: err, interfaceVal: err,
} }
} }
// Object adds an object-valued key:value pair to a Span.LogFields() record // Object adds an object-valued key:value pair to a Span.LogFields() record
// Please pass in an immutable object, otherwise there may be concurrency issues.
// Such as passing in the map, log.Object may result in "fatal error: concurrent map iteration and map write".
// Because span is sent asynchronously, it is possible that this map will also be modified.
func Object(key string, obj interface{}) Field { func Object(key string, obj interface{}) Field {
return Field{ return Field{
key: key, key: key,
@ -140,6 +143,16 @@ func Object(key string, obj interface{}) Field {
} }
} }
// Event creates a string-valued Field for span logs with key="event" and value=val.
func Event(val string) Field {
return String("event", val)
}
// Message creates a string-valued Field for span logs with key="message" and value=val.
func Message(val string) Field {
return String("message", val)
}
// LazyLogger allows for user-defined, late-bound logging of arbitrary data // LazyLogger allows for user-defined, late-bound logging of arbitrary data
type LazyLogger func(fv Encoder) type LazyLogger func(fv Encoder)

View File

@ -1,6 +1,9 @@
package log package log
import "fmt" import (
"fmt"
"reflect"
)
// InterleavedKVToFields converts keyValues a la Span.LogKV() to a Field slice // InterleavedKVToFields converts keyValues a la Span.LogKV() to a Field slice
// a la Span.LogFields(). // a la Span.LogFields().
@ -46,6 +49,10 @@ func InterleavedKVToFields(keyValues ...interface{}) ([]Field, error) {
case float64: case float64:
fields[i] = Float64(key, typedVal) fields[i] = Float64(key, typedVal)
default: default:
if typedVal == nil || (reflect.ValueOf(typedVal).Kind() == reflect.Ptr && reflect.ValueOf(typedVal).IsNil()) {
fields[i] = String(key, "nil")
continue
}
// When in doubt, coerce to a string // When in doubt, coerce to a string
fields[i] = String(key, fmt.Sprint(typedVal)) fields[i] = String(key, fmt.Sprint(typedVal))
} }

View File

@ -21,9 +21,9 @@ type noopSpan struct{}
type noopSpanContext struct{} type noopSpanContext struct{}
var ( var (
defaultNoopSpanContext = noopSpanContext{} defaultNoopSpanContext SpanContext = noopSpanContext{}
defaultNoopSpan = noopSpan{} defaultNoopSpan Span = noopSpan{}
defaultNoopTracer = NoopTracer{} defaultNoopTracer Tracer = NoopTracer{}
) )
const ( const (
@ -35,7 +35,7 @@ func (n noopSpanContext) ForeachBaggageItem(handler func(k, v string) bool) {}
// noopSpan: // noopSpan:
func (n noopSpan) Context() SpanContext { return defaultNoopSpanContext } func (n noopSpan) Context() SpanContext { return defaultNoopSpanContext }
func (n noopSpan) SetBaggageItem(key, val string) Span { return defaultNoopSpan } func (n noopSpan) SetBaggageItem(key, val string) Span { return n }
func (n noopSpan) BaggageItem(key string) string { return emptyString } func (n noopSpan) BaggageItem(key string) string { return emptyString }
func (n noopSpan) SetTag(key string, value interface{}) Span { return n } func (n noopSpan) SetTag(key string, value interface{}) Span { return n }
func (n noopSpan) LogFields(fields ...log.Field) {} func (n noopSpan) LogFields(fields ...log.Field) {}

View File

@ -160,7 +160,7 @@ type HTTPHeadersCarrier http.Header
// Set conforms to the TextMapWriter interface. // Set conforms to the TextMapWriter interface.
func (c HTTPHeadersCarrier) Set(key, val string) { func (c HTTPHeadersCarrier) Set(key, val string) {
h := http.Header(c) h := http.Header(c)
h.Add(key, val) h.Set(key, val)
} }
// ForeachKey conforms to the TextMapReader interface. // ForeachKey conforms to the TextMapReader interface.

View File

@ -41,6 +41,8 @@ type Span interface {
Context() SpanContext Context() SpanContext
// Sets or changes the operation name. // Sets or changes the operation name.
//
// Returns a reference to this Span for chaining.
SetOperationName(operationName string) Span SetOperationName(operationName string) Span
// Adds a tag to the span. // Adds a tag to the span.
@ -51,6 +53,8 @@ type Span interface {
// other tag value types is undefined at the OpenTracing level. If a // other tag value types is undefined at the OpenTracing level. If a
// tracing system does not know how to handle a particular value type, it // tracing system does not know how to handle a particular value type, it
// may ignore the tag, but shall not panic. // may ignore the tag, but shall not panic.
//
// Returns a reference to this Span for chaining.
SetTag(key string, value interface{}) Span SetTag(key string, value interface{}) Span
// LogFields is an efficient and type-checked way to record key:value // LogFields is an efficient and type-checked way to record key:value

View File

@ -44,8 +44,7 @@ type Tracer interface {
// and each has an expected carrier type. // and each has an expected carrier type.
// //
// Other packages may declare their own `format` values, much like the keys // Other packages may declare their own `format` values, much like the keys
// used by `context.Context` (see // used by `context.Context` (see https://godoc.org/context#WithValue).
// https://godoc.org/golang.org/x/net/context#WithValue).
// //
// Example usage (sans error handling): // Example usage (sans error handling):
// //