protobuf

package
v2.14.1 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2023 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ProfileAnalysis_NewSession_FullMethodName         = "/tensorflow.ProfileAnalysis/NewSession"
	ProfileAnalysis_EnumSessions_FullMethodName       = "/tensorflow.ProfileAnalysis/EnumSessions"
	ProfileAnalysis_GetSessionToolData_FullMethodName = "/tensorflow.ProfileAnalysis/GetSessionToolData"
)
View Source 
const (
	ProfilerService_Profile_FullMethodName   = "/tensorflow.ProfilerService/Profile"
	ProfilerService_Terminate_FullMethodName = "/tensorflow.ProfilerService/Terminate"
	ProfilerService_Monitor_FullMethodName   = "/tensorflow.ProfilerService/Monitor"
)

Variables

View Source 
var (
	ProfileOptions_DeviceType_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "CPU",
		2: "GPU",
		3: "TPU",
		4: "PLUGGABLE_DEVICE",
	}
	ProfileOptions_DeviceType_value = map[string]int32{
		"UNSPECIFIED":      0,
		"CPU":              1,
		"GPU":              2,
		"TPU":              3,
		"PLUGGABLE_DEVICE": 4,
	}
)

Enum value maps for ProfileOptions_DeviceType.

View Source 
var (
	ProfilerServiceMonitorResult_ResponseType_name = map[int32]string{
		0: "EMPTY_RESULT",
		1: "UTIL_ONLY",
		2: "UTIL_IDLE",
		3: "UTIL_IDLE_STEP",
	}
	ProfilerServiceMonitorResult_ResponseType_value = map[string]int32{
		"EMPTY_RESULT":   0,
		"UTIL_ONLY":      1,
		"UTIL_IDLE":      2,
		"UTIL_IDLE_STEP": 3,
	}
)

Enum value maps for ProfilerServiceMonitorResult_ResponseType.

View Source 
var File_tensorflow_tsl_profiler_protobuf_profile_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_profiled_instructions_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_profiler_analysis_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_profiler_options_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_profiler_service_monitor_result_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_profiler_service_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_trace_events_proto protoreflect.FileDescriptor
View Source 
var File_tensorflow_tsl_profiler_protobuf_xplane_proto protoreflect.FileDescriptor
View Source 
var ProfileAnalysis_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tensorflow.ProfileAnalysis",
	HandlerType: (*ProfileAnalysisServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "NewSession",
			Handler:    _ProfileAnalysis_NewSession_Handler,
		},
		{
			MethodName: "EnumSessions",
			Handler:    _ProfileAnalysis_EnumSessions_Handler,
		},
		{
			MethodName: "GetSessionToolData",
			Handler:    _ProfileAnalysis_GetSessionToolData_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "tensorflow/tsl/profiler/protobuf/profiler_analysis.proto",
}

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

View Source 
var ProfilerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "tensorflow.ProfilerService",
	HandlerType: (*ProfilerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Profile",
			Handler:    _ProfilerService_Profile_Handler,
		},
		{
			MethodName: "Terminate",
			Handler:    _ProfilerService_Terminate_Handler,
		},
		{
			MethodName: "Monitor",
			Handler:    _ProfilerService_Monitor_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "tensorflow/tsl/profiler/protobuf/profiler_service.proto",
}

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

Functions

func RegisterProfileAnalysisServer 

func RegisterProfileAnalysisServer(s grpc.ServiceRegistrar, srv ProfileAnalysisServer)

func RegisterProfilerServiceServer 

func RegisterProfilerServiceServer(s grpc.ServiceRegistrar, srv ProfilerServiceServer)

Types

type Device 

