debug

package
v2.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 18, 2020 License: Apache-2.0 Imports: 10 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var SpanType_name = map[int32]string{
	0: "INBOUND",
	1: "OUTBOUND",
}
View Source 
var SpanType_value = map[string]int32{
	"INBOUND":  0,
	"OUTBOUND": 1,
}

Functions

func NewDebugEndpoints added in v2.5.0 

func NewDebugEndpoints() []*api.Endpoint

func RegisterDebugHandler 

func RegisterDebugHandler(s server.Server, hdlr DebugHandler, opts ...server.HandlerOption) error

func RegisterDebugServer added in v2.4.0 

func RegisterDebugServer(s *grpc.Server, srv DebugServer)

Types

type DebugClient added in v2.4.0 

type DebugClient interface {
	Log(ctx context.Context, in *LogRequest, opts ...grpc.CallOption) (Debug_LogClient, error)
	Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
	Stats(ctx context.Context, in *StatsRequest, opts ...grpc.CallOption) (*StatsResponse, error)
	Trace(ctx context.Context, in *TraceRequest, opts ...grpc.CallOption) (*TraceResponse, error)
}

DebugClient is the client API for Debug service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDebugClient added in v2.4.0 

func NewDebugClient(cc *grpc.ClientConn) DebugClient

type DebugHandler 

type DebugHandler interface {
	Log(context.Context, *LogRequest, Debug_LogStream) error
	Health(context.Context, *HealthRequest, *HealthResponse) error
	Stats(context.Context, *StatsRequest, *StatsResponse) error
	Trace(context.Context, *TraceRequest, *TraceResponse) error
}

type DebugServer added in v2.4.0 

type DebugServer interface {
	Log(*LogRequest, Debug_LogServer) error
	Health(context.Context, *HealthRequest) (*HealthResponse, error)
	Stats(context.Context, *StatsRequest) (*StatsResponse, error)
	Trace(context.Context, *TraceRequest) (*TraceResponse, error)
}

DebugServer is the server API for Debug service.

type DebugService 

type DebugService interface {
	Log(ctx context.Context, in *LogRequest, opts ...client.CallOption) (Debug_LogService, error)
	Health(ctx context.Context, in *HealthRequest, opts ...client.CallOption) (*HealthResponse, error)
	Stats(ctx context.Context, in *StatsRequest, opts ...client.CallOption) (*StatsResponse, error)
	Trace(ctx context.Context, in *TraceRequest, opts ...client.CallOption) (*TraceResponse, error)
}

func NewDebugService 

func NewDebugService(name string, c client.Client) DebugService

type Debug_LogClient added in v2.4.0 

type Debug_LogClient interface {
	Recv() (*Record, error)
	grpc.ClientStream
}

type Debug_LogServer added in v2.4.0 

type Debug_LogServer interface {
	Send(*Record) error
	grpc.ServerStream
}

type Debug_LogService 

type Debug_LogService interface {
	Context() context.Context
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Recv() (*Record, error)
}

type Debug_LogStream 

type Debug_LogStream interface {
	Context() context.Context
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*Record) error
}

type HealthRequest 

type HealthRequest struct {
	// optional service name
	Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*HealthRequest) Descriptor 

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

func (*HealthRequest) GetService 

func (m *HealthRequest) GetService() string

func (*HealthRequest) ProtoMessage 

func (*HealthRequest) ProtoMessage()

func (*HealthRequest) Reset 

func (m *HealthRequest) Reset()

func (*HealthRequest) String 

func (m *HealthRequest) String() string

func (*HealthRequest) XXX_DiscardUnknown 

func (m *HealthRequest) XXX_DiscardUnknown()

func (*HealthRequest) XXX_Marshal 

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

func (*HealthRequest) XXX_Merge 

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

func (*HealthRequest) XXX_Size 

func (m *HealthRequest) XXX_Size() int

func (*HealthRequest) XXX_Unmarshal 

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

type HealthResponse 

