pachyderm: github.com/pachyderm/pachyderm/src/client/pkg/tracing Index | Files | Directories

package tracing

import "github.com/pachyderm/pachyderm/src/client/pkg/tracing"

Index

Package Files

pipelinetrace.pb.go tracing.go

Constants

const JaegerServiceName = "pachd"

JaegerServiceName is the name pachd (and the pachyderm client) uses to describe itself when it reports traces to Jaeger

Variables

var (
    ErrInvalidLengthPipelinetrace = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowPipelinetrace   = fmt.Errorf("proto: integer overflow")
)

func AddSpanToAnyExisting Uses

func AddSpanToAnyExisting(ctx context.Context, operation string, kvs ...interface{}) (opentracing.Span, context.Context)

AddSpanToAnyExisting checks 'ctx' for Jaeger tracing information, and if tracing metadata is present, it generates a new span for 'operation', marks it as a child of the existing span, and returns it.

func CloseAndReportTraces Uses

func CloseAndReportTraces()

CloseAndReportTraces tries to close the global tracer, which, in the case of the Jaeger tracer, causes it to send any unreported traces to the collector

func FinishAnySpan Uses

func FinishAnySpan(span opentracing.Span)

FinishAnySpan calls span.Finish() if span is not nil. Pairs with AddSpanToAnyExisting

func InstallJaegerTracerFromEnv Uses

func InstallJaegerTracerFromEnv()

InstallJaegerTracerFromEnv installs a Jaeger client as the opentracing global tracer, relying on environment variables to configure the client

func IsActive Uses

func IsActive() bool

IsActive returns true if a connection to Jaeger has been established and a global tracer has been installed

func StreamClientInterceptor Uses

func StreamClientInterceptor() grpc.StreamClientInterceptor

StreamClientInterceptor returns a GRPC interceptor for non-streaming GRPC RPCs

func StreamServerInterceptor Uses

func StreamServerInterceptor() grpc.StreamServerInterceptor

StreamServerInterceptor returns a GRPC interceptor for non-streaming GRPC RPCs

func TagAnySpan Uses

func TagAnySpan(spanBox interface{}, kvs ...interface{}) opentracing.Span

TagAnySpan tags any span associated with 'spanBox' (which must be either a span itself or a context.Context) with 'kvs'

func UnaryClientInterceptor Uses

func UnaryClientInterceptor() grpc.UnaryClientInterceptor

UnaryClientInterceptor returns a GRPC interceptor for non-streaming GRPC RPCs

func UnaryServerInterceptor Uses

func UnaryServerInterceptor() grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a GRPC interceptor for non-streaming GRPC RPCs

type TraceInfo Uses

type TraceInfo struct {
    // value contains the info identifying a trace in Jaeger (a
    // (trace ID, span ID, sampled) tuple, basically)
    Value map[string]string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // tags are identifiers with which this trace be retrieves from etcd. In the
    // case of a CreatePipeline trace, this would have one value: the name of the
    // pipeline. In the case of a FinishCommit trace, we'd have one tag for each
    // output commit that we want to track.
    //
    // This field has to be at the top-level of TraceInfo so we can index off of
    // it in the 'traces' collection, but because it's ambiguous and may not be
    // populated when the TraceInfo is collected, we store the information needed
    // to populate it in the various <operation>_opts fields below.
    Tags                  []string                           `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"`
    CreatePipelineOpts    *TraceInfo_CreatePipelineTraceOpts `protobuf:"bytes,3,opt,name=create_pipeline_opts,json=createPipelineOpts,proto3" json:"create_pipeline_opts,omitempty"`
    FinishCommitTraceOpts *TraceInfo_FinishCommitTraceOpts   `protobuf:"bytes,4,opt,name=finish_commit_trace_opts,json=finishCommitTraceOpts,proto3" json:"finish_commit_trace_opts,omitempty"`
    XXX_NoUnkeyedLiteral  struct{}                           `json:"-"`
    XXX_unrecognized      []byte                             `json:"-"`
    XXX_sizecache         int32                              `json:"-"`
}

TraceInfo contains information identifying a Jaeger trace. It's used to propagate "Super Traces"—traces that live longer than any single RPC. Currently, there are two kinds of Super Traces: - CreatePipeline traces, which start with 'pachctl create-pipeline' and end

