v1

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 29, 2023 License: AGPL-3.0 Imports: 9 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_deepproto_proto_tracepoint_v1_tracepoint_proto protoreflect.FileDescriptor
View Source
var SnapshotService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "deepproto.proto.tracepoint.v1.SnapshotService",
	HandlerType: (*SnapshotServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "send",
			Handler:    _SnapshotService_Send_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "deepproto/proto/tracepoint/v1/tracepoint.proto",
}

SnapshotService_ServiceDesc is the grpc.ServiceDesc for SnapshotService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSnapshotServiceServer

func RegisterSnapshotServiceServer(s grpc.ServiceRegistrar, srv SnapshotServiceServer)

Types

type Snapshot

type Snapshot struct {
	ID         []byte               `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`                 // The client generated ID for this snapshot
	Tracepoint *TracePointConfig    `protobuf:"bytes,2,opt,name=tracepoint,proto3" json:"tracepoint,omitempty"` // The config that was used to generate this snapshot (it could be deleted by the time we look at the data)
	VarLookup  map[string]*Variable ``                                                                          // This is a flat list of all the collected variables for this snapshot, to reduce data size we dereference as much as we can
	/* 176-byte string literal not displayed */
	TsNanos       uint64         `protobuf:"fixed64,4,opt,name=ts_nanos,json=tsNanos,proto3" json:"ts_nanos,omitempty"`                  // The time in nanos since 1970 when this snapshot was generated
	Frames        []*StackFrame  `protobuf:"bytes,5,rep,name=frames,proto3" json:"frames,omitempty"`                                     // The active frames at the time the snapshot is generated
	Watches       []*WatchResult `protobuf:"bytes,6,rep,name=watches,proto3" json:"watches,omitempty"`                                   // The watches results
	Attributes    []*v1.KeyValue `protobuf:"bytes,7,rep,name=attributes,proto3" json:"attributes,omitempty"`                             // The attributes for this snapshot (e.g file_name or line_no)
	DurationNanos uint64         `protobuf:"varint,8,opt,name=duration_nanos,json=durationNanos,proto3" json:"duration_nanos,omitempty"` // The time in nano seconds it took to collect the data
	Resource      []*v1.KeyValue `protobuf:"bytes,9,rep,name=resource,proto3" json:"resource,omitempty"`                                 // The resource for this client, should match the resource sent with a PollRequest.
	// contains filtered or unexported fields
}

Snapshot is the result of a tracepoint being executed.

func (*Snapshot) Descriptor deprecated

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

Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.

func (*Snapshot) GetAttributes

func (x *Snapshot) GetAttributes() []*v1.KeyValue

func (*Snapshot) GetDurationNanos

func (x *Snapshot) GetDurationNanos() uint64

func (*Snapshot) GetFrames

func (x *Snapshot) GetFrames() []*StackFrame

func (*Snapshot) GetID

func (x *Snapshot) GetID() []byte

func (*Snapshot) GetResource

func (x *Snapshot) GetResource() []*v1.KeyValue

func (*Snapshot) GetTracepoint

func (x *Snapshot) GetTracepoint() *TracePointConfig

func (*Snapshot) GetTsNanos

func (x *Snapshot) GetTsNanos() uint64

func (*Snapshot) GetVarLookup

func (x *Snapshot) GetVarLookup() map[string]*Variable

func (*Snapshot) GetWatches

func (x *Snapshot) GetWatches() []*WatchResult

func (*Snapshot) ProtoMessage

func (*Snapshot) ProtoMessage()

func (*Snapshot) ProtoReflect

func (x *Snapshot) ProtoReflect() protoreflect.Message

func (*Snapshot) Reset

func (x *Snapshot) Reset()

func (*Snapshot) String

func (x *Snapshot) String() string

type SnapshotResponse

type SnapshotResponse struct {
	// contains filtered or unexported fields
}

SnapshotResponse this is the response from the server, when it receives a Snapshot

func (*SnapshotResponse) Descriptor deprecated

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

Deprecated: Use SnapshotResponse.ProtoReflect.Descriptor instead.

func (*SnapshotResponse) ProtoMessage