type HealthResponse struct {
	// default: ok
	Status               string   `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*HealthResponse) Descriptor 

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

func (*HealthResponse) GetStatus 

func (m *HealthResponse) GetStatus() string

func (*HealthResponse) ProtoMessage 

func (*HealthResponse) ProtoMessage()

func (*HealthResponse) Reset 

func (m *HealthResponse) Reset()

func (*HealthResponse) String 

func (m *HealthResponse) String() string

func (*HealthResponse) XXX_DiscardUnknown 

func (m *HealthResponse) XXX_DiscardUnknown()

func (*HealthResponse) XXX_Marshal 

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

func (*HealthResponse) XXX_Merge 

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

func (*HealthResponse) XXX_Size 

func (m *HealthResponse) XXX_Size() int

func (*HealthResponse) XXX_Unmarshal 

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

type LogRequest 

type LogRequest struct {
	// service to request logs for
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// stream records continuously
	Stream bool `protobuf:"varint,2,opt,name=stream,proto3" json:"stream,omitempty"`
	// count of records to request
	Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
	// relative time in seconds
	// before the current time
	// from which to show logs
	Since                int64    `protobuf:"varint,4,opt,name=since,proto3" json:"since,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

LogRequest requests service logs

func (*LogRequest) Descriptor 

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

func (*LogRequest) GetCount 

func (m *LogRequest) GetCount() int64

func (*LogRequest) GetService 

func (m *LogRequest) GetService() string

func (*LogRequest) GetSince 

func (m *LogRequest) GetSince() int64

func (*LogRequest) GetStream 

func (m *LogRequest) GetStream() bool

func (*LogRequest) ProtoMessage 

func (*LogRequest) ProtoMessage()

func (*LogRequest) Reset 

func (m *LogRequest) Reset()

func (*LogRequest) String 

func (m *LogRequest) String() string

func (*LogRequest) XXX_DiscardUnknown 

func (m *LogRequest) XXX_DiscardUnknown()

func (*LogRequest) XXX_Marshal 

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

func (*LogRequest) XXX_Merge 

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

func (*LogRequest) XXX_Size 

func (m *LogRequest) XXX_Size() int

func (*LogRequest) XXX_Unmarshal 

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

type Record 

type Record struct {
	// timestamp of log record
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// record metadata
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// message
	Message              string   `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Record is service log record

func (*Record) Descriptor 

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

func (*Record) GetMessage 

func (m *Record) GetMessage() string

func (*Record) GetMetadata 

func (m *Record) GetMetadata() map[string]string

func (*Record) GetTimestamp 

func (m *Record) GetTimestamp() int64

func (*Record) ProtoMessage 

func (*Record) ProtoMessage()

func (*Record) Reset 

func (m *Record) Reset()

func (*Record) String 

func (m *Record) String() string

func (*Record) XXX_DiscardUnknown 

func (m *Record) XXX_DiscardUnknown()

func (*Record) XXX_Marshal 

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

func (*Record) XXX_Merge 

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

func (*Record) XXX_Size 

func (m *Record) XXX_Size() int

func (*Record) XXX_Unmarshal 

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

type Span 

type Span struct {
	// the trace id
	Trace string `protobuf:"bytes,1,opt,name=trace,proto3" json:"trace,omitempty"`
	// id of the span
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// parent span
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// name of the resource
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// time of start in nanoseconds
	Started uint64 `protobuf:"varint,5,opt,name=started,proto3" json:"started,omitempty"`
	// duration of the execution in nanoseconds
	Duration uint64 `protobuf:"varint,6,opt,name=duration,proto3" json:"duration,omitempty"`
	// associated metadata
	Metadata             map[string]string `` /* 157-byte string literal not displayed */
	Type                 SpanType          `protobuf:"varint,8,opt,name=type,proto3,enum=SpanType" json:"type,omitempty"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

func (*Span) Descriptor 

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

func (*Span) GetDuration 

func (m *Span) GetDuration() uint64

func (*Span) GetId 

func (m *Span) GetId() string

func (*Span) GetMetadata 

func (m *Span) GetMetadata() map[string]string

func (*Span) GetName 

func (m *Span) GetName() string

func (*Span) GetParent 

func (m *Span) GetParent() string

func (*Span) GetStarted 

func (m *Span) GetStarted() uint64

func (*Span) GetTrace 

func (m *Span) GetTrace() string

func (*Span) GetType added in v2.1.0 

func (m *Span) GetType() SpanType

func (*Span) ProtoMessage 

func (*Span) ProtoMessage()

func (*Span) Reset 

func (m *Span) Reset()

func (*Span) String 

func (m *Span) String() string

func (*Span) XXX_DiscardUnknown 

func (m *Span) XXX_DiscardUnknown()

func (*Span) XXX_Marshal 

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

func (*Span) XXX_Merge 

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

func (*Span) XXX_Size 

func (m *Span) XXX_Size() int

func (*Span) XXX_Unmarshal 

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

type SpanType added in v2.1.0 

type SpanType int32
const (
	SpanType_INBOUND  SpanType = 0
	SpanType_OUTBOUND SpanType = 1
)

func (SpanType) EnumDescriptor added in v2.1.0 

func (SpanType) EnumDescriptor() ([]byte, []int)

func (SpanType) String added in v2.1.0 

func (x SpanType) String() string

type StatsRequest 

type StatsRequest struct {
	// optional service name
	Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*StatsRequest) Descriptor 

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

func (*StatsRequest) GetService 

func (m *StatsRequest) GetService() string

func (*StatsRequest) ProtoMessage 

func (*StatsRequest) ProtoMessage()

func (*StatsRequest) Reset 

func (m *StatsRequest) Reset()

func (*StatsRequest) String 

func (m *StatsRequest) String() string

func (*StatsRequest) XXX_DiscardUnknown 

func (m *StatsRequest) XXX_DiscardUnknown()

func (*StatsRequest) XXX_Marshal 

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

func (*StatsRequest) XXX_Merge 

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

func (*StatsRequest) XXX_Size 

func (m *StatsRequest) XXX_Size() int

func (*StatsRequest) XXX_Unmarshal 

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

type StatsResponse 

type StatsResponse struct {
	// timestamp of recording
	Timestamp uint64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// unix timestamp
	Started uint64 `protobuf:"varint,2,opt,name=started,proto3" json:"started,omitempty"`
	// in seconds
	Uptime uint64 `protobuf:"varint,3,opt,name=uptime,proto3" json:"uptime,omitempty"`
	// in bytes
	Memory uint64 `protobuf:"varint,4,opt,name=memory,proto3" json:"memory,omitempty"`
	// num threads
	Threads uint64 `protobuf:"varint,5,opt,name=threads,proto3" json:"threads,omitempty"`
	// total gc in nanoseconds
	Gc uint64 `protobuf:"varint,6,opt,name=gc,proto3" json:"gc,omitempty"`
	// total number of requests
	Requests uint64 `protobuf:"varint,7,opt,name=requests,proto3" json:"requests,omitempty"`
	// total number of errors
	Errors               uint64   `protobuf:"varint,8,opt,name=errors,proto3" json:"errors,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*StatsResponse) Descriptor 

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

func (*StatsResponse) GetErrors 

func (m *StatsResponse) GetErrors() uint64

func (*StatsResponse) GetGc 

func (m *StatsResponse) GetGc() uint64

func (*StatsResponse) GetMemory 

func (m *StatsResponse) GetMemory() uint64

func (*StatsResponse) GetRequests 

func (m *StatsResponse) GetRequests() uint64

func (*StatsResponse) GetStarted 

func (m *StatsResponse) GetStarted() uint64

func (*StatsResponse) GetThreads 

func (m *StatsResponse) GetThreads() uint64

func (*StatsResponse) GetTimestamp 

func (m *StatsResponse) GetTimestamp() uint64

func (*StatsResponse) GetUptime 

func (m *StatsResponse) GetUptime() uint64

func (*StatsResponse) ProtoMessage 

func (*StatsResponse) ProtoMessage()

func (*StatsResponse) Reset 

func (m *StatsResponse) Reset()

func (*StatsResponse) String 

func (m *StatsResponse) String() string

func (*StatsResponse) XXX_DiscardUnknown 

func (m *StatsResponse) XXX_DiscardUnknown()

func (*StatsResponse) XXX_Marshal 

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

func (*StatsResponse) XXX_Merge 

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

func (*StatsResponse) XXX_Size 

func (m *StatsResponse) XXX_Size() int

func (*StatsResponse) XXX_Unmarshal 

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

type TraceRequest 

type TraceRequest struct {
	// trace id to retrieve
	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*TraceRequest) Descriptor 

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

func (*TraceRequest) GetId 

func (m *TraceRequest) GetId() string

func (*TraceRequest) ProtoMessage 

func (*TraceRequest) ProtoMessage()

func (*TraceRequest) Reset 

func (m *TraceRequest) Reset()

func (*TraceRequest) String 

func (m *TraceRequest) String() string

func (*TraceRequest) XXX_DiscardUnknown 

func (m *TraceRequest) XXX_DiscardUnknown()

func (*TraceRequest) XXX_Marshal 

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

func (*TraceRequest) XXX_Merge 

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

func (*TraceRequest) XXX_Size 

func (m *TraceRequest) XXX_Size() int

func (*TraceRequest) XXX_Unmarshal 

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

type TraceResponse 

type TraceResponse struct {
	Spans                []*Span  `protobuf:"bytes,1,rep,name=spans,proto3" json:"spans,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*TraceResponse) Descriptor 

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

func (*TraceResponse) GetSpans 

func (m *TraceResponse) GetSpans() []*Span

func (*TraceResponse) ProtoMessage 

func (*TraceResponse) ProtoMessage()

func (*TraceResponse) Reset 

func (m *TraceResponse) Reset()

func (*TraceResponse) String 

func (m *TraceResponse) String() string

func (*TraceResponse) XXX_DiscardUnknown 

func (m *TraceResponse) XXX_DiscardUnknown()

func (*TraceResponse) XXX_Marshal 

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

func (*TraceResponse) XXX_Merge 

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

func (*TraceResponse) XXX_Size 

func (m *TraceResponse) XXX_Size() int

func (*TraceResponse) XXX_Unmarshal 

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

type UnimplementedDebugServer added in v2.4.0 

type UnimplementedDebugServer struct {
}

UnimplementedDebugServer can be embedded to have forward compatible implementations.

func (*UnimplementedDebugServer) Health added in v2.4.0 

func (*UnimplementedDebugServer) Health(ctx context.Context, req *HealthRequest) (*HealthResponse, error)

func (*UnimplementedDebugServer) Log added in v2.4.0 

func (*UnimplementedDebugServer) Log(req *LogRequest, srv Debug_LogServer) error

func (*UnimplementedDebugServer) Stats added in v2.4.0 

func (*UnimplementedDebugServer) Stats(ctx context.Context, req *StatsRequest) (*StatsResponse, error)

func (*UnimplementedDebugServer) Trace added in v2.4.0 

func (*UnimplementedDebugServer) Trace(ctx context.Context, req *TraceRequest) (*TraceResponse, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.