when the created pipeline is in the "running" state (or when any errors are
encountered)

- FinishCommit traces, which start with 'pachctl finish-commit' (or the end

of a one-off 'pachctl put-file' command) and ends when the target pipeline
(or last pipeline to process the newly-created commit) finishes the output
commit generated by this input commit

func (*TraceInfo) Descriptor Uses

func (*TraceInfo) Descriptor() ([]byte, []int)

func (*TraceInfo) GetCreatePipelineOpts Uses

func (m *TraceInfo) GetCreatePipelineOpts() *TraceInfo_CreatePipelineTraceOpts

func (*TraceInfo) GetFinishCommitTraceOpts Uses

func (m *TraceInfo) GetFinishCommitTraceOpts() *TraceInfo_FinishCommitTraceOpts

func (*TraceInfo) GetTags Uses

func (m *TraceInfo) GetTags() []string

func (*TraceInfo) GetValue Uses

func (m *TraceInfo) GetValue() map[string]string

func (*TraceInfo) Marshal Uses

func (m *TraceInfo) Marshal() (dAtA []byte, err error)

func (*TraceInfo) MarshalTo Uses

func (m *TraceInfo) MarshalTo(dAtA []byte) (int, error)

func (*TraceInfo) ProtoMessage Uses

func (*TraceInfo) ProtoMessage()

func (*TraceInfo) Reset Uses

func (m *TraceInfo) Reset()

func (*TraceInfo) Size Uses

func (m *TraceInfo) Size() (n int)

func (*TraceInfo) String Uses

func (m *TraceInfo) String() string

func (*TraceInfo) Unmarshal Uses

func (m *TraceInfo) Unmarshal(dAtA []byte) error

func (*TraceInfo) XXX_DiscardUnknown Uses

func (m *TraceInfo) XXX_DiscardUnknown()

func (*TraceInfo) XXX_Marshal Uses

func (m *TraceInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TraceInfo) XXX_Merge Uses

func (m *TraceInfo) XXX_Merge(src proto.Message)

func (*TraceInfo) XXX_Size Uses

func (m *TraceInfo) XXX_Size() int

func (*TraceInfo) XXX_Unmarshal Uses

func (m *TraceInfo) XXX_Unmarshal(b []byte) error

type TraceInfo_CreatePipelineTraceOpts Uses