func (*SnapshotResponse) ProtoMessage()

func (*SnapshotResponse) ProtoReflect

func (x *SnapshotResponse) ProtoReflect() protoreflect.Message

func (*SnapshotResponse) Reset

func (x *SnapshotResponse) Reset()

func (*SnapshotResponse) String

func (x *SnapshotResponse) String() string

type SnapshotServiceClient

type SnapshotServiceClient interface {
	Send(ctx context.Context, in *Snapshot, opts ...grpc.CallOption) (*SnapshotResponse, error)
}

SnapshotServiceClient is the client API for SnapshotService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type SnapshotServiceServer

type SnapshotServiceServer interface {
	Send(context.Context, *Snapshot) (*SnapshotResponse, error)
	// contains filtered or unexported methods
}

SnapshotServiceServer is the server API for SnapshotService service. All implementations must embed UnimplementedSnapshotServiceServer for forward compatibility

type StackFrame

type StackFrame struct {
	FileName             string  `protobuf:"bytes,1,opt,name=file_name,json=fileName,proto3" json:"file_name,omitempty"`                                       // This is the full path of the file where the line of code is paused.
	MethodName           string  `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`                                 // This is the method or function name that is being called.
	LineNumber           uint32  `protobuf:"varint,3,opt,name=line_number,json=lineNumber,proto3" json:"line_number,omitempty"`                                // This is the line number where the program is paused.
	ClassName            *string `protobuf:"bytes,4,opt,name=class_name,json=className,proto3,oneof" json:"class_name,omitempty"`                              // The class name of where the method is defined
	IsAsync              *bool   `protobuf:"varint,5,opt,name=is_async,json=isAsync,proto3,oneof" json:"is_async,omitempty"`                                   // This indicates that the frame is an async frame
	ColumnNumber         *uint32 `protobuf:"varint,6,opt,name=column_number,json=columnNumber,proto3,oneof" json:"column_number,omitempty"`                    // This is the column number for the line, primarily used in node.
	TranspiledFileName   *string `protobuf:"bytes,7,opt,name=transpiled_file_name,json=transpiledFileName,proto3,oneof" json:"transpiled_file_name,omitempty"` // The name of the transpiled file. If we have mappings available we can map the file 'something.js' to the original typescript. This will be the transpiled file name e.g. something.js
	TranspiledLineNumber *uint32 ``                                                                                                                            // The transpiled line number
	/* 130-byte string literal not displayed */
	TranspiledColumnNumber *uint32 `` // The transpiled column number
	/* 136-byte string literal not displayed */
	Variables   []*VariableID `protobuf:"bytes,10,rep,name=variables,proto3" json:"variables,omitempty"`                               // This is the list of variables (using var ids) that are present at this point in the code.
	AppFrame    *bool         `protobuf:"varint,11,opt,name=app_frame,json=appFrame,proto3,oneof" json:"app_frame,omitempty"`          // This indicates if the frame is from inside the app, or is from a library
	NativeFrame *bool         `protobuf:"varint,12,opt,name=native_frame,json=nativeFrame,proto3,oneof" json:"native_frame,omitempty"` // This indicates if the frame, from a native library (primarily used in Java)
	// contains filtered or unexported fields
}

StackFrame is the description of a executing code frame that has been captured by the tracepoint.

func (*StackFrame) Descriptor deprecated

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

Deprecated: Use StackFrame.ProtoReflect.Descriptor instead.

func (*StackFrame) GetAppFrame

func (x *StackFrame) GetAppFrame() bool

func (*StackFrame) GetClassName

func (x *StackFrame) GetClassName() string

func (*StackFrame) GetColumnNumber

func (x *StackFrame) GetColumnNumber() uint32

func (*StackFrame) GetFileName

func (x *StackFrame) GetFileName() string

func (*StackFrame) GetIsAsync

func (x *StackFrame) GetIsAsync() bool

func (*StackFrame) GetLineNumber

func (x *StackFrame) GetLineNumber() uint32

func (*StackFrame) GetMethodName

func (x *StackFrame) GetMethodName() string

func (*StackFrame) GetNativeFrame