type Device struct {

	// The name of the device.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The id of this device, unique in a single trace.
	DeviceId uint32 `protobuf:"varint,2,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// The resources on this device, keyed by resource_id;
	Resources map[uint32]*Resource `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

A 'device' is a physical entity in the system and is comprised of several resources.

func (*Device) Descriptor deprecated 

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetDeviceId 

func (x *Device) GetDeviceId() uint32

func (*Device) GetName 

func (x *Device) GetName() string

func (*Device) GetResources 

func (x *Device) GetResources() map[uint32]*Resource

func (*Device) ProtoMessage 

func (*Device) ProtoMessage()

func (*Device) ProtoReflect 

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

func (*Device) Reset 

func (x *Device) Reset()

func (*Device) String 

func (x *Device) String() string

type EnumProfileSessionsAndToolsRequest 

type EnumProfileSessionsAndToolsRequest struct {
	RepositoryRoot string `protobuf:"bytes,1,opt,name=repository_root,json=repositoryRoot,proto3" json:"repository_root,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumProfileSessionsAndToolsRequest) Descriptor deprecated 

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

Deprecated: Use EnumProfileSessionsAndToolsRequest.ProtoReflect.Descriptor instead.

func (*EnumProfileSessionsAndToolsRequest) GetRepositoryRoot 

func (x *EnumProfileSessionsAndToolsRequest) GetRepositoryRoot() string

func (*EnumProfileSessionsAndToolsRequest) ProtoMessage 

func (*EnumProfileSessionsAndToolsRequest) ProtoMessage()

func (*EnumProfileSessionsAndToolsRequest) ProtoReflect 

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

func (*EnumProfileSessionsAndToolsRequest) Reset 

func (x *EnumProfileSessionsAndToolsRequest) Reset()

func (*EnumProfileSessionsAndToolsRequest) String 

func (x *EnumProfileSessionsAndToolsRequest) String() string

type EnumProfileSessionsAndToolsResponse 

type EnumProfileSessionsAndToolsResponse struct {

	// Auxiliary error_message.
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// If success, the returned sessions information are stored here.
	Sessions []*ProfileSessionInfo `protobuf:"bytes,2,rep,name=sessions,proto3" json:"sessions,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumProfileSessionsAndToolsResponse) Descriptor deprecated 

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

Deprecated: Use EnumProfileSessionsAndToolsResponse.ProtoReflect.Descriptor instead.

func (*EnumProfileSessionsAndToolsResponse) GetErrorMessage 

func (x *EnumProfileSessionsAndToolsResponse) GetErrorMessage() string

func (*EnumProfileSessionsAndToolsResponse) GetSessions 

func (x *EnumProfileSessionsAndToolsResponse) GetSessions() []*ProfileSessionInfo

func (*EnumProfileSessionsAndToolsResponse) ProtoMessage 

func (*EnumProfileSessionsAndToolsResponse) ProtoMessage()

func (*EnumProfileSessionsAndToolsResponse) ProtoReflect 

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

func (*EnumProfileSessionsAndToolsResponse) Reset 

func (x *EnumProfileSessionsAndToolsResponse) Reset()

func (*EnumProfileSessionsAndToolsResponse) String 

func (x *EnumProfileSessionsAndToolsResponse) String() string

type Function 

type Function struct {
	Id         uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Name       int64  `protobuf:"varint,2,opt,name=name,proto3" json:"name,omitempty"`
	SystemName int64  `protobuf:"varint,3,opt,name=system_name,json=systemName,proto3" json:"system_name,omitempty"`
	Filename   int64  `protobuf:"varint,4,opt,name=filename,proto3" json:"filename,omitempty"`
	StartLine  int64  `protobuf:"varint,5,opt,name=start_line,json=startLine,proto3" json:"start_line,omitempty"`
	// contains filtered or unexported fields
}

func (*Function) Descriptor deprecated 

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

Deprecated: Use Function.ProtoReflect.Descriptor instead.

func (*Function) GetFilename 

func (x *Function) GetFilename() int64

func (*Function) GetId 

func (x *Function) GetId() uint64

func (*Function) GetName 

func (x *Function) GetName() int64

func (*Function) GetStartLine 

func (x *Function) GetStartLine() int64

func (*Function) GetSystemName 

func (x *Function) GetSystemName() int64

func (*Function) ProtoMessage 

func (*Function) ProtoMessage()

func (*Function) ProtoReflect 

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

func (*Function) Reset 

func (x *Function) Reset()

func (*Function) String 

func (x *Function) String() string

type Label 

type Label struct {
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	Str int64 `protobuf:"varint,2,opt,name=str,proto3" json:"str,omitempty"`
	Num int64 `protobuf:"varint,3,opt,name=num,proto3" json:"num,omitempty"`
	// contains filtered or unexported fields
}

func (*Label) Descriptor deprecated 

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

Deprecated: Use Label.ProtoReflect.Descriptor instead.

func (*Label) GetKey 

func (x *Label) GetKey() int64

func (*Label) GetNum 

func (x *Label) GetNum() int64

func (*Label) GetStr 

func (x *Label) GetStr() int64

func (*Label) ProtoMessage 

func (*Label) ProtoMessage()

func (*Label) ProtoReflect 

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

func (*Label) Reset 

func (x *Label) Reset()

func (*Label) String 

func (x *Label) String() string

type Line 

type Line struct {
	FunctionId uint64 `protobuf:"varint,1,opt,name=function_id,json=functionId,proto3" json:"function_id,omitempty"`
	Line       int64  `protobuf:"varint,2,opt,name=line,proto3" json:"line,omitempty"`
	// contains filtered or unexported fields
}

func (*Line) Descriptor deprecated 

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

Deprecated: Use Line.ProtoReflect.Descriptor instead.

func (*Line) GetFunctionId 

func (x *Line) GetFunctionId() uint64

func (*Line) GetLine 

func (x *Line) GetLine() int64

func (*Line) ProtoMessage 

func (*Line) ProtoMessage()

func (*Line) ProtoReflect 

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

func (*Line) Reset 

func (x *Line) Reset()

func (*Line) String 

func (x *Line) String() string

type Location 

type Location struct {
	Id        uint64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	MappingId uint64  `protobuf:"varint,2,opt,name=mapping_id,json=mappingId,proto3" json:"mapping_id,omitempty"`
	Address   uint64  `protobuf:"varint,3,opt,name=address,proto3" json:"address,omitempty"`
	Line      []*Line `protobuf:"bytes,4,rep,name=line,proto3" json:"line,omitempty"`
	// contains filtered or unexported fields
}

func (*Location) Descriptor deprecated 

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

Deprecated: Use Location.ProtoReflect.Descriptor instead.

func (*Location) GetAddress 

func (x *Location) GetAddress() uint64

func (*Location) GetId 

func (x *Location) GetId() uint64

func (*Location) GetLine 

func (x *Location) GetLine() []*Line

func (*Location) GetMappingId 

func (x *Location) GetMappingId() uint64

func (*Location) ProtoMessage 

func (*Location) ProtoMessage()

func (*Location) ProtoReflect 

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

func (*Location) Reset 

func (x *Location) Reset()

func (*Location) String 

func (x *Location) String() string

type Mapping 

type Mapping struct {
	Id              uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	MemoryStart     uint64 `protobuf:"varint,2,opt,name=memory_start,json=memoryStart,proto3" json:"memory_start,omitempty"`
	MemoryLimit     uint64 `protobuf:"varint,3,opt,name=memory_limit,json=memoryLimit,proto3" json:"memory_limit,omitempty"`
	FileOffset      uint64 `protobuf:"varint,4,opt,name=file_offset,json=fileOffset,proto3" json:"file_offset,omitempty"`
	Filename        int64  `protobuf:"varint,5,opt,name=filename,proto3" json:"filename,omitempty"`
	BuildId         int64  `protobuf:"varint,6,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	HasFunctions    bool   `protobuf:"varint,7,opt,name=has_functions,json=hasFunctions,proto3" json:"has_functions,omitempty"`
	HasFilenames    bool   `protobuf:"varint,8,opt,name=has_filenames,json=hasFilenames,proto3" json:"has_filenames,omitempty"`
	HasLineNumbers  bool   `protobuf:"varint,9,opt,name=has_line_numbers,json=hasLineNumbers,proto3" json:"has_line_numbers,omitempty"`
	HasInlineFrames bool   `protobuf:"varint,10,opt,name=has_inline_frames,json=hasInlineFrames,proto3" json:"has_inline_frames,omitempty"`
	// contains filtered or unexported fields
}

func (*Mapping) Descriptor deprecated 

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

Deprecated: Use Mapping.ProtoReflect.Descriptor instead.

func (*Mapping) GetBuildId 

func (x *Mapping) GetBuildId() int64

func (*Mapping) GetFileOffset 

func (x *Mapping) GetFileOffset() uint64

func (*Mapping) GetFilename 

func (x *Mapping) GetFilename() int64

func (*Mapping) GetHasFilenames 

func (x *Mapping) GetHasFilenames() bool

func (*Mapping) GetHasFunctions 

func (x *Mapping) GetHasFunctions() bool

func (*Mapping) GetHasInlineFrames 

func (x *Mapping) GetHasInlineFrames() bool

func (*Mapping) GetHasLineNumbers 

func (x *Mapping) GetHasLineNumbers() bool

func (*Mapping) GetId 

func (x *Mapping) GetId() uint64

func (*Mapping) GetMemoryLimit 

func (x *Mapping) GetMemoryLimit() uint64

func (*Mapping) GetMemoryStart 

func (x *Mapping) GetMemoryStart() uint64

func (*Mapping) ProtoMessage 

func (*Mapping) ProtoMessage()

func (*Mapping) ProtoReflect 

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

func (*Mapping) Reset 

func (x *Mapping) Reset()

func (*Mapping) String 

func (x *Mapping) String() string

type MonitorRequest 

type MonitorRequest struct {

	// Duration for which to profile between each update.
	DurationMs uint64 `protobuf:"varint,1,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// Indicates the level at which we want to monitor. Currently, two levels are
	// supported:
	// Level 1: An ultra lightweight mode that captures only some utilization
	// metrics.
	// Level 2: More verbose than level 1. Collects utilization metrics, device
	// information, step time information, etc. Do not use this option if the TPU
	// host is being very heavily used.
	MonitoringLevel int32 `protobuf:"varint,2,opt,name=monitoring_level,json=monitoringLevel,proto3" json:"monitoring_level,omitempty"`
	// True to display timestamp in monitoring result.
	Timestamp bool `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

Next-ID: 4

func (*MonitorRequest) Descriptor deprecated 

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

Deprecated: Use MonitorRequest.ProtoReflect.Descriptor instead.

func (*MonitorRequest) GetDurationMs 

func (x *MonitorRequest) GetDurationMs() uint64

func (*MonitorRequest) GetMonitoringLevel 

func (x *MonitorRequest) GetMonitoringLevel() int32

func (*MonitorRequest) GetTimestamp 

func (x *MonitorRequest) GetTimestamp() bool

func (*MonitorRequest) ProtoMessage 

func (*MonitorRequest) ProtoMessage()

func (*MonitorRequest) ProtoReflect 

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

func (*MonitorRequest) Reset 

func (x *MonitorRequest) Reset()

func (*MonitorRequest) String 

func (x *MonitorRequest) String() string

type MonitorResponse 

type MonitorResponse struct {

	// Properly formatted string data that can be directly returned back to user.
	Data string `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// A collection of monitoring results for each field show in data.
	MonitorResult *ProfilerServiceMonitorResult `protobuf:"bytes,10,opt,name=monitor_result,json=monitorResult,proto3" json:"monitor_result,omitempty"`
	// contains filtered or unexported fields
}

Next-ID: 11

func (*MonitorResponse) Descriptor deprecated 

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

Deprecated: Use MonitorResponse.ProtoReflect.Descriptor instead.

func (*MonitorResponse) GetData 

func (x *MonitorResponse) GetData() string

func (*MonitorResponse) GetMonitorResult 

func (x *MonitorResponse) GetMonitorResult() *ProfilerServiceMonitorResult

func (*MonitorResponse) ProtoMessage 

func (*MonitorResponse) ProtoMessage()

func (*MonitorResponse) ProtoReflect 

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

func (*MonitorResponse) Reset 

func (x *MonitorResponse) Reset()

func (*MonitorResponse) String 

func (x *MonitorResponse) String() string

type NewProfileSessionRequest 

type NewProfileSessionRequest struct {
	Request *ProfileRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// The place where we will dump profile data. We will normally use
	// MODEL_DIR/plugins/profile as the repository root.
	RepositoryRoot string   `protobuf:"bytes,2,opt,name=repository_root,json=repositoryRoot,proto3" json:"repository_root,omitempty"`
	Hosts          []string `protobuf:"bytes,3,rep,name=hosts,proto3" json:"hosts,omitempty"` // host or host:port, port will be ignored.
	SessionId      string   `protobuf:"bytes,4,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*NewProfileSessionRequest) Descriptor deprecated 

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

Deprecated: Use NewProfileSessionRequest.ProtoReflect.Descriptor instead.

func (*NewProfileSessionRequest) GetHosts 

func (x *NewProfileSessionRequest) GetHosts() []string

func (*NewProfileSessionRequest) GetRepositoryRoot 

func (x *NewProfileSessionRequest) GetRepositoryRoot() string

func (*NewProfileSessionRequest) GetRequest 

func (x *NewProfileSessionRequest) GetRequest() *ProfileRequest

func (*NewProfileSessionRequest) GetSessionId 

func (x *NewProfileSessionRequest) GetSessionId() string

func (*NewProfileSessionRequest) ProtoMessage 

func (*NewProfileSessionRequest) ProtoMessage()

func (*NewProfileSessionRequest) ProtoReflect 

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

func (*NewProfileSessionRequest) Reset 

func (x *NewProfileSessionRequest) Reset()

func (*NewProfileSessionRequest) String 

func (x *NewProfileSessionRequest) String() string

type NewProfileSessionResponse 

type NewProfileSessionResponse struct {

	// Auxiliary error_message.
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Whether all hosts had returned a empty trace.
	EmptyTrace bool `protobuf:"varint,2,opt,name=empty_trace,json=emptyTrace,proto3" json:"empty_trace,omitempty"`
	// contains filtered or unexported fields
}

func (*NewProfileSessionResponse) Descriptor deprecated 

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

Deprecated: Use NewProfileSessionResponse.ProtoReflect.Descriptor instead.

func (*NewProfileSessionResponse) GetEmptyTrace 

func (x *NewProfileSessionResponse) GetEmptyTrace() bool

func (*NewProfileSessionResponse) GetErrorMessage 

func (x *NewProfileSessionResponse) GetErrorMessage() string

func (*NewProfileSessionResponse) ProtoMessage 

func (*NewProfileSessionResponse) ProtoMessage()

func (*NewProfileSessionResponse) ProtoReflect 

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

func (*NewProfileSessionResponse) Reset 

func (x *NewProfileSessionResponse) Reset()

func (*NewProfileSessionResponse) String 

func (x *NewProfileSessionResponse) String() string

type Profile 

type Profile struct {
	SampleType        []*ValueType `protobuf:"bytes,1,rep,name=sample_type,json=sampleType,proto3" json:"sample_type,omitempty"`
	Sample            []*Sample    `protobuf:"bytes,2,rep,name=sample,proto3" json:"sample,omitempty"`
	Mapping           []*Mapping   `protobuf:"bytes,3,rep,name=mapping,proto3" json:"mapping,omitempty"`
	Location          []*Location  `protobuf:"bytes,4,rep,name=location,proto3" json:"location,omitempty"`
	Function          []*Function  `protobuf:"bytes,5,rep,name=function,proto3" json:"function,omitempty"`
	StringTable       []string     `protobuf:"bytes,6,rep,name=string_table,json=stringTable,proto3" json:"string_table,omitempty"`
	DropFrames        int64        `protobuf:"varint,7,opt,name=drop_frames,json=dropFrames,proto3" json:"drop_frames,omitempty"`
	KeepFrames        int64        `protobuf:"varint,8,opt,name=keep_frames,json=keepFrames,proto3" json:"keep_frames,omitempty"`
	TimeNanos         int64        `protobuf:"varint,9,opt,name=time_nanos,json=timeNanos,proto3" json:"time_nanos,omitempty"`
	DurationNanos     int64        `protobuf:"varint,10,opt,name=duration_nanos,json=durationNanos,proto3" json:"duration_nanos,omitempty"`
	PeriodType        *ValueType   `protobuf:"bytes,11,opt,name=period_type,json=periodType,proto3" json:"period_type,omitempty"`
	Period            int64        `protobuf:"varint,12,opt,name=period,proto3" json:"period,omitempty"`
	Comment           []int64      `protobuf:"varint,13,rep,packed,name=comment,proto3" json:"comment,omitempty"`
	DefaultSampleType int64        `protobuf:"varint,14,opt,name=default_sample_type,json=defaultSampleType,proto3" json:"default_sample_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Profile) Descriptor deprecated 

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

Deprecated: Use Profile.ProtoReflect.Descriptor instead.

func (*Profile) GetComment 

func (x *Profile) GetComment() []int64

func (*Profile) GetDefaultSampleType 

func (x *Profile) GetDefaultSampleType() int64

func (*Profile) GetDropFrames 

func (x *Profile) GetDropFrames() int64

func (*Profile) GetDurationNanos 

func (x *Profile) GetDurationNanos() int64

func (*Profile) GetFunction 

func (x *Profile) GetFunction() []*Function

func (*Profile) GetKeepFrames 

func (x *Profile) GetKeepFrames() int64

func (*Profile) GetLocation 

func (x *Profile) GetLocation() []*Location

func (*Profile) GetMapping 

func (x *Profile) GetMapping() []*Mapping

func (*Profile) GetPeriod 

func (x *Profile) GetPeriod() int64

func (*Profile) GetPeriodType 

func (x *Profile) GetPeriodType() *ValueType

func (*Profile) GetSample 

func (x *Profile) GetSample() []*Sample

func (*Profile) GetSampleType 

func (x *Profile) GetSampleType() []*ValueType

func (*Profile) GetStringTable 

func (x *Profile) GetStringTable() []string

func (*Profile) GetTimeNanos 

func (x *Profile) GetTimeNanos() int64

func (*Profile) ProtoMessage 

func (*Profile) ProtoMessage()

func (*Profile) ProtoReflect 

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

func (*Profile) Reset 

func (x *Profile) Reset()

func (*Profile) String 

func (x *Profile) String() string

type ProfileAnalysisClient 

type ProfileAnalysisClient interface {
	// Starts a profiling session, blocks until it completes.
	// TPUProfileAnalysis service delegate this to TPUProfiler service.
	// Populate the profiled data in repository, then return status to caller.
	NewSession(ctx context.Context, in *NewProfileSessionRequest, opts ...grpc.CallOption) (*NewProfileSessionResponse, error)
	// Enumerate existing sessions and return available profile tools.
	EnumSessions(ctx context.Context, in *EnumProfileSessionsAndToolsRequest, opts ...grpc.CallOption) (*EnumProfileSessionsAndToolsResponse, error)
	// Retrieve specific tool's data for specific session.
	GetSessionToolData(ctx context.Context, in *ProfileSessionDataRequest, opts ...grpc.CallOption) (*ProfileSessionDataResponse, error)
}

ProfileAnalysisClient is the client API for ProfileAnalysis 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.

func NewProfileAnalysisClient 

func NewProfileAnalysisClient(cc grpc.ClientConnInterface) ProfileAnalysisClient

type ProfileAnalysisServer 

type ProfileAnalysisServer interface {
	// Starts a profiling session, blocks until it completes.
	// TPUProfileAnalysis service delegate this to TPUProfiler service.
	// Populate the profiled data in repository, then return status to caller.
	NewSession(context.Context, *NewProfileSessionRequest) (*NewProfileSessionResponse, error)
	// Enumerate existing sessions and return available profile tools.
	EnumSessions(context.Context, *EnumProfileSessionsAndToolsRequest) (*EnumProfileSessionsAndToolsResponse, error)
	// Retrieve specific tool's data for specific session.
	GetSessionToolData(context.Context, *ProfileSessionDataRequest) (*ProfileSessionDataResponse, error)
	// contains filtered or unexported methods
}

ProfileAnalysisServer is the server API for ProfileAnalysis service. All implementations must embed UnimplementedProfileAnalysisServer for forward compatibility

type ProfileOptions 

type ProfileOptions struct {

	// Some default value of option are not proto3 default value. Use this version
	// to determine if we should use default option value instead of proto3
	// default value.
	Version uint32 `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	// Device type to profile/trace: (version >= 1)
	// DeviceType::UNSPECIFIED: All registered device profiler will be enabled.
	// DeviceType::CPU: only CPU will be profiled.
	// DeviceType::GPU: only CPU/GPU will be profiled.
	// DeviceType::TPU: only CPU/TPU will be profiled.
	// DeviceType::PLUGGABLE_DEVICE: only CPU/pluggable devices with profilers
	// will be profiled.
	DeviceType ProfileOptions_DeviceType `` /* 134-byte string literal not displayed */
	// We don't collect the dataset ops by default for better trace-viewer
	// scalability. The caller can manually set this field to include the ops.
	IncludeDatasetOps bool `protobuf:"varint,1,opt,name=include_dataset_ops,json=includeDatasetOps,proto3" json:"include_dataset_ops,omitempty"`
	// Levels of host tracing: (version >= 1)
	//   - Level 0 is used to disable host traces.
	//   - Level 1 enables tracing of only user instrumented (or default) TraceMe.
	//   - Level 2 enables tracing of all level 1 TraceMe(s) and instrumented high
	//     level program execution details (expensive TF ops, XLA ops, etc).
	//     This is the default.
	//   - Level 3 enables tracing of all level 2 TraceMe(s) and more verbose
	//     (low-level) program execution details (cheap TF ops, etc).
	HostTracerLevel uint32 `protobuf:"varint,2,opt,name=host_tracer_level,json=hostTracerLevel,proto3" json:"host_tracer_level,omitempty"`
	// Levels of device tracing: (version >= 1)
	//   - Level 0 is used to disable device traces.
	//   - Level 1 is used to enable device traces.
	//   - More levels might be defined for specific device for controlling the
	//     verbosity of the trace.
	DeviceTracerLevel uint32 `protobuf:"varint,3,opt,name=device_tracer_level,json=deviceTracerLevel,proto3" json:"device_tracer_level,omitempty"`
	// Whether enable python function calls tracing. Runtime overhead ensues if
	// enabled. Default off. (version >= 1)
	PythonTracerLevel uint32 `protobuf:"varint,4,opt,name=python_tracer_level,json=pythonTracerLevel,proto3" json:"python_tracer_level,omitempty"`
	// Whether serialize hlo_proto when XLA is used. (version >= 1)
	EnableHloProto bool `protobuf:"varint,7,opt,name=enable_hlo_proto,json=enableHloProto,proto3" json:"enable_hlo_proto,omitempty"`
	// The local profiler starts profiling at this Unix timestamp in nanoseconds.
	StartTimestampNs uint64 `protobuf:"varint,8,opt,name=start_timestamp_ns,json=startTimestampNs,proto3" json:"start_timestamp_ns,omitempty"`
	// The local profiler collects `duration_ms` milliseconds of data. If the
	// value is 0, profiling continues until interrupted.
	DurationMs uint64 `protobuf:"varint,9,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// Directory to save profile data to. No-op when empty.
	RepositoryPath string `protobuf:"bytes,10,opt,name=repository_path,json=repositoryPath,proto3" json:"repository_path,omitempty"`
	// contains filtered or unexported fields
}

Next ID: 11

func (*ProfileOptions) Descriptor deprecated 

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

Deprecated: Use ProfileOptions.ProtoReflect.Descriptor instead.

func (*ProfileOptions) GetDeviceTracerLevel 

func (x *ProfileOptions) GetDeviceTracerLevel() uint32

func (*ProfileOptions) GetDeviceType 

func (x *ProfileOptions) GetDeviceType() ProfileOptions_DeviceType

func (*ProfileOptions) GetDurationMs 

func (x *ProfileOptions) GetDurationMs() uint64

func (*ProfileOptions) GetEnableHloProto 

func (x *ProfileOptions) GetEnableHloProto() bool

func (*ProfileOptions) GetHostTracerLevel 

func (x *ProfileOptions) GetHostTracerLevel() uint32

func (*ProfileOptions) GetIncludeDatasetOps 

func (x *ProfileOptions) GetIncludeDatasetOps() bool

func (*ProfileOptions) GetPythonTracerLevel 

func (x *ProfileOptions) GetPythonTracerLevel() uint32

func (*ProfileOptions) GetRepositoryPath 

func (x *ProfileOptions) GetRepositoryPath() string

func (*ProfileOptions) GetStartTimestampNs 

func (x *ProfileOptions) GetStartTimestampNs() uint64

func (*ProfileOptions) GetVersion 

func (x *ProfileOptions) GetVersion() uint32

func (*ProfileOptions) ProtoMessage 

func (*ProfileOptions) ProtoMessage()

func (*ProfileOptions) ProtoReflect 

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

func (*ProfileOptions) Reset 

func (x *ProfileOptions) Reset()

func (*ProfileOptions) String 

func (x *ProfileOptions) String() string

type ProfileOptions_DeviceType 

type ProfileOptions_DeviceType int32
const (
	ProfileOptions_UNSPECIFIED      ProfileOptions_DeviceType = 0
	ProfileOptions_CPU              ProfileOptions_DeviceType = 1
	ProfileOptions_GPU              ProfileOptions_DeviceType = 2
	ProfileOptions_TPU              ProfileOptions_DeviceType = 3
	ProfileOptions_PLUGGABLE_DEVICE ProfileOptions_DeviceType = 4
)

func (ProfileOptions_DeviceType) Descriptor 

func (ProfileOptions_DeviceType) Descriptor() protoreflect.EnumDescriptor

func (ProfileOptions_DeviceType) Enum 

func (x ProfileOptions_DeviceType) Enum() *ProfileOptions_DeviceType

func (ProfileOptions_DeviceType) EnumDescriptor deprecated 

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

Deprecated: Use ProfileOptions_DeviceType.Descriptor instead.

func (ProfileOptions_DeviceType) Number 

func (x ProfileOptions_DeviceType) Number() protoreflect.EnumNumber

func (ProfileOptions_DeviceType) String 

func (x ProfileOptions_DeviceType) String() string

func (ProfileOptions_DeviceType) Type 

func (ProfileOptions_DeviceType) Type() protoreflect.EnumType

type ProfileRequest 

type ProfileRequest struct {

	// In future, the caller will be able to customize when profiling starts and
	// stops. For now, it collects `duration_ms` milliseconds worth of data.
	DurationMs uint64 `protobuf:"varint,1,opt,name=duration_ms,json=durationMs,proto3" json:"duration_ms,omitempty"`
	// The maximum number of events to return. By default (value 0), return all
	// events.
	MaxEvents uint64 `protobuf:"varint,2,opt,name=max_events,json=maxEvents,proto3" json:"max_events,omitempty"`
	// Required profiling tools name such as "input_pipeline_analyzer" etc
	Tools []string `protobuf:"bytes,3,rep,name=tools,proto3" json:"tools,omitempty"`
	// Specifies the requirement for each tools.
	ToolOptions map[string]*ToolRequestOptions `` /* 182-byte string literal not displayed */
	// Optional profiling options that control how a TF session will be profiled.
	Opts *ProfileOptions `protobuf:"bytes,4,opt,name=opts,proto3" json:"opts,omitempty"`
	// The place where we will dump profile data. We will normally use
	// MODEL_DIR/plugins/profile/ as the repository root.
	RepositoryRoot string `protobuf:"bytes,5,opt,name=repository_root,json=repositoryRoot,proto3" json:"repository_root,omitempty"`
	// The user provided profile session identifier.
	SessionId string `protobuf:"bytes,6,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// The hostname of system where the profile should happen.
	// We use it as identifier in part of our output filename.
	HostName string `protobuf:"bytes,7,opt,name=host_name,json=hostName,proto3" json:"host_name,omitempty"`
	// contains filtered or unexported fields
}

Next-ID: 9

func (*ProfileRequest) Descriptor deprecated 

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

Deprecated: Use ProfileRequest.ProtoReflect.Descriptor instead.

func (*ProfileRequest) GetDurationMs 

func (x *ProfileRequest) GetDurationMs() uint64

func (*ProfileRequest) GetHostName 

func (x *ProfileRequest) GetHostName() string

func (*ProfileRequest) GetMaxEvents 

func (x *ProfileRequest) GetMaxEvents() uint64

func (*ProfileRequest) GetOpts 

func (x *ProfileRequest) GetOpts() *ProfileOptions

func (*ProfileRequest) GetRepositoryRoot 

func (x *ProfileRequest) GetRepositoryRoot() string

func (*ProfileRequest) GetSessionId 

func (x *ProfileRequest) GetSessionId() string

func (*ProfileRequest) GetToolOptions 

func (x *ProfileRequest) GetToolOptions() map[string]*ToolRequestOptions

func (*ProfileRequest) GetTools 

func (x *ProfileRequest) GetTools() []string

func (*ProfileRequest) ProtoMessage 

func (*ProfileRequest) ProtoMessage()

func (*ProfileRequest) ProtoReflect 

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

func (*ProfileRequest) Reset 

func (x *ProfileRequest) Reset()

func (*ProfileRequest) String 

func (x *ProfileRequest) String() string

type ProfileResponse 

type ProfileResponse struct {

	// Data payload for each required tools.
	ToolData []*ProfileToolData `protobuf:"bytes,6,rep,name=tool_data,json=toolData,proto3" json:"tool_data,omitempty"`
	// When we write profiling data directly to repository directory, we need a
	// way to figure out whether the captured trace is empty.
	EmptyTrace bool `protobuf:"varint,7,opt,name=empty_trace,json=emptyTrace,proto3" json:"empty_trace,omitempty"`
	// contains filtered or unexported fields
}

Next-ID: 8

func (*ProfileResponse) Descriptor deprecated 

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

Deprecated: Use ProfileResponse.ProtoReflect.Descriptor instead.

func (*ProfileResponse) GetEmptyTrace 

func (x *ProfileResponse) GetEmptyTrace() bool

func (*ProfileResponse) GetToolData 

func (x *ProfileResponse) GetToolData() []*ProfileToolData

func (*ProfileResponse) ProtoMessage 

func (*ProfileResponse) ProtoMessage()

func (*ProfileResponse) ProtoReflect 

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

func (*ProfileResponse) Reset 

func (x *ProfileResponse) Reset()

func (*ProfileResponse) String 

func (x *ProfileResponse) String() string

type ProfileSessionDataRequest 

type ProfileSessionDataRequest struct {

	// The place where we will read profile data. We will normally use
	// MODEL_DIR/plugins/profile as the repository root.
	RepositoryRoot string `protobuf:"bytes,1,opt,name=repository_root,json=repositoryRoot,proto3" json:"repository_root,omitempty"`
	SessionId      string `protobuf:"bytes,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// Which host the data is associated. if empty, data from all hosts are
	// aggregated.
	HostName string `protobuf:"bytes,5,opt,name=host_name,json=hostName,proto3" json:"host_name,omitempty"`
	// Which tool
	ToolName string `protobuf:"bytes,3,opt,name=tool_name,json=toolName,proto3" json:"tool_name,omitempty"`
	// Tool's specific parameters. e.g. TraceViewer's viewport etc
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ProfileSessionDataRequest) Descriptor deprecated 

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

Deprecated: Use ProfileSessionDataRequest.ProtoReflect.Descriptor instead.

func (*ProfileSessionDataRequest) GetHostName 

func (x *ProfileSessionDataRequest) GetHostName() string

func (*ProfileSessionDataRequest) GetParameters 

func (x *ProfileSessionDataRequest) GetParameters() map[string]string

func (*ProfileSessionDataRequest) GetRepositoryRoot 

func (x *ProfileSessionDataRequest) GetRepositoryRoot() string

func (*ProfileSessionDataRequest) GetSessionId 

func (x *ProfileSessionDataRequest) GetSessionId() string

func (*ProfileSessionDataRequest) GetToolName 

func (x *ProfileSessionDataRequest) GetToolName() string

func (*ProfileSessionDataRequest) ProtoMessage 

func (*ProfileSessionDataRequest) ProtoMessage()

func (*ProfileSessionDataRequest) ProtoReflect 

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

func (*ProfileSessionDataRequest) Reset 

func (x *ProfileSessionDataRequest) Reset()

func (*ProfileSessionDataRequest) String 

func (x *ProfileSessionDataRequest) String() string

type ProfileSessionDataResponse 

type ProfileSessionDataResponse struct {

	// Auxiliary error_message.
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Output format. e.g. "json" or "proto" or "blob"
	OutputFormat string `protobuf:"bytes,2,opt,name=output_format,json=outputFormat,proto3" json:"output_format,omitempty"`
	// TODO(jiesun): figure out whether to put bytes or oneof tool specific proto.
	Output []byte `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfileSessionDataResponse) Descriptor deprecated 

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

Deprecated: Use ProfileSessionDataResponse.ProtoReflect.Descriptor instead.

func (*ProfileSessionDataResponse) GetErrorMessage 

func (x *ProfileSessionDataResponse) GetErrorMessage() string

func (*ProfileSessionDataResponse) GetOutput 

func (x *ProfileSessionDataResponse) GetOutput() []byte

func (*ProfileSessionDataResponse) GetOutputFormat 

func (x *ProfileSessionDataResponse) GetOutputFormat() string

func (*ProfileSessionDataResponse) ProtoMessage 

func (*ProfileSessionDataResponse) ProtoMessage()

func (*ProfileSessionDataResponse) ProtoReflect 

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

func (*ProfileSessionDataResponse) Reset 

func (x *ProfileSessionDataResponse) Reset()

func (*ProfileSessionDataResponse) String 

func (x *ProfileSessionDataResponse) String() string

type ProfileSessionInfo 

type ProfileSessionInfo struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// Which tool data is available for consumption.
	AvailableTools []string `protobuf:"bytes,2,rep,name=available_tools,json=availableTools,proto3" json:"available_tools,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfileSessionInfo) Descriptor deprecated 

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

Deprecated: Use ProfileSessionInfo.ProtoReflect.Descriptor instead.

func (*ProfileSessionInfo) GetAvailableTools 

func (x *ProfileSessionInfo) GetAvailableTools() []string

func (*ProfileSessionInfo) GetSessionId 

func (x *ProfileSessionInfo) GetSessionId() string

func (*ProfileSessionInfo) ProtoMessage 

func (*ProfileSessionInfo) ProtoMessage()

func (*ProfileSessionInfo) ProtoReflect 

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

func (*ProfileSessionInfo) Reset 

func (x *ProfileSessionInfo) Reset()

func (*ProfileSessionInfo) String 

func (x *ProfileSessionInfo) String() string

type ProfileToolData 

type ProfileToolData struct {

	// The file name which this data is associated (e.g. "input_pipeline.json",
	// "cluster_xxx.memory_viewer.json").
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The data payload (likely json) for the specific tool.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfileToolData) Descriptor deprecated 

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

Deprecated: Use ProfileToolData.ProtoReflect.Descriptor instead.

func (*ProfileToolData) GetData 

func (x *ProfileToolData) GetData() []byte

func (*ProfileToolData) GetName 

func (x *ProfileToolData) GetName() string

func (*ProfileToolData) ProtoMessage 

func (*ProfileToolData) ProtoMessage()

func (*ProfileToolData) ProtoReflect 

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

func (*ProfileToolData) Reset 

func (x *ProfileToolData) Reset()

func (*ProfileToolData) String 

func (x *ProfileToolData) String() string

type ProfiledInstructionsProto added in v2.14.0 

type ProfiledInstructionsProto struct {
	Costs     []*ProfiledInstructionsProto_InstructionCost `protobuf:"bytes,1,rep,name=costs,proto3" json:"costs,omitempty"`
	Latencies []*ProfiledInstructionsProto_Latency         `protobuf:"bytes,2,rep,name=latencies,proto3" json:"latencies,omitempty"`
	// contains filtered or unexported fields
}

Next ID: 3

func (*ProfiledInstructionsProto) Descriptor deprecated added in v2.14.0 

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

Deprecated: Use ProfiledInstructionsProto.ProtoReflect.Descriptor instead.

func (*ProfiledInstructionsProto) GetCosts added in v2.14.0 

func (x *ProfiledInstructionsProto) GetCosts() []*ProfiledInstructionsProto_InstructionCost

func (*ProfiledInstructionsProto) GetLatencies added in v2.14.0 

func (x *ProfiledInstructionsProto) GetLatencies() []*ProfiledInstructionsProto_Latency

func (*ProfiledInstructionsProto) ProtoMessage added in v2.14.0 

func (*ProfiledInstructionsProto) ProtoMessage()

func (*ProfiledInstructionsProto) ProtoReflect added in v2.14.0 

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

func (*ProfiledInstructionsProto) Reset added in v2.14.0 

func (x *ProfiledInstructionsProto) Reset()

func (*ProfiledInstructionsProto) String added in v2.14.0 

func (x *ProfiledInstructionsProto) String() string

type ProfiledInstructionsProto_InstructionCost added in v2.14.0 

type ProfiledInstructionsProto_InstructionCost struct {
	Name   string  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	CostUs float64 `protobuf:"fixed64,2,opt,name=cost_us,json=costUs,proto3" json:"cost_us,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfiledInstructionsProto_InstructionCost) Descriptor deprecated added in v2.14.0 

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

Deprecated: Use ProfiledInstructionsProto_InstructionCost.ProtoReflect.Descriptor instead.

func (*ProfiledInstructionsProto_InstructionCost) GetCostUs added in v2.14.0 

func (x *ProfiledInstructionsProto_InstructionCost) GetCostUs() float64

func (*ProfiledInstructionsProto_InstructionCost) GetName added in v2.14.0 

func (x *ProfiledInstructionsProto_InstructionCost) GetName() string

func (*ProfiledInstructionsProto_InstructionCost) ProtoMessage added in v2.14.0 

func (*ProfiledInstructionsProto_InstructionCost) ProtoMessage()

func (*ProfiledInstructionsProto_InstructionCost) ProtoReflect added in v2.14.0 

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

func (*ProfiledInstructionsProto_InstructionCost) Reset added in v2.14.0 

func (x *ProfiledInstructionsProto_InstructionCost) Reset()

func (*ProfiledInstructionsProto_InstructionCost) String added in v2.14.0 

func (x *ProfiledInstructionsProto_InstructionCost) String() string

type ProfiledInstructionsProto_Latency added in v2.14.0 

type ProfiledInstructionsProto_Latency struct {
	Source    string  `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Target    string  `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	LatencyUs float64 `protobuf:"fixed64,3,opt,name=latency_us,json=latencyUs,proto3" json:"latency_us,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfiledInstructionsProto_Latency) Descriptor deprecated added in v2.14.0 

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

Deprecated: Use ProfiledInstructionsProto_Latency.ProtoReflect.Descriptor instead.

func (*ProfiledInstructionsProto_Latency) GetLatencyUs added in v2.14.0 

func (x *ProfiledInstructionsProto_Latency) GetLatencyUs() float64

func (*ProfiledInstructionsProto_Latency) GetSource added in v2.14.0 

func (x *ProfiledInstructionsProto_Latency) GetSource() string

func (*ProfiledInstructionsProto_Latency) GetTarget added in v2.14.0 

func (x *ProfiledInstructionsProto_Latency) GetTarget() string

func (*ProfiledInstructionsProto_Latency) ProtoMessage added in v2.14.0 

func (*ProfiledInstructionsProto_Latency) ProtoMessage()

func (*ProfiledInstructionsProto_Latency) ProtoReflect added in v2.14.0 

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

func (*ProfiledInstructionsProto_Latency) Reset added in v2.14.0 

func (x *ProfiledInstructionsProto_Latency) Reset()

func (*ProfiledInstructionsProto_Latency) String added in v2.14.0 

func (x *ProfiledInstructionsProto_Latency) String() string

type ProfilerServiceClient 

type ProfilerServiceClient interface {
	// Starts a profiling session, blocks until it completes, and returns data.
	Profile(ctx context.Context, in *ProfileRequest, opts ...grpc.CallOption) (*ProfileResponse, error)
	// Signal to terminate the Profile rpc for a on-going profiling session,
	// The Profile rpc will return successfully and prematurely without timeout.
	// This is used by programmatic mode to end the session in workers.
	Terminate(ctx context.Context, in *TerminateRequest, opts ...grpc.CallOption) (*TerminateResponse, error)
	// Collects profiling data and returns user-friendly metrics.
	Monitor(ctx context.Context, in *MonitorRequest, opts ...grpc.CallOption) (*MonitorResponse, error)
}

ProfilerServiceClient is the client API for ProfilerService 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.

func NewProfilerServiceClient 

func NewProfilerServiceClient(cc grpc.ClientConnInterface) ProfilerServiceClient

type ProfilerServiceMonitorResult 

type ProfilerServiceMonitorResult struct {

	// Type of profiling responses.
	ResponseType ProfilerServiceMonitorResult_ResponseType `` /* 156-byte string literal not displayed */
	// Percentage of time when device is idle.
	DeviceIdleTimePercent float64 `` /* 130-byte string literal not displayed */
	// TPU matrix unit utilization percentage.
	MatrixUnitUtilizationPercent float64 `` /* 151-byte string literal not displayed */
	// Average step time in millisecond.
	StepTimeMsAvg float64 `protobuf:"fixed64,4,opt,name=step_time_ms_avg,json=stepTimeMsAvg,proto3" json:"step_time_ms_avg,omitempty"`
	// Minimum step time in millisecond.
	StepTimeMsMin float64 `protobuf:"fixed64,5,opt,name=step_time_ms_min,json=stepTimeMsMin,proto3" json:"step_time_ms_min,omitempty"`
	// Maximum step time in millisecond.
	StepTimeMsMax float64 `protobuf:"fixed64,6,opt,name=step_time_ms_max,json=stepTimeMsMax,proto3" json:"step_time_ms_max,omitempty"`
	// Average infeed percentage.
	InfeedPercentAvg float64 `protobuf:"fixed64,7,opt,name=infeed_percent_avg,json=infeedPercentAvg,proto3" json:"infeed_percent_avg,omitempty"`
	// Minimum infeed percentage.
	InfeedPercentMin float64 `protobuf:"fixed64,8,opt,name=infeed_percent_min,json=infeedPercentMin,proto3" json:"infeed_percent_min,omitempty"`
	// Maximum infeed percentage.
	InfeedPercentMax float64 `protobuf:"fixed64,9,opt,name=infeed_percent_max,json=infeedPercentMax,proto3" json:"infeed_percent_max,omitempty"`
	// contains filtered or unexported fields
}

func (*ProfilerServiceMonitorResult) Descriptor deprecated 

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

Deprecated: Use ProfilerServiceMonitorResult.ProtoReflect.Descriptor instead.

func (*ProfilerServiceMonitorResult) GetDeviceIdleTimePercent 

func (x *ProfilerServiceMonitorResult) GetDeviceIdleTimePercent() float64

func (*ProfilerServiceMonitorResult) GetInfeedPercentAvg 

func (x *ProfilerServiceMonitorResult) GetInfeedPercentAvg() float64

func (*ProfilerServiceMonitorResult) GetInfeedPercentMax 

func (x *ProfilerServiceMonitorResult) GetInfeedPercentMax() float64

func (*ProfilerServiceMonitorResult) GetInfeedPercentMin 

func (x *ProfilerServiceMonitorResult) GetInfeedPercentMin() float64

func (*ProfilerServiceMonitorResult) GetMatrixUnitUtilizationPercent 

func (x *ProfilerServiceMonitorResult) GetMatrixUnitUtilizationPercent() float64

func (*ProfilerServiceMonitorResult) GetResponseType 

func (x *ProfilerServiceMonitorResult) GetResponseType() ProfilerServiceMonitorResult_ResponseType

func (*ProfilerServiceMonitorResult) GetStepTimeMsAvg 

func (x *ProfilerServiceMonitorResult) GetStepTimeMsAvg() float64

func (*ProfilerServiceMonitorResult) GetStepTimeMsMax 

func (x *ProfilerServiceMonitorResult) GetStepTimeMsMax() float64

func (*ProfilerServiceMonitorResult) GetStepTimeMsMin 

func (x *ProfilerServiceMonitorResult) GetStepTimeMsMin() float64

func (*ProfilerServiceMonitorResult) ProtoMessage 

func (*ProfilerServiceMonitorResult) ProtoMessage()

func (*ProfilerServiceMonitorResult) ProtoReflect 

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

func (*ProfilerServiceMonitorResult) Reset 

func (x *ProfilerServiceMonitorResult) Reset()

func (*ProfilerServiceMonitorResult) String 

func (x *ProfilerServiceMonitorResult) String() string

type ProfilerServiceMonitorResult_ResponseType 

type ProfilerServiceMonitorResult_ResponseType int32

Represents the different types of responses from the profiling service. 

const (
	// No result is returned from the profiling service.
	ProfilerServiceMonitorResult_EMPTY_RESULT ProfilerServiceMonitorResult_ResponseType = 0
	// Only device utilization is available.
	ProfilerServiceMonitorResult_UTIL_ONLY ProfilerServiceMonitorResult_ResponseType = 1
	// Both device utilization and device idle time are available.
	ProfilerServiceMonitorResult_UTIL_IDLE ProfilerServiceMonitorResult_ResponseType = 2
	// Device utilization, device idle time, step time, and infeed percentage
	// are all available.
	ProfilerServiceMonitorResult_UTIL_IDLE_STEP ProfilerServiceMonitorResult_ResponseType = 3
)

func (ProfilerServiceMonitorResult_ResponseType) Descriptor 

func (ProfilerServiceMonitorResult_ResponseType) Descriptor() protoreflect.EnumDescriptor

func (ProfilerServiceMonitorResult_ResponseType) Enum 

func (x ProfilerServiceMonitorResult_ResponseType) Enum() *ProfilerServiceMonitorResult_ResponseType

func (ProfilerServiceMonitorResult_ResponseType) EnumDescriptor deprecated 

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

Deprecated: Use ProfilerServiceMonitorResult_ResponseType.Descriptor instead.

func (ProfilerServiceMonitorResult_ResponseType) Number 

func (x ProfilerServiceMonitorResult_ResponseType) Number() protoreflect.EnumNumber

func (ProfilerServiceMonitorResult_ResponseType) String 

func (x ProfilerServiceMonitorResult_ResponseType) String() string

func (ProfilerServiceMonitorResult_ResponseType) Type 

func (ProfilerServiceMonitorResult_ResponseType) Type() protoreflect.EnumType

type ProfilerServiceServer 

type ProfilerServiceServer interface {
	// Starts a profiling session, blocks until it completes, and returns data.
	Profile(context.Context, *ProfileRequest) (*ProfileResponse, error)
	// Signal to terminate the Profile rpc for a on-going profiling session,
	// The Profile rpc will return successfully and prematurely without timeout.
	// This is used by programmatic mode to end the session in workers.
	Terminate(context.Context, *TerminateRequest) (*TerminateResponse, error)
	// Collects profiling data and returns user-friendly metrics.
	Monitor(context.Context, *MonitorRequest) (*MonitorResponse, error)
	// contains filtered or unexported methods
}

ProfilerServiceServer is the server API for ProfilerService service. All implementations must embed UnimplementedProfilerServiceServer for forward compatibility

type RemoteProfilerSessionManagerOptions 

type RemoteProfilerSessionManagerOptions struct {

	// Options for each local profiler.
	ProfilerOptions *ProfileOptions `protobuf:"bytes,1,opt,name=profiler_options,json=profilerOptions,proto3" json:"profiler_options,omitempty"`
	// List of servers to profile. Supported formats: host:port.
	ServiceAddresses []string `protobuf:"bytes,2,rep,name=service_addresses,json=serviceAddresses,proto3" json:"service_addresses,omitempty"`
	// Unix timestamp of when the session was started.
	SessionCreationTimestampNs uint64 `` /* 144-byte string literal not displayed */
	// Maximum time (in milliseconds) a profiling session manager waits for all
	// profilers to finish after issuing gRPC request. If value is 0, session
	// continues until interrupted. Otherwise, value must be greater than
	// profiler_options.duration_ms.
	MaxSessionDurationMs uint64 `` /* 126-byte string literal not displayed */
	// Start of profiling is delayed by this much (in milliseconds).
	DelayMs uint64 `protobuf:"varint,5,opt,name=delay_ms,json=delayMs,proto3" json:"delay_ms,omitempty"`
	// contains filtered or unexported fields
}

Options for remote profiler session manager. Next ID: 6

func (*RemoteProfilerSessionManagerOptions) Descriptor deprecated 

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

Deprecated: Use RemoteProfilerSessionManagerOptions.ProtoReflect.Descriptor instead.

func (*RemoteProfilerSessionManagerOptions) GetDelayMs 

func (x *RemoteProfilerSessionManagerOptions) GetDelayMs() uint64

func (*RemoteProfilerSessionManagerOptions) GetMaxSessionDurationMs 

func (x *RemoteProfilerSessionManagerOptions) GetMaxSessionDurationMs() uint64

func (*RemoteProfilerSessionManagerOptions) GetProfilerOptions 

func (x *RemoteProfilerSessionManagerOptions) GetProfilerOptions() *ProfileOptions

func (*RemoteProfilerSessionManagerOptions) GetServiceAddresses 

func (x *RemoteProfilerSessionManagerOptions) GetServiceAddresses() []string

func (*RemoteProfilerSessionManagerOptions) GetSessionCreationTimestampNs 

func (x *RemoteProfilerSessionManagerOptions) GetSessionCreationTimestampNs() uint64

func (*RemoteProfilerSessionManagerOptions) ProtoMessage 

func (*RemoteProfilerSessionManagerOptions) ProtoMessage()

func (*RemoteProfilerSessionManagerOptions) ProtoReflect 

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

func (*RemoteProfilerSessionManagerOptions) Reset 

func (x *RemoteProfilerSessionManagerOptions) Reset()

func (*RemoteProfilerSessionManagerOptions) String 

func (x *RemoteProfilerSessionManagerOptions) String() string

type Resource 

type Resource struct {

	// The name of the resource.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The id of the resource. Unique within a device.
	ResourceId uint32 `protobuf:"varint,2,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// The sort index of the resource. Resources within a device are ordered by
	// this value. if absent, use resource id as sort index.
	SortIndex uint32 `protobuf:"varint,3,opt,name=sort_index,json=sortIndex,proto3" json:"sort_index,omitempty"`
	// contains filtered or unexported fields
}

A 'resource' generally is a specific computation component on a device. These can range from threads on CPUs to specific arithmetic units on hardware devices.

func (*Resource) Descriptor deprecated 

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetName 

func (x *Resource) GetName() string

func (*Resource) GetResourceId 

func (x *Resource) GetResourceId() uint32

func (*Resource) GetSortIndex 

func (x *Resource) GetSortIndex() uint32

func (*Resource) ProtoMessage 

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect 

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

func (*Resource) Reset 

func (x *Resource) Reset()

func (*Resource) String 

func (x *Resource) String() string

type Sample 

type Sample struct {
	LocationId []uint64 `protobuf:"varint,1,rep,packed,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	Value      []int64  `protobuf:"varint,2,rep,packed,name=value,proto3" json:"value,omitempty"`
	Label      []*Label `protobuf:"bytes,3,rep,name=label,proto3" json:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*Sample) Descriptor deprecated 

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

Deprecated: Use Sample.ProtoReflect.Descriptor instead.

func (*Sample) GetLabel 

func (x *Sample) GetLabel() []*Label

func (*Sample) GetLocationId 

func (x *Sample) GetLocationId() []uint64

func (*Sample) GetValue 

func (x *Sample) GetValue() []int64

func (*Sample) ProtoMessage 

func (*Sample) ProtoMessage()

func (*Sample) ProtoReflect 

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

func (*Sample) Reset 

func (x *Sample) Reset()

func (*Sample) String 

func (x *Sample) String() string

type TerminateRequest 

type TerminateRequest struct {

	// Which session id to terminate.
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminateRequest) Descriptor deprecated 

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

Deprecated: Use TerminateRequest.ProtoReflect.Descriptor instead.

func (*TerminateRequest) GetSessionId 

func (x *TerminateRequest) GetSessionId() string

func (*TerminateRequest) ProtoMessage 

func (*TerminateRequest) ProtoMessage()

func (*TerminateRequest) ProtoReflect 

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

func (*TerminateRequest) Reset 

func (x *TerminateRequest) Reset()

func (*TerminateRequest) String 

func (x *TerminateRequest) String() string

type TerminateResponse 

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

func (*TerminateResponse) Descriptor deprecated 

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

Deprecated: Use TerminateResponse.ProtoReflect.Descriptor instead.

func (*TerminateResponse) ProtoMessage 

func (*TerminateResponse) ProtoMessage()

func (*TerminateResponse) ProtoReflect 

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

func (*TerminateResponse) Reset 

func (x *TerminateResponse) Reset()

func (*TerminateResponse) String 

func (x *TerminateResponse) String() string

type ToolRequestOptions 

type ToolRequestOptions struct {

	// Required formats for the tool, it should be one of "json", "proto", "raw"
	// etc. If not specified (backward compatible), use default format, i.e. most
	// tools use json format.
	OutputFormats string `protobuf:"bytes,2,opt,name=output_formats,json=outputFormats,proto3" json:"output_formats,omitempty"`
	// Whether save the result directly to repository or pass it back to caller.
	// Default to false for backward compatibilities.
	SaveToRepo bool `protobuf:"varint,3,opt,name=save_to_repo,json=saveToRepo,proto3" json:"save_to_repo,omitempty"`
	// contains filtered or unexported fields
}

func (*ToolRequestOptions) Descriptor deprecated 

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

Deprecated: Use ToolRequestOptions.ProtoReflect.Descriptor instead.

func (*ToolRequestOptions) GetOutputFormats 

func (x *ToolRequestOptions) GetOutputFormats() string

func (*ToolRequestOptions) GetSaveToRepo 

func (x *ToolRequestOptions) GetSaveToRepo() bool

func (*ToolRequestOptions) ProtoMessage 

func (*ToolRequestOptions) ProtoMessage()

func (*ToolRequestOptions) ProtoReflect 

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

func (*ToolRequestOptions) Reset 

func (x *ToolRequestOptions) Reset()

func (*ToolRequestOptions) String 

func (x *ToolRequestOptions) String() string

type Trace 

type Trace struct {

	// The devices that this trace has information about. Maps from device_id to
	// more data about the specific device.
	Devices map[uint32]*Device `` /* 156-byte string literal not displayed */
	// All trace events capturing in the profiling period.
	TraceEvents []*TraceEvent `protobuf:"bytes,4,rep,name=trace_events,json=traceEvents,proto3" json:"trace_events,omitempty"`
	// contains filtered or unexported fields
}

A 'Trace' contains metadata for the individual traces of a system.

func (*Trace) Descriptor deprecated 

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

Deprecated: Use Trace.ProtoReflect.Descriptor instead.

func (*Trace) GetDevices 

func (x *Trace) GetDevices() map[uint32]*Device

func (*Trace) GetTraceEvents 

func (x *Trace) GetTraceEvents() []*TraceEvent

func (*Trace) ProtoMessage 

func (*Trace) ProtoMessage()

func (*Trace) ProtoReflect 

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

func (*Trace) Reset 

func (x *Trace) Reset()

func (*Trace) String 

func (x *Trace) String() string

type TraceEvent 

type TraceEvent struct {

	// The id of the device that this event occurred on. The full dataset should
	// have this device present in the Trace object.
	DeviceId uint32 `protobuf:"varint,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// The id of the resource that this event occurred on. The full dataset should
	// have this resource present in the Device object of the Trace object. A
	// resource_id is unique on a specific device, but not necessarily within the
	// trace.
	ResourceId uint32 `protobuf:"varint,2,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// The name of this trace event.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// The timestamp that this event occurred at (in picos since tracing started).
	TimestampPs uint64 `protobuf:"varint,9,opt,name=timestamp_ps,json=timestampPs,proto3" json:"timestamp_ps,omitempty"`
	// The duration of the event in picoseconds if applicable.
	// Events without duration are called instant events.
	DurationPs uint64 `protobuf:"varint,10,opt,name=duration_ps,json=durationPs,proto3" json:"duration_ps,omitempty"`
	// Extra arguments that will be displayed in trace view.
	Args map[string]string `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*TraceEvent) Descriptor deprecated 

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

Deprecated: Use TraceEvent.ProtoReflect.Descriptor instead.

func (*TraceEvent) GetArgs 

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

func (*TraceEvent) GetDeviceId 

func (x *TraceEvent) GetDeviceId() uint32

func (*TraceEvent) GetDurationPs 

func (x *TraceEvent) GetDurationPs() uint64

func (*TraceEvent) GetName 

func (x *TraceEvent) GetName() string

func (*TraceEvent) GetResourceId 

func (x *TraceEvent) GetResourceId() uint32

func (*TraceEvent) GetTimestampPs 

func (x *TraceEvent) GetTimestampPs() uint64

func (*TraceEvent) ProtoMessage 

func (*TraceEvent) ProtoMessage()

func (*TraceEvent) ProtoReflect 

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

func (*TraceEvent) Reset 

func (x *TraceEvent) Reset()

func (*TraceEvent) String 

func (x *TraceEvent) String() string

type UnimplementedProfileAnalysisServer 

type UnimplementedProfileAnalysisServer struct {
}

UnimplementedProfileAnalysisServer must be embedded to have forward compatible implementations.

func (UnimplementedProfileAnalysisServer) EnumSessions 

func (UnimplementedProfileAnalysisServer) EnumSessions(context.Context, *EnumProfileSessionsAndToolsRequest) (*EnumProfileSessionsAndToolsResponse, error)

func (UnimplementedProfileAnalysisServer) GetSessionToolData 

func (UnimplementedProfileAnalysisServer) GetSessionToolData(context.Context, *ProfileSessionDataRequest) (*ProfileSessionDataResponse, error)

func (UnimplementedProfileAnalysisServer) NewSession 

func (UnimplementedProfileAnalysisServer) NewSession(context.Context, *NewProfileSessionRequest) (*NewProfileSessionResponse, error)

type UnimplementedProfilerServiceServer 

type UnimplementedProfilerServiceServer struct {
}

UnimplementedProfilerServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedProfilerServiceServer) Monitor 

func (UnimplementedProfilerServiceServer) Monitor(context.Context, *MonitorRequest) (*MonitorResponse, error)

func (UnimplementedProfilerServiceServer) Profile 

func (UnimplementedProfilerServiceServer) Profile(context.Context, *ProfileRequest) (*ProfileResponse, error)

func (UnimplementedProfilerServiceServer) Terminate 

func (UnimplementedProfilerServiceServer) Terminate(context.Context, *TerminateRequest) (*TerminateResponse, error)

type UnsafeProfileAnalysisServer 

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

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

type UnsafeProfilerServiceServer 

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

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

type ValueType 

type ValueType struct {
	Type int64 `protobuf:"varint,1,opt,name=type,proto3" json:"type,omitempty"`
	Unit int64 `protobuf:"varint,2,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

func (*ValueType) Descriptor deprecated 

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

Deprecated: Use ValueType.ProtoReflect.Descriptor instead.

func (*ValueType) GetType 

func (x *ValueType) GetType() int64

func (*ValueType) GetUnit 

func (x *ValueType) GetUnit() int64

func (*ValueType) ProtoMessage 

func (*ValueType) ProtoMessage()

func (*ValueType) ProtoReflect 

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

func (*ValueType) Reset 

func (x *ValueType) Reset()

func (*ValueType) String 

func (x *ValueType) String() string

type XEvent 

type XEvent struct {

	// XEventMetadata.id of corresponding metadata.
	MetadataId int64 `protobuf:"varint,1,opt,name=metadata_id,json=metadataId,proto3" json:"metadata_id,omitempty"`
	// Types that are assignable to Data:
	//
	//	*XEvent_OffsetPs
	//	*XEvent_NumOccurrences
	Data isXEvent_Data `protobuf_oneof:"data"`
	// Duration of the event in picoseconds. Can be zero for an instant event.
	DurationPs int64 `protobuf:"varint,3,opt,name=duration_ps,json=durationPs,proto3" json:"duration_ps,omitempty"`
	// XStats associated with the event.
	// Each of these XStats should have a different metadata_id.
	Stats []*XStat `protobuf:"bytes,4,rep,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

An XEvent is a trace event, optionally annotated with XStats. Next ID: 6

func (*XEvent) Descriptor deprecated 

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

Deprecated: Use XEvent.ProtoReflect.Descriptor instead.

func (*XEvent) GetData 

func (m *XEvent) GetData() isXEvent_Data

func (*XEvent) GetDurationPs 

func (x *XEvent) GetDurationPs() int64

func (*XEvent) GetMetadataId 

func (x *XEvent) GetMetadataId() int64

func (*XEvent) GetNumOccurrences 

func (x *XEvent) GetNumOccurrences() int64

func (*XEvent) GetOffsetPs 

func (x *XEvent) GetOffsetPs() int64

func (*XEvent) GetStats 

func (x *XEvent) GetStats() []*XStat

func (*XEvent) ProtoMessage 

func (*XEvent) ProtoMessage()

func (*XEvent) ProtoReflect 

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

func (*XEvent) Reset 

func (x *XEvent) Reset()

func (*XEvent) String 

func (x *XEvent) String() string

type XEventMetadata 

type XEventMetadata struct {

	// XPlane.event_metadata map key.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the event.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Name of the event shown in trace viewer.
	DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Additional metadata in serialized format.
	Metadata []byte `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// XStats that are constant for all XEvents with the same metadata_id.
	// Each of these XStats should have a different metadata_id.
	Stats []*XStat `protobuf:"bytes,5,rep,name=stats,proto3" json:"stats,omitempty"`
	// XPlane.event_metadata map key for children events.
	ChildId []int64 `protobuf:"varint,6,rep,packed,name=child_id,json=childId,proto3" json:"child_id,omitempty"`
	// contains filtered or unexported fields
}

Metadata for an XEvent, corresponds to an event type and is shared by all XEvents with the same metadata_id. Next ID: 7

func (*XEventMetadata) Descriptor deprecated 

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

Deprecated: Use XEventMetadata.ProtoReflect.Descriptor instead.

func (*XEventMetadata) GetChildId 

func (x *XEventMetadata) GetChildId() []int64

func (*XEventMetadata) GetDisplayName 

func (x *XEventMetadata) GetDisplayName() string

func (*XEventMetadata) GetId 

func (x *XEventMetadata) GetId() int64

func (*XEventMetadata) GetMetadata 

func (x *XEventMetadata) GetMetadata() []byte

func (*XEventMetadata) GetName 

func (x *XEventMetadata) GetName() string

func (*XEventMetadata) GetStats 

func (x *XEventMetadata) GetStats() []*XStat

func (*XEventMetadata) ProtoMessage 

func (*XEventMetadata) ProtoMessage()

func (*XEventMetadata) ProtoReflect 

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

func (*XEventMetadata) Reset 

func (x *XEventMetadata) Reset()

func (*XEventMetadata) String 

func (x *XEventMetadata) String() string

type XEvent_NumOccurrences 

type XEvent_NumOccurrences struct {
	// Number of occurrences of the event, if aggregated.
	NumOccurrences int64 `protobuf:"varint,5,opt,name=num_occurrences,json=numOccurrences,proto3,oneof"`
}

type XEvent_OffsetPs 

type XEvent_OffsetPs struct {
	// Start time of the event in picoseconds, as offset from
	// XLine.timestamp_ns().
	OffsetPs int64 `protobuf:"varint,2,opt,name=offset_ps,json=offsetPs,proto3,oneof"`
}

type XLine 

type XLine struct {

	// Id of this line, can be repeated within an XPlane. All XLines with the
	// same id are effectively the same timeline.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Display id of this line. Multiple lines with the same display_id are
	// grouped together in the same trace viewer row.
	DisplayId int64 `protobuf:"varint,10,opt,name=display_id,json=displayId,proto3" json:"display_id,omitempty"`
	// Name of this XLine.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Name of this XLine to display in trace viewer.
	DisplayName string `protobuf:"bytes,11,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Start time of this line in nanoseconds since the UNIX epoch.
	// XEvent.offset_ps is relative to this timestamp.
	TimestampNs int64 `protobuf:"varint,3,opt,name=timestamp_ns,json=timestampNs,proto3" json:"timestamp_ns,omitempty"`
	// Profiling duration for this line in picoseconds.
	DurationPs int64 `protobuf:"varint,9,opt,name=duration_ps,json=durationPs,proto3" json:"duration_ps,omitempty"`
	// XEvents within the same XLine should not overlap in time, but they can be
	// nested.
	Events []*XEvent `protobuf:"bytes,4,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

An XLine is a timeline of trace events (XEvents). Next ID: 12

func (*XLine) Descriptor deprecated 

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

Deprecated: Use XLine.ProtoReflect.Descriptor instead.

func (*XLine) GetDisplayId 

func (x *XLine) GetDisplayId() int64

func (*XLine) GetDisplayName 

func (x *XLine) GetDisplayName() string

func (*XLine) GetDurationPs 

func (x *XLine) GetDurationPs() int64

func (*XLine) GetEvents 

func (x *XLine) GetEvents() []*XEvent

func (*XLine) GetId 

func (x *XLine) GetId() int64

func (*XLine) GetName 

func (x *XLine) GetName() string

func (*XLine) GetTimestampNs 

func (x *XLine) GetTimestampNs() int64

func (*XLine) ProtoMessage 

func (*XLine) ProtoMessage()

func (*XLine) ProtoReflect 

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

func (*XLine) Reset 

func (x *XLine) Reset()

func (*XLine) String 

func (x *XLine) String() string

type XPlane 

type XPlane struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of this XPlane.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Parallel timelines grouped in this plane. XLines with the same id
	// are effectively the same timeline.
	Lines []*XLine `protobuf:"bytes,3,rep,name=lines,proto3" json:"lines,omitempty"`
	// XEventMetadata map, each entry uses the XEventMetadata.id as key. This map
	// should be used for events that share the same ID over the whole XPlane.
	EventMetadata map[int64]*XEventMetadata `` /* 189-byte string literal not displayed */
	// XStatMetadata map, each entry uses the XStatMetadata.id as key. This map
	// should be used for stats that share the same ID over the whole XPlane.
	StatMetadata map[int64]*XStatMetadata `` /* 186-byte string literal not displayed */
	// XStats associated with this plane, e.g. device capabilities.
	// Each of these XStats should have a different metadata_id.
	Stats []*XStat `protobuf:"bytes,6,rep,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

An XPlane is a container of parallel timelines (XLines), generated by a profiling source or by post-processing one or more XPlanes. Next ID: 7

func (*XPlane) Descriptor deprecated 

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

Deprecated: Use XPlane.ProtoReflect.Descriptor instead.

func (*XPlane) GetEventMetadata 

func (x *XPlane) GetEventMetadata() map[int64]*XEventMetadata

func (*XPlane) GetId 

func (x *XPlane) GetId() int64

func (*XPlane) GetLines 

func (x *XPlane) GetLines() []*XLine

func (*XPlane) GetName 

func (x *XPlane) GetName() string

func (*XPlane) GetStatMetadata 

func (x *XPlane) GetStatMetadata() map[int64]*XStatMetadata

func (*XPlane) GetStats 

func (x *XPlane) GetStats() []*XStat

func (*XPlane) ProtoMessage 

func (*XPlane) ProtoMessage()

func (*XPlane) ProtoReflect 

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

func (*XPlane) Reset 

func (x *XPlane) Reset()

func (*XPlane) String 

func (x *XPlane) String() string

type XSpace 

type XSpace struct {
	Planes []*XPlane `protobuf:"bytes,1,rep,name=planes,proto3" json:"planes,omitempty"`
	// Errors (if any) in the generation of planes.
	Errors []string `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// Warnings (if any) in the generation of planes;
	Warnings []string `protobuf:"bytes,3,rep,name=warnings,proto3" json:"warnings,omitempty"`
	// List of hostnames that XPlanes are generated from.
	Hostnames []string `protobuf:"bytes,4,rep,name=hostnames,proto3" json:"hostnames,omitempty"`
	// contains filtered or unexported fields
}

A container of parallel XPlanes, generated by one or more profiling sources. Next ID: 5

func (*XSpace) Descriptor deprecated 

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

Deprecated: Use XSpace.ProtoReflect.Descriptor instead.

func (*XSpace) GetErrors 

func (x *XSpace) GetErrors() []string

func (*XSpace) GetHostnames 

func (x *XSpace) GetHostnames() []string

func (*XSpace) GetPlanes 

func (x *XSpace) GetPlanes() []*XPlane

func (*XSpace) GetWarnings 

func (x *XSpace) GetWarnings() []string

func (*XSpace) ProtoMessage 

func (*XSpace) ProtoMessage()

func (*XSpace) ProtoReflect 

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

func (*XSpace) Reset 

func (x *XSpace) Reset()

func (*XSpace) String 

func (x *XSpace) String() string

type XStat 

type XStat struct {

	// XStatMetadata.id of corresponding metadata.
	MetadataId int64 `protobuf:"varint,1,opt,name=metadata_id,json=metadataId,proto3" json:"metadata_id,omitempty"`
	// Value of this stat.
	//
	// Types that are assignable to Value:
	//
	//	*XStat_DoubleValue
	//	*XStat_Uint64Value
	//	*XStat_Int64Value
	//	*XStat_StrValue
	//	*XStat_BytesValue
	//	*XStat_RefValue
	Value isXStat_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

An XStat is a named value associated with an XEvent, e.g., a performance counter value, a metric computed by a formula applied over nested XEvents and XStats. Next ID: 8

func (*XStat) Descriptor deprecated 

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

Deprecated: Use XStat.ProtoReflect.Descriptor instead.

func (*XStat) GetBytesValue 

func (x *XStat) GetBytesValue() []byte

func (*XStat) GetDoubleValue 

func (x *XStat) GetDoubleValue() float64

func (*XStat) GetInt64Value 

func (x *XStat) GetInt64Value() int64

func (*XStat) GetMetadataId 

func (x *XStat) GetMetadataId() int64

func (*XStat) GetRefValue 

func (x *XStat) GetRefValue() uint64

func (*XStat) GetStrValue 

func (x *XStat) GetStrValue() string

func (*XStat) GetUint64Value 

func (x *XStat) GetUint64Value() uint64

func (*XStat) GetValue 

func (m *XStat) GetValue() isXStat_Value

func (*XStat) ProtoMessage 

func (*XStat) ProtoMessage()

func (*XStat) ProtoReflect 

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

func (*XStat) Reset 

func (x *XStat) Reset()

func (*XStat) String 

func (x *XStat) String() string

type XStatMetadata 

type XStatMetadata struct {

	// XPlane.stat_metadata map key.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the stat (should be short).
	// Two XStatMetadata with different id should have different names.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the stat (might be long).
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Metadata for an XStat, corresponds to a stat type and is shared by all XStats with the same metadata_id. Next ID: 4

func (*XStatMetadata) Descriptor deprecated 

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

Deprecated: Use XStatMetadata.ProtoReflect.Descriptor instead.

func (*XStatMetadata) GetDescription 

func (x *XStatMetadata) GetDescription() string

func (*XStatMetadata) GetId 

func (x *XStatMetadata) GetId() int64

func (*XStatMetadata) GetName 

func (x *XStatMetadata) GetName() string

func (*XStatMetadata) ProtoMessage 

func (*XStatMetadata) ProtoMessage()

func (*XStatMetadata) ProtoReflect 

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

func (*XStatMetadata) Reset 

func (x *XStatMetadata) Reset()

func (*XStatMetadata) String 

func (x *XStatMetadata) String() string

type XStat_BytesValue 

type XStat_BytesValue struct {
	BytesValue []byte `protobuf:"bytes,6,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type XStat_DoubleValue 

type XStat_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type XStat_Int64Value 

type XStat_Int64Value struct {
	Int64Value int64 `protobuf:"varint,4,opt,name=int64_value,json=int64Value,proto3,oneof"`
}

type XStat_RefValue 

type XStat_RefValue struct {
	// A string value that stored in XStatMetadata::name.
	RefValue uint64 `protobuf:"varint,7,opt,name=ref_value,json=refValue,proto3,oneof"`
}

type XStat_StrValue 

type XStat_StrValue struct {
	StrValue string `protobuf:"bytes,5,opt,name=str_value,json=strValue,proto3,oneof"`
}

type XStat_Uint64Value 

type XStat_Uint64Value struct {
	Uint64Value uint64 `protobuf:"varint,3,opt,name=uint64_value,json=uint64Value,proto3,oneof"`
}

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.