Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified
📁 ..	-	2025-05-25 12:27
📁 .github	-	2025-05-25 12:27
📄 .gitignore coverage.txt	13 B	2025-05-25 12:27
📄 .travis.yml language: go matrix: include: - go: "1.13.x" - go: "1.14.x" - go: "tip" env: - LINT=true - COVERAGE=true install: - if [ "$LINT" == true ]; then go get -u golang.org/x/lint/golint/... ; else echo 'skipping lint'; fi - go get -u github.com/stretchr/testify/... script: - make test - go build ./... - if [ "$LINT" == true ]; then make lint ; else echo 'skipping lint'; fi - if [ "$COVERAGE" == true ]; then make cover && bash <(curl -s https://codecov.io/bash) ; else echo 'skipping coverage'; fi	530 B	2025-05-25 12:27
📄 CHANGELOG.md Changes by Version ================== 1.2.0 (2020-07-01) ------------------- * Restore the ability to reset the current span in context to nil (#231) -- Yuri Shkuro * Use error.object per OpenTracing Semantic Conventions (#179) -- Rahman Syed * Convert nil pointer log field value to string "nil" (#230) -- Cyril Tovena * Add Go module support (#215) -- Zaba505 * Make SetTag helper types in ext public (#229) -- Blake Edwards * Add log/fields helpers for keys from specification (#226) -- Dmitry Monakhov * Improve noop impementation (#223) -- chanxuehong * Add an extension to Tracer interface for custom go context creation (#220) -- Krzesimir Nowak * Fix typo in comments (#222) -- meteorlxy * Improve documentation for log.Object() to emphasize the requirement to pass immutable arguments (#219) -- 疯狂的小企鹅 * [mock] Return ErrInvalidSpanContext if span context is not MockSpanContext (#216) -- Milad Irannejad 1.1.0 (2019-03-23) ------------------- Notable changes: - The library is now released under Apache 2.0 license - Use Set() instead of Add() in HTTPHeadersCarrier is functionally a breaking change (fixes issue [#159](https://github.com/opentracing/opentracing-go/issues/159)) - 'golang.org/x/net/context' is replaced with 'context' from the standard library List of all changes: - Export StartSpanFromContextWithTracer (#214) <Aaron Delaney> - Add IsGlobalTracerRegistered() to indicate if a tracer has been registered (#201) <Mike Goldsmith> - Use Set() instead of Add() in HTTPHeadersCarrier (#191) <jeremyxu2010> - Update license to Apache 2.0 (#181) <Andrea Kao> - Replace 'golang.org/x/net/context' with 'context' (#176) <Tony Ghita> - Port of Python opentracing/harness/api_check.py to Go (#146) <chris erway> - Fix race condition in MockSpan.Context() (#170) <Brad> - Add PeerHostIPv4.SetString() (#155) <NeoCN> - Add a Noop log field type to log to allow for optional fields (#150) <Matt Ho> 1.0.2 (2017-04-26) ------------------- - Add more semantic tags (#139) <Rustam Zagirov> 1.0.1 (2017-02-06) ------------------- - Correct spelling in comments <Ben Sigelman> - Address race in nextMockID() (#123) <bill fumerola> - log: avoid panic marshaling nil error (#131) <Anthony Voutas> - Deprecate InitGlobalTracer in favor of SetGlobalTracer (#128) <Yuri Shkuro> - Drop Go 1.5 that fails in Travis (#129) <Yuri Shkuro> - Add convenience methods Key() and Value() to log.Field <Ben Sigelman> - Add convenience methods to log.Field (2 years, 6 months ago) <Radu Berinde> 1.0.0 (2016-09-26) ------------------- - This release implements OpenTracing Specification 1.0 (https://opentracing.io/spec)	2.58 KB	2025-05-25 12:27
📄 LICENSE Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "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.	11.09 KB	2025-05-25 12:27
📄 Makefile .DEFAULT_GOAL := test-and-lint .PHONY: test-and-lint test-and-lint: test lint .PHONY: test test: go test -v -cover -race ./... .PHONY: cover cover: go test -v -coverprofile=coverage.txt -covermode=atomic -race ./... .PHONY: lint lint: go fmt ./... golint ./... @# Run again with magic to exit non-zero if golint outputs anything. @! (golint ./... \| read dummy) go vet ./...	385 B	2025-05-25 12:27
📄 README.md [![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/opentracing/public) [![Build Status](https://travis-ci.org/opentracing/opentracing-go.svg?branch=master)](https://travis-ci.org/opentracing/opentracing-go) [![GoDoc](https://godoc.org/github.com/opentracing/opentracing-go?status.svg)](http://godoc.org/github.com/opentracing/opentracing-go) [![Sourcegraph Badge](https://sourcegraph.com/github.com/opentracing/opentracing-go/-/badge.svg)](https://sourcegraph.com/github.com/opentracing/opentracing-go?badge) # OpenTracing API for Go This package is a Go platform API for OpenTracing. ## Required Reading In order to understand the Go platform API, one must first be familiar with the [OpenTracing project](https://opentracing.io) and [terminology](https://opentracing.io/specification/) more specifically. ## API overview for those adding instrumentation Everyday consumers of this `opentracing` package really only need to worry about a couple of key abstractions: the `StartSpan` function, the `Span` interface, and binding a `Tracer` at `main()`-time. Here are code snippets demonstrating some important use cases. #### Singleton initialization The simplest starting point is `./default_tracer.go`. As early as possible, call ```go import "github.com/opentracing/opentracing-go" import ".../some_tracing_impl" func main() { opentracing.SetGlobalTracer( // tracing impl specific: some_tracing_impl.New(...), ) ... } ``` #### Non-Singleton initialization If you prefer direct control to singletons, manage ownership of the `opentracing.Tracer` implementation explicitly. #### Creating a Span given an existing Go `context.Context` If you use `context.Context` in your application, OpenTracing's Go library will happily rely on it for `Span` propagation. To start a new (blocking child) `Span`, you can use `StartSpanFromContext`. ```go func xyz(ctx context.Context, ...) { ... span, ctx := opentracing.StartSpanFromContext(ctx, "operation_name") defer span.Finish() span.LogFields( log.String("event", "soft error"), log.String("type", "cache timeout"), log.Int("waited.millis", 1500)) ... } ``` #### Starting an empty trace by creating a "root span" It's always possible to create a "root" `Span` with no parent or other causal reference. ```go func xyz() { ... sp := opentracing.StartSpan("operation_name") defer sp.Finish() ... } ``` #### Creating a (child) Span given an existing (parent) Span ```go func xyz(parentSpan opentracing.Span, ...) { ... sp := opentracing.StartSpan( "operation_name", opentracing.ChildOf(parentSpan.Context())) defer sp.Finish() ... } ``` #### Serializing to the wire ```go func makeSomeRequest(ctx context.Context) ... { if span := opentracing.SpanFromContext(ctx); span != nil { httpClient := &http.Client{} httpReq, _ := http.NewRequest("GET", "http://myservice/", nil) // Transmit the span's TraceContext as HTTP headers on our // outbound request. opentracing.GlobalTracer().Inject( span.Context(), opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(httpReq.Header)) resp, err := httpClient.Do(httpReq) ... } ... } ``` #### Deserializing from the wire ```go http.HandleFunc("/", func(w http.ResponseWriter, req http.Request) { var serverSpan opentracing.Span appSpecificOperationName := ... wireContext, err := opentracing.GlobalTracer().Extract( opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(req.Header)) if err != nil { // Optionally record something about err here } // Create the span referring to the RPC client if available. // If wireContext == nil, a root span will be created. serverSpan = opentracing.StartSpan( appSpecificOperationName, ext.RPCServerOption(wireContext)) defer serverSpan.Finish() ctx := opentracing.ContextWithSpan(context.Background(), serverSpan) ... } ``` #### Conditionally capture a field using `log.Noop` In some situations, you may want to dynamically decide whether or not to log a field. For example, you may want to capture additional data, such as a customer ID, in non-production environments: ```go func Customer(order Order) log.Field { if os.Getenv("ENVIRONMENT") == "dev" { return log.String("customer", order.Customer.ID) } return log.Noop() } ``` #### Goroutine-safety The entire public API is goroutine-safe and does not require external synchronization. ## API pointers for those implementing a tracing system Tracing system implementors may be able to reuse or copy-paste-modify the `basictracer` package, found [here](https://github.com/opentracing/basictracer-go). In particular, see `basictracer.New(...)`. ## 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. ## 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).	5.6 KB	2025-05-25 12:27
📁 ext	-	2025-05-25 12:27
📄 ext.go 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 }	870 B	2025-05-25 12:27
📄 globaltracer.go package opentracing type registeredTracer struct { tracer Tracer isRegistered bool } var ( globalTracer = registeredTracer{NoopTracer{}, false} ) // SetGlobalTracer sets the [singleton] opentracing.Tracer returned by // GlobalTracer(). Those who use GlobalTracer (rather than directly manage an // opentracing.Tracer instance) should call SetGlobalTracer as early as // possible in main(), prior to calling the `StartSpan` global func below. // Prior to calling `SetGlobalTracer`, any Spans started via the `StartSpan` // (etc) globals are noops. func SetGlobalTracer(tracer Tracer) { globalTracer = registeredTracer{tracer, true} } // GlobalTracer returns the global singleton `Tracer` implementation. // Before `SetGlobalTracer()` is called, the `GlobalTracer()` is a noop // implementation that drops all data handed to it. func GlobalTracer() Tracer { return globalTracer.tracer } // StartSpan defers to `Tracer.StartSpan`. See `GlobalTracer()`. func StartSpan(operationName string, opts ...StartSpanOption) Span { return globalTracer.tracer.StartSpan(operationName, opts...) } // InitGlobalTracer is deprecated. Please use SetGlobalTracer. func InitGlobalTracer(tracer Tracer) { SetGlobalTracer(tracer) } // IsGlobalTracerRegistered returns a `bool` to indicate if a tracer has been globally registered func IsGlobalTracerRegistered() bool { return globalTracer.isRegistered }	1.37 KB	2025-05-25 12:27
📄 globaltracer_test.go package opentracing import ( "reflect" "testing" ) func TestIsGlobalTracerRegisteredDefaultIsFalse(t testing.T) { if IsGlobalTracerRegistered() { t.Errorf("Should return false when no global tracer is registered.") } } func TestAfterSettingGlobalTracerIsGlobalTracerRegisteredReturnsTrue(t testing.T) { SetGlobalTracer(NoopTracer{}) if !IsGlobalTracerRegistered() { t.Errorf("Should return true after a tracer has been registered.") } } func TestDefaultTracerIsNoopTracer(t *testing.T) { if reflect.TypeOf(GlobalTracer()) != reflect.TypeOf(NoopTracer{}) { t.Errorf("Should return false when no global tracer is registered.") } }	651 B	2025-05-25 12:27
📄 go.mod module github.com/opentracing/opentracing-go go 1.14 require github.com/stretchr/testify v1.3.0	98 B	2025-05-25 12:27
📄 go.sum github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=	608 B	2025-05-25 12:27
📄 gocontext.go package opentracing import "context" type contextKey struct{} var activeSpanKey = contextKey{} // ContextWithSpan returns a new `context.Context` that holds a reference to // the span. If span is nil, a new context without an active span is returned. 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) } // SpanFromContext returns the `Span` previously associated with `ctx`, or // `nil` if no such `Span` could be found. // // NOTE: context.Context != SpanContext: the former is Go's intra-process // context propagation mechanism, and the latter houses OpenTracing's per-Span // identity and baggage information. func SpanFromContext(ctx context.Context) Span { val := ctx.Value(activeSpanKey) if sp, ok := val.(Span); ok { return sp } return nil } // StartSpanFromContext starts and returns a Span with `operationName`, using // any Span found within `ctx` as a ChildOfRef. If no such parent could be // found, StartSpanFromContext creates a root (parentless) Span. // // The second return value is a context.Context object built around the // returned Span. // // Example usage: // // SomeFunction(ctx context.Context, ...) { // sp, ctx := opentracing.StartSpanFromContext(ctx, "SomeFunction") // defer sp.Finish() // ... // } func StartSpanFromContext(ctx context.Context, operationName string, opts ...StartSpanOption) (Span, context.Context) { return StartSpanFromContextWithTracer(ctx, GlobalTracer(), operationName, opts...) } // StartSpanFromContextWithTracer starts and returns a span with `operationName` // using a span found within the context as a ChildOfRef. If that doesn't exist // 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 { opts = append(opts, ChildOf(parentSpan.Context())) } span := tracer.StartSpan(operationName, opts...) return span, ContextWithSpan(ctx, span) }	2.41 KB	2025-05-25 12:27
📄 gocontext_test.go package opentracing import ( "context" "testing" "time" "github.com/stretchr/testify/assert" ) func TestContextWithSpan(t testing.T) { span := &noopSpan{} ctx := ContextWithSpan(context.Background(), span) span2 := SpanFromContext(ctx) if span != span2 { t.Errorf("Not the same span returned from context, expected=%+v, actual=%+v", span, span2) } ctx = context.Background() span2 = SpanFromContext(ctx) if span2 != nil { t.Errorf("Expected nil span, found %+v", span2) } ctx = ContextWithSpan(ctx, span) span2 = SpanFromContext(ctx) if span != span2 { t.Errorf("Not the same span returned from context, expected=%+v, actual=%+v", span, span2) } ctx = ContextWithSpan(ctx, nil) if s := SpanFromContext(ctx); s != nil { t.Errorf("Not able to reset span in context, expected=nil, actual=%+v", s) } } type noopExtTracer struct { NoopTracer } type noopExtTracerCtxType struct{} func (noopExtTracer) ContextWithSpanHook(ctx context.Context, span Span) context.Context { return context.WithValue(ctx, noopExtTracerCtxType{}, noopExtTracerCtxType{}) } var _ Tracer = noopExtTracer{} var _ TracerContextWithSpanExtension = noopExtTracer{} type noopExtSpan struct { noopSpan } func (noopExtSpan) Tracer() Tracer { return noopExtTracer{} } var _ Span = noopExtSpan{} func TestContextWithSpanWithExtension(t testing.T) { span := &noopExtSpan{} ctx := ContextWithSpan(context.Background(), span) span2 := SpanFromContext(ctx) if span != span2 { t.Errorf("Not the same span returned from context, expected=%+v, actual=%+v", span, span2) } if _, ok := ctx.Value(noopExtTracerCtxType{}).(noopExtTracerCtxType); !ok { t.Error("ContextWithSpanHook was not called") } } func TestStartSpanFromContext(t testing.T) { testTracer := testTracer{} // Test the case where there is* a Span in the Context. { parentSpan := &testSpan{} parentCtx := ContextWithSpan(context.Background(), parentSpan) childSpan, childCtx := StartSpanFromContextWithTracer(parentCtx, testTracer, "child") if !childSpan.Context().(testSpanContext).HasParent { t.Errorf("Failed to find parent: %v", childSpan) } if !childSpan.(testSpan).Equal(SpanFromContext(childCtx)) { t.Errorf("Unable to find child span in context: %v", childCtx) } } // Test the case where there is not a Span in the Context. { emptyCtx := context.Background() childSpan, childCtx := StartSpanFromContextWithTracer(emptyCtx, testTracer, "child") if childSpan.Context().(testSpanContext).HasParent { t.Errorf("Should not have found parent: %v", childSpan) } if !childSpan.(testSpan).Equal(SpanFromContext(childCtx)) { t.Errorf("Unable to find child span in context: %v", childCtx) } } } func TestStartSpanFromContextOptions(t testing.T) { testTracer := testTracer{} // Test options are passed to tracer startTime := time.Now().Add(-10 time.Second) // ten seconds ago span, ctx := StartSpanFromContextWithTracer( context.Background(), testTracer, "parent", StartTime(startTime), Tag{"component", "test"}) assert.Equal(t, "test", span.(testSpan).Tags["component"]) assert.Equal(t, startTime, span.(testSpan).StartTime) // Test it also works for a child span childStartTime := startTime.Add(3 * time.Second) childSpan, _ := StartSpanFromContextWithTracer( ctx, testTracer, "child", StartTime(childStartTime)) assert.Equal(t, childSpan.(testSpan).Tags["component"], nil) assert.Equal(t, childSpan.(testSpan).StartTime, childStartTime) }	3.41 KB	2025-05-25 12:27
📁 harness	-	2025-05-25 12:27
📁 log	-	2025-05-25 12:27
📁 mocktracer	-	2025-05-25 12:27
📄 noop.go package opentracing import "github.com/opentracing/opentracing-go/log" // A NoopTracer is a trivial, minimum overhead implementation of Tracer // for which all operations are no-ops. // // The primary use of this implementation is in libraries, such as RPC // frameworks, that make tracing an optional feature controlled by the // end user. A no-op implementation allows said libraries to use it // as the default Tracer and to write instrumentation that does // not need to keep checking if the tracer instance is nil. // // For the same reason, the NoopTracer is the default "global" tracer // (see GlobalTracer and SetGlobalTracer functions). // // WARNING: NoopTracer does not support baggage propagation. type NoopTracer struct{} type noopSpan struct{} type noopSpanContext struct{} var ( defaultNoopSpanContext SpanContext = noopSpanContext{} defaultNoopSpan Span = noopSpan{} defaultNoopTracer Tracer = NoopTracer{} ) const ( emptyString = "" ) // noopSpanContext: func (n noopSpanContext) ForeachBaggageItem(handler func(k, v string) bool) {} // noopSpan: func (n noopSpan) Context() SpanContext { return defaultNoopSpanContext } func (n noopSpan) SetBaggageItem(key, val string) Span { return n } func (n noopSpan) BaggageItem(key string) string { return emptyString } func (n noopSpan) SetTag(key string, value interface{}) Span { return n } func (n noopSpan) LogFields(fields ...log.Field) {} func (n noopSpan) LogKV(keyVals ...interface{}) {} func (n noopSpan) Finish() {} func (n noopSpan) FinishWithOptions(opts FinishOptions) {} func (n noopSpan) SetOperationName(operationName string) Span { return n } func (n noopSpan) Tracer() Tracer { return defaultNoopTracer } func (n noopSpan) LogEvent(event string) {} func (n noopSpan) LogEventWithPayload(event string, payload interface{}) {} func (n noopSpan) Log(data LogData) {} // StartSpan belongs to the Tracer interface. func (n NoopTracer) StartSpan(operationName string, opts ...StartSpanOption) Span { return defaultNoopSpan } // Inject belongs to the Tracer interface. func (n NoopTracer) Inject(sp SpanContext, format interface{}, carrier interface{}) error { return nil } // Extract belongs to the Tracer interface. func (n NoopTracer) Extract(format interface{}, carrier interface{}) (SpanContext, error) { return nil, ErrSpanContextNotFound }	2.61 KB	2025-05-25 12:27
📄 options_test.go package opentracing import ( "testing" "github.com/stretchr/testify/require" ) func TestChildOfAndFollowsFrom(t *testing.T) { tests := []struct { newOpt func(SpanContext) SpanReference refType SpanReferenceType name string }{ {ChildOf, ChildOfRef, "ChildOf"}, {FollowsFrom, FollowsFromRef, "FollowsFrom"}, } for _, test := range tests { opts := new(StartSpanOptions) test.newOpt(nil).Apply(opts) require.Nil(t, opts.References, "%s(nil) must not append a reference", test.name) ctx := new(noopSpanContext) test.newOpt(ctx).Apply(opts) require.Equal(t, []SpanReference{ SpanReference{ReferencedContext: ctx, Type: test.refType}, }, opts.References, "%s(ctx) must append a reference", test.name) } }	742 B	2025-05-25 12:27
📄 propagation.go package opentracing import ( "errors" "net/http" ) /////////////////////////////////////////////////////////////////////////////// // CORE PROPAGATION INTERFACES: /////////////////////////////////////////////////////////////////////////////// var ( // ErrUnsupportedFormat occurs when the `format` passed to Tracer.Inject() or // Tracer.Extract() is not recognized by the Tracer implementation. ErrUnsupportedFormat = errors.New("opentracing: Unknown or unsupported Inject/Extract format") // ErrSpanContextNotFound occurs when the `carrier` passed to // Tracer.Extract() is valid and uncorrupted but has insufficient // information to extract a SpanContext. ErrSpanContextNotFound = errors.New("opentracing: SpanContext not found in Extract carrier") // ErrInvalidSpanContext errors occur when Tracer.Inject() is asked to // operate on a SpanContext which it is not prepared to handle (for // example, since it was created by a different tracer implementation). ErrInvalidSpanContext = errors.New("opentracing: SpanContext type incompatible with tracer") // ErrInvalidCarrier errors occur when Tracer.Inject() or Tracer.Extract() // implementations expect a different type of `carrier` than they are // given. ErrInvalidCarrier = errors.New("opentracing: Invalid Inject/Extract carrier") // ErrSpanContextCorrupted occurs when the `carrier` passed to // Tracer.Extract() is of the expected type but is corrupted. ErrSpanContextCorrupted = errors.New("opentracing: SpanContext data corrupted in Extract carrier") ) /////////////////////////////////////////////////////////////////////////////// // BUILTIN PROPAGATION FORMATS: /////////////////////////////////////////////////////////////////////////////// // BuiltinFormat is used to demarcate the values within package `opentracing` // that are intended for use with the Tracer.Inject() and Tracer.Extract() // methods. type BuiltinFormat byte const ( // Binary represents SpanContexts as opaque binary data. // // For Tracer.Inject(): the carrier must be an `io.Writer`. // // For Tracer.Extract(): the carrier must be an `io.Reader`. Binary BuiltinFormat = iota // TextMap represents SpanContexts as key:value string pairs. // // Unlike HTTPHeaders, the TextMap format does not restrict the key or // value character sets in any way. // // For Tracer.Inject(): the carrier must be a `TextMapWriter`. // // For Tracer.Extract(): the carrier must be a `TextMapReader`. TextMap // HTTPHeaders represents SpanContexts as HTTP header string pairs. // // Unlike TextMap, the HTTPHeaders format requires that the keys and values // be valid as HTTP headers as-is (i.e., character casing may be unstable // and special characters are disallowed in keys, values should be // URL-escaped, etc). // // For Tracer.Inject(): the carrier must be a `TextMapWriter`. // // For Tracer.Extract(): the carrier must be a `TextMapReader`. // // See HTTPHeadersCarrier for an implementation of both TextMapWriter // and TextMapReader that defers to an http.Header instance for storage. // For example, Inject(): // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // err := span.Tracer().Inject( // span.Context(), opentracing.HTTPHeaders, carrier) // // Or Extract(): // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // clientContext, err := tracer.Extract( // opentracing.HTTPHeaders, carrier) // HTTPHeaders ) // TextMapWriter is the Inject() carrier for the TextMap builtin format. With // it, the caller can encode a SpanContext for propagation as entries in a map // of unicode strings. type TextMapWriter interface { // Set a key:value pair to the carrier. Multiple calls to Set() for the // same key leads to undefined behavior. // // NOTE: The backing store for the TextMapWriter may contain data unrelated // to SpanContext. As such, Inject() and Extract() implementations that // call the TextMapWriter and TextMapReader interfaces must agree on a // prefix or other convention to distinguish their own key:value pairs. Set(key, val string) } // TextMapReader is the Extract() carrier for the TextMap builtin format. With it, // the caller can decode a propagated SpanContext as entries in a map of // unicode strings. type TextMapReader interface { // ForeachKey returns TextMap contents via repeated calls to the `handler` // function. If any call to `handler` returns a non-nil error, ForeachKey // terminates and returns that error. // // NOTE: The backing store for the TextMapReader may contain data unrelated // to SpanContext. As such, Inject() and Extract() implementations that // call the TextMapWriter and TextMapReader interfaces must agree on a // prefix or other convention to distinguish their own key:value pairs. // // The "foreach" callback pattern reduces unnecessary copying in some cases // and also allows implementations to hold locks while the map is read. ForeachKey(handler func(key, val string) error) error } // TextMapCarrier allows the use of regular map[string]string // as both TextMapWriter and TextMapReader. type TextMapCarrier map[string]string // ForeachKey conforms to the TextMapReader interface. func (c TextMapCarrier) ForeachKey(handler func(key, val string) error) error { for k, v := range c { if err := handler(k, v); err != nil { return err } } return nil } // Set implements Set() of opentracing.TextMapWriter func (c TextMapCarrier) Set(key, val string) { c[key] = val } // HTTPHeadersCarrier satisfies both TextMapWriter and TextMapReader. // // Example usage for server side: // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // clientContext, err := tracer.Extract(opentracing.HTTPHeaders, carrier) // // Example usage for client side: // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // err := tracer.Inject( // span.Context(), // opentracing.HTTPHeaders, // carrier) // type HTTPHeadersCarrier http.Header // Set conforms to the TextMapWriter interface. func (c HTTPHeadersCarrier) Set(key, val string) { h := http.Header(c) h.Set(key, val) } // ForeachKey conforms to the TextMapReader interface. func (c HTTPHeadersCarrier) ForeachKey(handler func(key, val string) error) error { for k, vals := range c { for _, v := range vals { if err := handler(k, v); err != nil { return err } } } return nil }	6.3 KB	2025-05-25 12:27
📄 propagation_test.go package opentracing import ( "net/http" "strconv" "testing" ) const testHeaderPrefix = "testprefix-" func TestTextMapCarrierInject(t testing.T) { m := make(map[string]string) m["NotOT"] = "blah" m["opname"] = "AlsoNotOT" tracer := testTracer{} span := tracer.StartSpan("someSpan") fakeID := span.Context().(testSpanContext).FakeID carrier := TextMapCarrier(m) if err := span.Tracer().Inject(span.Context(), TextMap, carrier); err != nil { t.Fatal(err) } if len(m) != 3 { t.Errorf("Unexpected header length: %v", len(m)) } // The prefix comes from just above; the suffix comes from // testTracer.Inject(). if m["testprefix-fakeid"] != strconv.Itoa(fakeID) { t.Errorf("Could not find fakeid at expected key") } } func TestTextMapCarrierExtract(t testing.T) { m := make(map[string]string) m["NotOT"] = "blah" m["opname"] = "AlsoNotOT" m["testprefix-fakeid"] = "42" tracer := testTracer{} carrier := TextMapCarrier(m) extractedContext, err := tracer.Extract(TextMap, carrier) if err != nil { t.Fatal(err) } if extractedContext.(testSpanContext).FakeID != 42 { t.Errorf("Failed to read testprefix-fakeid correctly") } } func TestHTTPHeaderInject(t testing.T) { h := http.Header{} h.Add("NotOT", "blah") h.Add("opname", "AlsoNotOT") tracer := testTracer{} span := tracer.StartSpan("someSpan") fakeID := span.Context().(testSpanContext).FakeID // Use HTTPHeadersCarrier to wrap around `h`. carrier := HTTPHeadersCarrier(h) if err := span.Tracer().Inject(span.Context(), HTTPHeaders, carrier); err != nil { t.Fatal(err) } if len(h) != 3 { t.Errorf("Unexpected header length: %v", len(h)) } // The prefix comes from just above; the suffix comes from // testTracer.Inject(). if h.Get("testprefix-fakeid") != strconv.Itoa(fakeID) { t.Errorf("Could not find fakeid at expected key") } } func TestHTTPHeaderExtract(t testing.T) { h := http.Header{} h.Add("NotOT", "blah") h.Add("opname", "AlsoNotOT") h.Add("testprefix-fakeid", "42") tracer := testTracer{} // Use HTTPHeadersCarrier to wrap around `h`. carrier := HTTPHeadersCarrier(h) spanContext, err := tracer.Extract(HTTPHeaders, carrier) if err != nil { t.Fatal(err) } if spanContext.(testSpanContext).FakeID != 42 { t.Errorf("Failed to read testprefix-fakeid correctly") } }	2.26 KB	2025-05-25 12:27
📄 span.go package opentracing import ( "time" "github.com/opentracing/opentracing-go/log" ) // SpanContext represents Span state that must propagate to descendant Spans and across process // boundaries (e.g., a <trace_id, span_id, sampled> tuple). type SpanContext interface { // ForeachBaggageItem grants access to all baggage items stored in the // SpanContext. // The handler function will be called for each baggage key/value pair. // The ordering of items is not guaranteed. // // The bool return value indicates if the handler wants to continue iterating // through the rest of the baggage items; for example if the handler is trying to // find some baggage item by pattern matching the name, it can return false // as soon as the item is found to stop further iterations. ForeachBaggageItem(handler func(k, v string) bool) } // Span represents an active, un-finished span in the OpenTracing system. // // Spans are created by the Tracer interface. type Span interface { // Sets the end timestamp and finalizes Span state. // // With the exception of calls to Context() (which are always allowed), // Finish() must be the last call made to any span instance, and to do // otherwise leads to undefined behavior. Finish() // FinishWithOptions is like Finish() but with explicit control over // timestamps and log data. FinishWithOptions(opts FinishOptions) // Context() yields the SpanContext for this Span. Note that the return // value of Context() is still valid after a call to Span.Finish(), as is // a call to Span.Context() after a call to Span.Finish(). Context() SpanContext // Sets or changes the operation name. // // Returns a reference to this Span for chaining. SetOperationName(operationName string) Span // Adds a tag to the span. // // If there is a pre-existing tag set for `key`, it is overwritten. // // Tag values can be numeric types, strings, or bools. The behavior of // 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 // may ignore the tag, but shall not panic. // // Returns a reference to this Span for chaining. SetTag(key string, value interface{}) Span // LogFields is an efficient and type-checked way to record key:value // logging data about a Span, though the programming interface is a little // more verbose than LogKV(). Here's an example: // // span.LogFields( // log.String("event", "soft error"), // log.String("type", "cache timeout"), // log.Int("waited.millis", 1500)) // // Also see Span.FinishWithOptions() and FinishOptions.BulkLogData. LogFields(fields ...log.Field) // LogKV is a concise, readable way to record key:value logging data about // a Span, though unfortunately this also makes it less efficient and less // type-safe than LogFields(). Here's an example: // // span.LogKV( // "event", "soft error", // "type", "cache timeout", // "waited.millis", 1500) // // For LogKV (as opposed to LogFields()), the parameters must appear as // key-value pairs, like // // span.LogKV(key1, val1, key2, val2, key3, val3, ...) // // The keys must all be strings. The values may be strings, numeric types, // bools, Go error instances, or arbitrary structs. // // (Note to implementors: consider the log.InterleavedKVToFields() helper) LogKV(alternatingKeyValues ...interface{}) // SetBaggageItem sets a key:value pair on this Span and its SpanContext // that also propagates to descendants of this Span. // // SetBaggageItem() enables powerful functionality given a full-stack // opentracing integration (e.g., arbitrary application data from a mobile // app can make it, transparently, all the way into the depths of a storage // system), and with it some powerful costs: use this feature with care. // // IMPORTANT NOTE #1: SetBaggageItem() will only propagate baggage items to // future causal descendants of the associated Span. // // IMPORTANT NOTE #2: Use this thoughtfully and with care. Every key and // value is copied into every local and remote child of the associated // Span, and that can add up to a lot of network and cpu overhead. // // Returns a reference to this Span for chaining. SetBaggageItem(restrictedKey, value string) Span // Gets the value for a baggage item given its key. Returns the empty string // if the value isn't found in this Span. BaggageItem(restrictedKey string) string // Provides access to the Tracer that created this Span. Tracer() Tracer // Deprecated: use LogFields or LogKV LogEvent(event string) // Deprecated: use LogFields or LogKV LogEventWithPayload(event string, payload interface{}) // Deprecated: use LogFields or LogKV Log(data LogData) } // LogRecord is data associated with a single Span log. Every LogRecord // instance must specify at least one Field. type LogRecord struct { Timestamp time.Time Fields []log.Field } // FinishOptions allows Span.FinishWithOptions callers to override the finish // timestamp and provide log data via a bulk interface. type FinishOptions struct { // FinishTime overrides the Span's finish time, or implicitly becomes // time.Now() if FinishTime.IsZero(). // // FinishTime must resolve to a timestamp that's >= the Span's StartTime // (per StartSpanOptions). FinishTime time.Time // LogRecords allows the caller to specify the contents of many LogFields() // calls with a single slice. May be nil. // // None of the LogRecord.Timestamp values may be .IsZero() (i.e., they must // be set explicitly). Also, they must be >= the Span's start timestamp and // <= the FinishTime (or time.Now() if FinishTime.IsZero()). Otherwise the // behavior of FinishWithOptions() is undefined. // // If specified, the caller hands off ownership of LogRecords at // FinishWithOptions() invocation time. // // If specified, the (deprecated) BulkLogData must be nil or empty. LogRecords []LogRecord // BulkLogData is DEPRECATED. BulkLogData []LogData } // LogData is DEPRECATED type LogData struct { Timestamp time.Time Event string Payload interface{} } // ToLogRecord converts a deprecated LogData to a non-deprecated LogRecord func (ld *LogData) ToLogRecord() LogRecord { var literalTimestamp time.Time if ld.Timestamp.IsZero() { literalTimestamp = time.Now() } else { literalTimestamp = ld.Timestamp } rval := LogRecord{ Timestamp: literalTimestamp, } if ld.Payload == nil { rval.Fields = []log.Field{ log.String("event", ld.Event), } } else { rval.Fields = []log.Field{ log.String("event", ld.Event), log.Object("payload", ld.Payload), } } return rval }	6.54 KB	2025-05-25 12:27
📄 testtracer_test.go package opentracing import ( "strconv" "strings" "time" "github.com/opentracing/opentracing-go/log" ) const testHTTPHeaderPrefix = "testprefix-" // testTracer is a most-noop Tracer implementation that makes it possible for // unittests to verify whether certain methods were / were not called. type testTracer struct{} var fakeIDSource = 1 func nextFakeID() int { fakeIDSource++ return fakeIDSource } type testSpanContext struct { HasParent bool FakeID int } func (n testSpanContext) ForeachBaggageItem(handler func(k, v string) bool) {} type testSpan struct { spanContext testSpanContext OperationName string StartTime time.Time Tags map[string]interface{} } func (n testSpan) Equal(os Span) bool { other, ok := os.(testSpan) if !ok { return false } if n.spanContext != other.spanContext { return false } if n.OperationName != other.OperationName { return false } if !n.StartTime.Equal(other.StartTime) { return false } if len(n.Tags) != len(other.Tags) { return false } for k, v := range n.Tags { if ov, ok := other.Tags[k]; !ok \|\| ov != v { return false } } return true } // testSpan: func (n testSpan) Context() SpanContext { return n.spanContext } func (n testSpan) SetTag(key string, value interface{}) Span { return n } func (n testSpan) Finish() {} func (n testSpan) FinishWithOptions(opts FinishOptions) {} func (n testSpan) LogFields(fields ...log.Field) {} func (n testSpan) LogKV(kvs ...interface{}) {} func (n testSpan) SetOperationName(operationName string) Span { return n } func (n testSpan) Tracer() Tracer { return testTracer{} } func (n testSpan) SetBaggageItem(key, val string) Span { return n } func (n testSpan) BaggageItem(key string) string { return "" } func (n testSpan) LogEvent(event string) {} func (n testSpan) LogEventWithPayload(event string, payload interface{}) {} func (n testSpan) Log(data LogData) {} // StartSpan belongs to the Tracer interface. func (n testTracer) StartSpan(operationName string, opts ...StartSpanOption) Span { sso := StartSpanOptions{} for _, o := range opts { o.Apply(&sso) } return n.startSpanWithOptions(operationName, sso) } func (n testTracer) startSpanWithOptions(name string, opts StartSpanOptions) Span { fakeID := nextFakeID() if len(opts.References) > 0 { fakeID = opts.References[0].ReferencedContext.(testSpanContext).FakeID } return testSpan{ OperationName: name, StartTime: opts.StartTime, Tags: opts.Tags, spanContext: testSpanContext{ HasParent: len(opts.References) > 0, FakeID: fakeID, }, } } // Inject belongs to the Tracer interface. func (n testTracer) Inject(sp SpanContext, format interface{}, carrier interface{}) error { spanContext := sp.(testSpanContext) switch format { case HTTPHeaders, TextMap: carrier.(TextMapWriter).Set(testHTTPHeaderPrefix+"fakeid", strconv.Itoa(spanContext.FakeID)) return nil } return ErrUnsupportedFormat } // Extract belongs to the Tracer interface. func (n testTracer) Extract(format interface{}, carrier interface{}) (SpanContext, error) { switch format { case HTTPHeaders, TextMap: // Just for testing purposes... generally not a worthwhile thing to // propagate. sm := testSpanContext{} err := carrier.(TextMapReader).ForeachKey(func(key, val string) error { switch strings.ToLower(key) { case testHTTPHeaderPrefix + "fakeid": i, err := strconv.Atoi(val) if err != nil { return err } sm.FakeID = i } return nil }) return sm, err } return nil, ErrSpanContextNotFound }	3.8 KB	2025-05-25 12:27
📄 tracer.go package opentracing import "time" // Tracer is a simple, thin interface for Span creation and SpanContext // propagation. type Tracer interface { // Create, start, and return a new Span with the given `operationName` and // incorporate the given StartSpanOption `opts`. (Note that `opts` borrows // from the "functional options" pattern, per // http://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis) // // A Span with no SpanReference options (e.g., opentracing.ChildOf() or // opentracing.FollowsFrom()) becomes the root of its own trace. // // Examples: // // var tracer opentracing.Tracer = ... // // // The root-span case: // sp := tracer.StartSpan("GetFeed") // // // The vanilla child span case: // sp := tracer.StartSpan( // "GetFeed", // opentracing.ChildOf(parentSpan.Context())) // // // All the bells and whistles: // sp := tracer.StartSpan( // "GetFeed", // opentracing.ChildOf(parentSpan.Context()), // opentracing.Tag{"user_agent", loggedReq.UserAgent}, // opentracing.StartTime(loggedReq.Timestamp), // ) // StartSpan(operationName string, opts ...StartSpanOption) Span // Inject() takes the `sm` SpanContext instance and injects it for // propagation within `carrier`. The actual type of `carrier` depends on // the value of `format`. // // OpenTracing defines a common set of `format` values (see BuiltinFormat), // and each has an expected carrier type. // // Other packages may declare their own `format` values, much like the keys // used by `context.Context` (see https://godoc.org/context#WithValue). // // Example usage (sans error handling): // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // err := tracer.Inject( // span.Context(), // opentracing.HTTPHeaders, // carrier) // // NOTE: All opentracing.Tracer implementations MUST support all // BuiltinFormats. // // Implementations may return opentracing.ErrUnsupportedFormat if `format` // is not supported by (or not known by) the implementation. // // Implementations may return opentracing.ErrInvalidCarrier or any other // implementation-specific error if the format is supported but injection // fails anyway. // // See Tracer.Extract(). Inject(sm SpanContext, format interface{}, carrier interface{}) error // Extract() returns a SpanContext instance given `format` and `carrier`. // // OpenTracing defines a common set of `format` values (see BuiltinFormat), // and each has an expected carrier type. // // Other packages may declare their own `format` values, much like the keys // used by `context.Context` (see // https://godoc.org/golang.org/x/net/context#WithValue). // // Example usage (with StartSpan): // // // carrier := opentracing.HTTPHeadersCarrier(httpReq.Header) // clientContext, err := tracer.Extract(opentracing.HTTPHeaders, carrier) // // // ... assuming the ultimate goal here is to resume the trace with a // // server-side Span: // var serverSpan opentracing.Span // if err == nil { // span = tracer.StartSpan( // rpcMethodName, ext.RPCServerOption(clientContext)) // } else { // span = tracer.StartSpan(rpcMethodName) // } // // // NOTE: All opentracing.Tracer implementations MUST support all // BuiltinFormats. // // Return values: // - A successful Extract returns a SpanContext instance and a nil error // - If there was simply no SpanContext to extract in `carrier`, Extract() // returns (nil, opentracing.ErrSpanContextNotFound) // - If `format` is unsupported or unrecognized, Extract() returns (nil, // opentracing.ErrUnsupportedFormat) // - If there are more fundamental problems with the `carrier` object, // Extract() may return opentracing.ErrInvalidCarrier, // opentracing.ErrSpanContextCorrupted, or implementation-specific // errors. // // See Tracer.Inject(). Extract(format interface{}, carrier interface{}) (SpanContext, error) } // StartSpanOptions allows Tracer.StartSpan() callers and implementors a // mechanism to override the start timestamp, specify Span References, and make // a single Tag or multiple Tags available at Span start time. // // StartSpan() callers should look at the StartSpanOption interface and // implementations available in this package. // // Tracer implementations can convert a slice of `StartSpanOption` instances // into a `StartSpanOptions` struct like so: // // func StartSpan(opName string, opts ...opentracing.StartSpanOption) { // sso := opentracing.StartSpanOptions{} // for _, o := range opts { // o.Apply(&sso) // } // ... // } // type StartSpanOptions struct { // Zero or more causal references to other Spans (via their SpanContext). // If empty, start a "root" Span (i.e., start a new trace). References []SpanReference // StartTime overrides the Span's start time, or implicitly becomes // time.Now() if StartTime.IsZero(). StartTime time.Time // Tags may have zero or more entries; the restrictions on map values are // identical to those for Span.SetTag(). May be nil. // // If specified, the caller hands off ownership of Tags at // StartSpan() invocation time. Tags map[string]interface{} } // StartSpanOption instances (zero or more) may be passed to Tracer.StartSpan. // // StartSpanOption borrows from the "functional options" pattern, per // http://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis type StartSpanOption interface { Apply(StartSpanOptions) } // SpanReferenceType is an enum type describing different categories of // relationships between two Spans. If Span-2 refers to Span-1, the // SpanReferenceType describes Span-1 from Span-2's perspective. For example, // ChildOfRef means that Span-1 created Span-2. // // NOTE: Span-1 and Span-2 do not* necessarily depend on each other for // completion; e.g., Span-2 may be part of a background job enqueued by Span-1, // or Span-2 may be sitting in a distributed queue behind Span-1. type SpanReferenceType int const ( // ChildOfRef refers to a parent Span that caused and somehow depends // upon the new child Span. Often (but not always), the parent Span cannot // finish until the child Span does. // // An timing diagram for a ChildOfRef that's blocked on the new Span: // // [-Parent Span---------] // [-Child Span----] // // See http://opentracing.io/spec/ // // See opentracing.ChildOf() ChildOfRef SpanReferenceType = iota // FollowsFromRef refers to a parent Span that does not depend in any way // on the result of the new child Span. For instance, one might use // FollowsFromRefs to describe pipeline stages separated by queues, // or a fire-and-forget cache insert at the tail end of a web request. // // A FollowsFromRef Span is part of the same logical trace as the new Span: // i.e., the new Span is somehow caused by the work of its FollowsFromRef. // // All of the following could be valid timing diagrams for children that // "FollowFrom" a parent. // // [-Parent Span-] [-Child Span-] // // // [-Parent Span--] // [-Child Span-] // // // [-Parent Span-] // [-Child Span-] // // See http://opentracing.io/spec/ // // See opentracing.FollowsFrom() FollowsFromRef ) // SpanReference is a StartSpanOption that pairs a SpanReferenceType and a // referenced SpanContext. See the SpanReferenceType documentation for // supported relationships. If SpanReference is created with // ReferencedContext==nil, it has no effect. Thus it allows for a more concise // syntax for starting spans: // // sc, _ := tracer.Extract(someFormat, someCarrier) // span := tracer.StartSpan("operation", opentracing.ChildOf(sc)) // // The `ChildOf(sc)` option above will not panic if sc == nil, it will just // not add the parent span reference to the options. type SpanReference struct { Type SpanReferenceType ReferencedContext SpanContext } // Apply satisfies the StartSpanOption interface. func (r SpanReference) Apply(o StartSpanOptions) { if r.ReferencedContext != nil { o.References = append(o.References, r) } } // ChildOf returns a StartSpanOption pointing to a dependent parent span. // If sc == nil, the option has no effect. // // See ChildOfRef, SpanReference func ChildOf(sc SpanContext) SpanReference { return SpanReference{ Type: ChildOfRef, ReferencedContext: sc, } } // FollowsFrom returns a StartSpanOption pointing to a parent Span that caused // the child Span but does not directly depend on its result in any way. // If sc == nil, the option has no effect. // // See FollowsFromRef, SpanReference func FollowsFrom(sc SpanContext) SpanReference { return SpanReference{ Type: FollowsFromRef, ReferencedContext: sc, } } // StartTime is a StartSpanOption that sets an explicit start timestamp for the // new Span. type StartTime time.Time // Apply satisfies the StartSpanOption interface. func (t StartTime) Apply(o StartSpanOptions) { o.StartTime = time.Time(t) } // Tags are a generic map from an arbitrary string key to an opaque value type. // The underlying tracing system is responsible for interpreting and // serializing the values. type Tags map[string]interface{} // Apply satisfies the StartSpanOption interface. func (t Tags) Apply(o StartSpanOptions) { if o.Tags == nil { o.Tags = make(map[string]interface{}) } for k, v := range t { o.Tags[k] = v } } // Tag may be passed as a StartSpanOption to add a tag to new spans, // or its Set method may be used to apply the tag to an existing Span, // for example: // // tracer.StartSpan("opName", Tag{"Key", value}) // // or // // Tag{"key", value}.Set(span) type Tag struct { Key string Value interface{} } // Apply satisfies the StartSpanOption interface. func (t Tag) Apply(o StartSpanOptions) { if o.Tags == nil { o.Tags = make(map[string]interface{}) } o.Tags[t.Key] = t.Value } // Set applies the tag to an existing Span. func (t Tag) Set(s Span) { s.SetTag(t.Key, t.Value) }	9.96 KB	2025-05-25 12:27

Edit File:

Terminal