func (x *StackFrame) GetNativeFrame() bool

func (*StackFrame) GetTranspiledColumnNumber

func (x *StackFrame) GetTranspiledColumnNumber() uint32

func (*StackFrame) GetTranspiledFileName

func (x *StackFrame) GetTranspiledFileName() string

func (*StackFrame) GetTranspiledLineNumber

func (x *StackFrame) GetTranspiledLineNumber() uint32

func (*StackFrame) GetVariables

func (x *StackFrame) GetVariables() []*VariableID

func (*StackFrame) ProtoMessage

func (*StackFrame) ProtoMessage()

func (*StackFrame) ProtoReflect

func (x *StackFrame) ProtoReflect() protoreflect.Message

func (*StackFrame) Reset

func (x *StackFrame) Reset()

func (*StackFrame) String

func (x *StackFrame) String() string

type TracePointConfig

type TracePointConfig struct {
	ID         string            `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`                                    // The ID of the config
	Path       string            `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`                                // The path for the file to install in
	LineNumber uint32            `protobuf:"varint,3,opt,name=line_number,json=lineNumber,proto3" json:"line_number,omitempty"` // The line number to install on
	Args       map[string]string ``                                                                                             // Arbitrary key/kay of config values (this can contain conditions, logs, fire counts etc)
	/* 149-byte string literal not displayed */
	Watches   []string       `protobuf:"bytes,5,rep,name=watches,proto3" json:"watches,omitempty"`     // Expressions to evaluate at the this point of the code
	Targeting []*v1.KeyValue `protobuf:"bytes,6,rep,name=targeting,proto3" json:"targeting,omitempty"` // The targeting config for this tracepoint, used by the server to filter response.
	// contains filtered or unexported fields
}

This is the config of a tracepoint that should be installed by the application agent.

func (*TracePointConfig) Descriptor deprecated

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

Deprecated: Use TracePointConfig.ProtoReflect.Descriptor instead.

func (*TracePointConfig) GetArgs

func (x *TracePointConfig) GetArgs() map[string]string

func (*TracePointConfig) GetID

func (x *TracePointConfig) GetID() string

func (*TracePointConfig) GetLineNumber

func (x *TracePointConfig) GetLineNumber() uint32

func (*TracePointConfig) GetPath

func (x *TracePointConfig) GetPath() string

func (*TracePointConfig) GetTargeting

func (x *TracePointConfig) GetTargeting() []*v1.KeyValue

func (*TracePointConfig) GetWatches

func (x *TracePointConfig) GetWatches() []string

func (*TracePointConfig) ProtoMessage

func (*TracePointConfig) ProtoMessage()

func (*TracePointConfig) ProtoReflect

func (x *TracePointConfig) ProtoReflect() protoreflect.Message

func (*TracePointConfig) Reset

func (x *TracePointConfig) Reset()

func (*TracePointConfig) String

func (x *TracePointConfig) String() string

type UnimplementedSnapshotServiceServer

type UnimplementedSnapshotServiceServer struct {
}

UnimplementedSnapshotServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedSnapshotServiceServer) Send

type UnsafeSnapshotServiceServer

type UnsafeSnapshotServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSnapshotServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SnapshotServiceServer will result in compilation errors.

type Variable

type Variable struct {
	Type      string        `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`                  // The type/class of the variable (e.g string)
	Value     string        `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`                // The value of the variable as a string. All values are converted to string for simplicity. This can also result in the value being truncated if it is a very large string. Collection types should not be to stringed, instead a summary should be given as the value 'HashSet of size: 10'.
	Hash      string        `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash,omitempty"`                  // This should be the object identity, and not the hashcode of the object. Use object hashcode if other info is not available.
	Children  []*VariableID `protobuf:"bytes,4,rep,name=children,proto3" json:"children,omitempty"`          // This is a list of the any variables that this variable references. To reduce duplication we use var_lookup to store and process variables by reference.
	Truncated *bool         `protobuf:"varint,5,opt,name=truncated,proto3,oneof" json:"truncated,omitempty"` // True if the value has been truncated
	// contains filtered or unexported fields
}

Variable is the description of am actual value, that is referenced by a VariableID

func (*Variable) Descriptor deprecated

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

Deprecated: Use Variable.ProtoReflect.Descriptor instead.

func (*Variable) GetChildren

func (x *Variable) GetChildren() []*VariableID

func (*Variable) GetHash

func (x *Variable) GetHash() string

func (*Variable) GetTruncated

func (x *Variable) GetTruncated() bool

func (*Variable) GetType

func (x *Variable) GetType() string

func (*Variable) GetValue

func (x *Variable) GetValue() string

func (*Variable) ProtoMessage

func (*Variable) ProtoMessage()

func (*Variable) ProtoReflect

func (x *Variable) ProtoReflect() protoreflect.Message

func (*Variable) Reset

func (x *Variable) Reset()

func (*Variable) String

func (x *Variable) String() string

type VariableID

type VariableID struct {
	ID           string   `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`                                               // The ID to use to look up in the snapshot 'var_lookup'
	Name         string   `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`                                           // The name of the variable at the point this ID is referenced.
	Modifiers    []string `protobuf:"bytes,3,rep,name=modifiers,proto3" json:"modifiers,omitempty"`                                 // The modifiers (private, static etc) at the point this ID is referenced
	OriginalName *string  `protobuf:"bytes,4,opt,name=original_name,json=originalName,proto3,oneof" json:"original_name,omitempty"` // The unmodified name from the engine, some times a variable is renamed by the compiler, e.g. in python a field called '__someVar' is renamed for runtime to 'Class__someVar'.
	// contains filtered or unexported fields
}

VariableID is used to identify a variable on a stack frame or as a child of another variable.

func (*VariableID) Descriptor deprecated

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

Deprecated: Use VariableID.ProtoReflect.Descriptor instead.

func (*VariableID) GetID

func (x *VariableID) GetID() string

func (*VariableID) GetModifiers

func (x *VariableID) GetModifiers() []string

func (*VariableID) GetName

func (x *VariableID) GetName() string

func (*VariableID) GetOriginalName

func (x *VariableID) GetOriginalName() string

func (*VariableID) ProtoMessage

func (*VariableID) ProtoMessage()

func (*VariableID) ProtoReflect

func (x *VariableID) ProtoReflect() protoreflect.Message

func (*VariableID) Reset

func (x *VariableID) Reset()

func (*VariableID) String

func (x *VariableID) String() string

type WatchResult

type WatchResult struct {
	Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"` // the expression executed to collect the data
	// Types that are assignable to Result:
	//	*WatchResult_GoodResult
	//	*WatchResult_ErrorResult
	Result isWatchResult_Result `protobuf_oneof:"result"`
	// contains filtered or unexported fields
}

WatchResult is the result of a watch expression being executed.

func (*WatchResult) Descriptor deprecated

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

Deprecated: Use WatchResult.ProtoReflect.Descriptor instead.

func (*WatchResult) GetErrorResult

func (x *WatchResult) GetErrorResult() string

func (*WatchResult) GetExpression

func (x *WatchResult) GetExpression() string

func (*WatchResult) GetGoodResult

func (x *WatchResult) GetGoodResult() *VariableID

func (*WatchResult) GetResult

func (m *WatchResult) GetResult() isWatchResult_Result

func (*WatchResult) ProtoMessage

func (*WatchResult) ProtoMessage()

func (*WatchResult) ProtoReflect

func (x *WatchResult) ProtoReflect() protoreflect.Message

func (*WatchResult) Reset

func (x *WatchResult) Reset()

func (*WatchResult) String

func (x *WatchResult) String() string

type WatchResult_ErrorResult

type WatchResult_ErrorResult struct {
	ErrorResult string `protobuf:"bytes,3,opt,name=error_result,json=errorResult,proto3,oneof"` // This is to contain the error message generated if the watch expression fails.
}

type WatchResult_GoodResult

type WatchResult_GoodResult struct {
	GoodResult *VariableID `protobuf:"bytes,2,opt,name=good_result,json=goodResult,proto3,oneof"` // The VariableID of the variable that represents the result, if the expression completed successfully.
}

Jump to

Keyboard shortcuts

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