type TraceInfo_CreatePipelineTraceOpts struct {
    // pipeline is the name of the pipeline that the 'pachctl create-pipeline'
    // request responsible for this trace created
    Pipeline             string   `protobuf:"bytes,1,opt,name=pipeline,proto3" json:"pipeline,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

CreatePipelineTraceOpts contains the options needed to crate a CreatePipeline Super Trace.

func (*TraceInfo_CreatePipelineTraceOpts) Descriptor Uses

func (*TraceInfo_CreatePipelineTraceOpts) Descriptor() ([]byte, []int)

func (*TraceInfo_CreatePipelineTraceOpts) GetPipeline Uses

func (m *TraceInfo_CreatePipelineTraceOpts) GetPipeline() string

func (*TraceInfo_CreatePipelineTraceOpts) Marshal Uses

func (m *TraceInfo_CreatePipelineTraceOpts) Marshal() (dAtA []byte, err error)

func (*TraceInfo_CreatePipelineTraceOpts) MarshalTo Uses

func (m *TraceInfo_CreatePipelineTraceOpts) MarshalTo(dAtA []byte) (int, error)

func (*TraceInfo_CreatePipelineTraceOpts) ProtoMessage Uses

func (*TraceInfo_CreatePipelineTraceOpts) ProtoMessage()

func (*TraceInfo_CreatePipelineTraceOpts) Reset Uses

func (m *TraceInfo_CreatePipelineTraceOpts) Reset()

func (*TraceInfo_CreatePipelineTraceOpts) Size Uses

func (m *TraceInfo_CreatePipelineTraceOpts) Size() (n int)

func (*TraceInfo_CreatePipelineTraceOpts) String Uses

func (m *TraceInfo_CreatePipelineTraceOpts) String() string

func (*TraceInfo_CreatePipelineTraceOpts) Unmarshal Uses

func (m *TraceInfo_CreatePipelineTraceOpts) Unmarshal(dAtA []byte) error

func (*TraceInfo_CreatePipelineTraceOpts) XXX_DiscardUnknown Uses

func (m *TraceInfo_CreatePipelineTraceOpts) XXX_DiscardUnknown()

func (*TraceInfo_CreatePipelineTraceOpts) XXX_Marshal Uses

func (m *TraceInfo_CreatePipelineTraceOpts) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TraceInfo_CreatePipelineTraceOpts) XXX_Merge Uses

func (m *TraceInfo_CreatePipelineTraceOpts) XXX_Merge(src proto.Message)

func (*TraceInfo_CreatePipelineTraceOpts) XXX_Size Uses

func (m *TraceInfo_CreatePipelineTraceOpts) XXX_Size() int

func (*TraceInfo_CreatePipelineTraceOpts) XXX_Unmarshal Uses

func (m *TraceInfo_CreatePipelineTraceOpts) XXX_Unmarshal(b []byte) error

type TraceInfo_FinishCommitTraceOpts Uses

type TraceInfo_FinishCommitTraceOpts struct {
    // branch specifies the final output branch that the 'pachctl finish-commit'
    // trace should last until (if empty, pachctl will use the downstream branch
    // with the longest provenance)
    Branch               *pfs.Branch `protobuf:"bytes,1,opt,name=branch,proto3" json:"branch,omitempty"`
    XXX_NoUnkeyedLiteral struct{}    `json:"-"`
    XXX_unrecognized     []byte      `json:"-"`
    XXX_sizecache        int32       `json:"-"`
}

FinishCommitTraceOpts contains the options needed to crate a FinishCommit Super Trace.

func (*TraceInfo_FinishCommitTraceOpts) Descriptor Uses

func (*TraceInfo_FinishCommitTraceOpts) Descriptor() ([]byte, []int)

func (*TraceInfo_FinishCommitTraceOpts) GetBranch Uses

func (m *TraceInfo_FinishCommitTraceOpts) GetBranch() *pfs.Branch

func (*TraceInfo_FinishCommitTraceOpts) Marshal Uses

func (m *TraceInfo_FinishCommitTraceOpts) Marshal() (dAtA []byte, err error)

func (*TraceInfo_FinishCommitTraceOpts) MarshalTo Uses

func (m *TraceInfo_FinishCommitTraceOpts) MarshalTo(dAtA []byte) (int, error)

func (*TraceInfo_FinishCommitTraceOpts) ProtoMessage Uses

func (*TraceInfo_FinishCommitTraceOpts) ProtoMessage()

func (*TraceInfo_FinishCommitTraceOpts) Reset Uses

func (m *TraceInfo_FinishCommitTraceOpts) Reset()

func (*TraceInfo_FinishCommitTraceOpts) Size Uses

func (m *TraceInfo_FinishCommitTraceOpts) Size() (n int)

func (*TraceInfo_FinishCommitTraceOpts) String Uses

func (m *TraceInfo_FinishCommitTraceOpts) String() string

func (*TraceInfo_FinishCommitTraceOpts) Unmarshal Uses

func (m *TraceInfo_FinishCommitTraceOpts) Unmarshal(dAtA []byte) error

func (*TraceInfo_FinishCommitTraceOpts) XXX_DiscardUnknown Uses

func (m *TraceInfo_FinishCommitTraceOpts) XXX_DiscardUnknown()

func (*TraceInfo_FinishCommitTraceOpts) XXX_Marshal Uses

func (m *TraceInfo_FinishCommitTraceOpts) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TraceInfo_FinishCommitTraceOpts) XXX_Merge Uses

func (m *TraceInfo_FinishCommitTraceOpts) XXX_Merge(src proto.Message)

func (*TraceInfo_FinishCommitTraceOpts) XXX_Size Uses

func (m *TraceInfo_FinishCommitTraceOpts) XXX_Size() int

func (*TraceInfo_FinishCommitTraceOpts) XXX_Unmarshal Uses

func (m *TraceInfo_FinishCommitTraceOpts) XXX_Unmarshal(b []byte) error

Directories

PathSynopsis
extended

Package tracing imports 16 packages (graph) and is imported by 16 packages. Updated 2019-06-14. Refresh now. Tools for package owners.