trace

package

v0.0.0-...-d01dfd4 Latest Latest Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/goharbor/harbor

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Enabled() bool
func ExractTraceID(r *http.Request) string
func GetGlobalTracer(instrumentationName string, opts ...oteltrace.TracerOption) oteltrace.Tracer
func HarborSpanNameFormatter(operation string, r *http.Request) string
func InitGlobalConfig(opts ...Option)
func NewHandler(h http.Handler, operation string) http.Handler
func RecordError(span oteltrace.Span, err error, description string)
func SpanFromHTTPRequest(req *http.Request) oteltrace.Span
func StartSpan(ctx context.Context, name string) (context.Context, oteltrace.Span)
func StartTrace(ctx context.Context, tracerName string, spanName string, ...) (context.Context, oteltrace.Span)
type Config
- func GetGlobalConfig() Config
- func NewConfig(opts ...Option) Config
- func (c *Config) String() string
type JaegerConfig
- func (c *JaegerConfig) String() string
type Option
- func WithAttributes(attributes map[string]string) Option
- func WithEnabled(enabled bool) Option
- func WithJaegerAgentHost(host string) Option
- func WithJaegerAgentPort(port string) Option
- func WithJaegerEndpoint(endpoint string) Option
- func WithJaegerPassword(password string) Option
- func WithJaegerUsername(username string) Option
- func WithNamespace(namespace string) Option
- func WithOtelCompression(compression bool) Option
- func WithOtelEndpoint(endpoint string) Option
- func WithOtelInsecure(insecure bool) Option
- func WithOtelTimeout(timeout int) Option
- func WithOtelURLPath(urlPath string) Option
- func WithSampleRate(sampleRate float64) Option
- func WithServiceName(serviceName string) Option
type OtelConfig
- func (c *OtelConfig) String() string
type ShutdownFunc
- func InitGlobalTracer(ctx context.Context) ShutdownFunc
- func (s ShutdownFunc) Shutdown()

Constants ¶

View Source

const (
	TraceEnvPrefix = "trace"
)

Variables ¶

View Source

var HarborHTTPTraceOptions = []otelhttp.Option{
	otelhttp.WithTracerProvider(otel.GetTracerProvider()),
	otelhttp.WithPropagators(otel.GetTextMapPropagator()),
	otelhttp.WithSpanNameFormatter(HarborSpanNameFormatter),
}

HarborHTTPTraceOptions common trace options

Functions ¶

func Enabled ¶

func Enabled() bool

Enabled returns whether trace is enabled

func ExractTraceID ¶

func ExractTraceID(r *http.Request) string

ExractTraceID returns OpenTelemetry Trace ID

If tracing is enabled, the trace middleware already put the Span into request context,
	so the func returns the Trace ID form request context
If tracing is NOT enabled, the func returns the Trace ID from the request header (if exists)
If Trace ID is not found, the func returns empty string

func GetGlobalTracer ¶

func GetGlobalTracer(instrumentationName string, opts ...oteltrace.TracerOption) oteltrace.Tracer

GetGlobalTracer returns the global tracer.

func HarborSpanNameFormatter ¶

func HarborSpanNameFormatter(operation string, r *http.Request) string

HarborSpanNameFormatter common span name formatter in Harbor

func InitGlobalConfig ¶

func InitGlobalConfig(opts ...Option)

func NewHandler ¶

func NewHandler(h http.Handler, operation string) http.Handler

NewHandler returns a handler that wraps the given handler with tracing.

func RecordError ¶

func RecordError(span oteltrace.Span, err error, description string)

RecordError records the error in the span from context.

func SpanFromHTTPRequest ¶

func SpanFromHTTPRequest(req *http.Request) oteltrace.Span

SpanFromHTTPRequest returns the span from the context.

func StartSpan ¶

func StartSpan(ctx context.Context, name string) (context.Context, oteltrace.Span)

StartSpan starts a span with the given name.

func StartTrace ¶

func StartTrace(ctx context.Context, tracerName string, spanName string, opts ...oteltrace.SpanStartOption) (context.Context, oteltrace.Span)

StartTrace returns a new span with the given name.

Types ¶

type Config ¶

type Config struct {
	Enabled     bool    `mapstructure:"enabled"`
	SampleRate  float64 `mapstructure:"sample_rate"`
	Namespace   string  `mapstructure:"namespace"`
	ServiceName string  `mapstructure:"service_name"`
	Jaeger      JaegerConfig
	Otel        OtelConfig
	Attributes  map[string]string
}

Config is the configuration for trace

var C Config

C is the global configuration for trace

func GetGlobalConfig ¶

func GetGlobalConfig() Config

GetGlobalConfig returns the global configuration for trace

func NewConfig ¶

func NewConfig(opts ...Option) Config

func (*Config) String ¶

func (c *Config) String() string

type JaegerConfig ¶

type JaegerConfig struct {
	Endpoint  string `mapstructure:"jaeger_endpoint"`
	Username  string `mapstructure:"jaeger_username"`
	Password  string `mapstructure:"jaeger_password"`
	AgentHost string `mapstructure:"jaeger_agent_host"`
	AgentPort string `mapstructure:"jaeger_agent_port"`
}

JaegerConfig is the configuration for Jaeger

func (*JaegerConfig) String ¶

func (c *JaegerConfig) String() string

type Option ¶

type Option func(*Config)

func WithAttributes ¶

func WithAttributes(attributes map[string]string) Option

func WithEnabled ¶

func WithEnabled(enabled bool) Option

func WithJaegerAgentHost ¶

func WithJaegerAgentHost(host string) Option

func WithJaegerAgentPort ¶

func WithJaegerAgentPort(port string) Option

func WithJaegerEndpoint ¶

func WithJaegerEndpoint(endpoint string) Option

func WithJaegerPassword ¶

func WithJaegerPassword(password string) Option

func WithJaegerUsername ¶

func WithJaegerUsername(username string) Option

func WithNamespace ¶

func WithNamespace(namespace string) Option

func WithOtelCompression ¶

func WithOtelCompression(compression bool) Option

func WithOtelEndpoint ¶

func WithOtelEndpoint(endpoint string) Option

func WithOtelInsecure ¶

func WithOtelInsecure(insecure bool) Option

func WithOtelTimeout ¶

func WithOtelTimeout(timeout int) Option

func WithOtelURLPath ¶

func WithOtelURLPath(urlPath string) Option

func WithSampleRate ¶

func WithSampleRate(sampleRate float64) Option

func WithServiceName ¶

func WithServiceName(serviceName string) Option

type OtelConfig ¶

type OtelConfig struct {
	Endpoint    string `mapstructure:"otel_trace_endpoint"`
	URLPath     string `mapstructure:"otel_trace_url_path"`
	Compression bool   `mapstructure:"otel_trace_compression"`
	Insecure    bool   `mapstructure:"otel_trace_insecure"`
	Timeout     int    `mapstructure:"otel_trace_timeout"`
}

OtelConfig is the configuration for otel

func (*OtelConfig) String ¶

func (c *OtelConfig) String() string

type ShutdownFunc ¶

type ShutdownFunc func()

ShutdownFunc is a function to shutdown the trace provider

func InitGlobalTracer ¶

func InitGlobalTracer(ctx context.Context) ShutdownFunc

Init initializes the trace provider

func (ShutdownFunc) Shutdown ¶

func (s ShutdownFunc) Shutdown()

Shutdown shutdown the trace provider

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL