metrics

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CompilationLogEntry_CompilationStage_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "END_TO_END",
		2: "HLO_PASSES",
		3: "CODE_GENERATION",
		4: "BACKEND_PASSES",
	}
	CompilationLogEntry_CompilationStage_value = map[string]int32{
		"UNSPECIFIED":     0,
		"END_TO_END":      1,
		"HLO_PASSES":      2,
		"CODE_GENERATION": 3,
		"BACKEND_PASSES":  4,
	}
)

Enum value maps for CompilationLogEntry_CompilationStage.

View Source 
var File_xla_service_metrics_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CompilationLogEntry 

type CompilationLogEntry struct {

	// Time when the event captured by this log entry occurred.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Compilation stage recorded by this log entry.
	Stage CompilationLogEntry_CompilationStage `protobuf:"varint,2,opt,name=stage,proto3,enum=xla.CompilationLogEntry_CompilationStage" json:"stage,omitempty"`
	// Duration of the given compilation stage.
	Duration *durationpb.Duration `protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
	// Task index from which this log entry was recorded or
	// -1 if the task index could not be fetched. In the case task_index is not
	// equal to -1, it is guaranteed to match the task_id in job_info.
	TaskIndex int32 `protobuf:"varint,4,opt,name=task_index,json=taskIndex,proto3" json:"task_index,omitempty"`
	// Pass specific metrics.
	PassMetrics []*PassMetrics `protobuf:"bytes,5,rep,name=pass_metrics,json=passMetrics,proto3" json:"pass_metrics,omitempty"`
	// IDs of modules on which the compilation stage was run.
	ModuleIds []uint64 `protobuf:"varint,6,rep,packed,name=module_ids,json=moduleIds,proto3" json:"module_ids,omitempty"`
	// Job information.
	JobInfo *JobInfo `protobuf:"bytes,7,opt,name=job_info,json=jobInfo,proto3" json:"job_info,omitempty"`
	// contains filtered or unexported fields
}

Defines XLA compilation metrics.

func (*CompilationLogEntry) Descriptor deprecated 

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

Deprecated: Use CompilationLogEntry.ProtoReflect.Descriptor instead.

func (*CompilationLogEntry) GetDuration 

func (x *CompilationLogEntry) GetDuration() *durationpb.Duration

func (*CompilationLogEntry) GetJobInfo 

func (x *CompilationLogEntry) GetJobInfo() *JobInfo

func (*CompilationLogEntry) GetModuleIds 

func (x *CompilationLogEntry) GetModuleIds() []uint64

func (*CompilationLogEntry) GetPassMetrics 

func (x *CompilationLogEntry) GetPassMetrics() []*PassMetrics

func (*CompilationLogEntry) GetStage 

func (x *CompilationLogEntry) GetStage() CompilationLogEntry_CompilationStage

func (*CompilationLogEntry) GetTaskIndex 

func (x *CompilationLogEntry) GetTaskIndex() int32

func (*CompilationLogEntry) GetTimestamp 

func (x *CompilationLogEntry) GetTimestamp() *timestamppb.Timestamp

func (*CompilationLogEntry) ProtoMessage 

func (*CompilationLogEntry) ProtoMessage()

func (*CompilationLogEntry) ProtoReflect 

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

func (*CompilationLogEntry) Reset 

func (x *CompilationLogEntry) Reset()

func (*CompilationLogEntry) String 

func (x *CompilationLogEntry) String() string

type CompilationLogEntry_CompilationStage 

type CompilationLogEntry_CompilationStage int32

Defines compilation stages for which metrics are collected. 

const (
	CompilationLogEntry_UNSPECIFIED     CompilationLogEntry_CompilationStage = 0
	CompilationLogEntry_END_TO_END      CompilationLogEntry_CompilationStage = 1
	CompilationLogEntry_HLO_PASSES      CompilationLogEntry_CompilationStage = 2
	CompilationLogEntry_CODE_GENERATION CompilationLogEntry_CompilationStage = 3
	CompilationLogEntry_BACKEND_PASSES  CompilationLogEntry_CompilationStage = 4
)

func (CompilationLogEntry_CompilationStage) Descriptor 

func (CompilationLogEntry_CompilationStage) Descriptor() protoreflect.EnumDescriptor

func (CompilationLogEntry_CompilationStage) Enum 

func (x CompilationLogEntry_CompilationStage) Enum() *CompilationLogEntry_CompilationStage

func (CompilationLogEntry_CompilationStage) EnumDescriptor deprecated 

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

Deprecated: Use CompilationLogEntry_CompilationStage.Descriptor instead.

func (CompilationLogEntry_CompilationStage) Number 

func (x CompilationLogEntry_CompilationStage) Number() protoreflect.EnumNumber

func (CompilationLogEntry_CompilationStage) String 

func (x CompilationLogEntry_CompilationStage) String() string

func (CompilationLogEntry_CompilationStage) Type 

func (CompilationLogEntry_CompilationStage) Type() protoreflect.EnumType

type JobInfo 

type JobInfo struct {

	// Name of the job running compilation.
	Name *string `protobuf:"bytes,1,opt,name=name,proto3,oneof" json:"name,omitempty"`
	// Cell in which the job is running.
	Cell *string `protobuf:"bytes,2,opt,name=cell,proto3,oneof" json:"cell,omitempty"`
	// User running the job.
	User *string `protobuf:"bytes,3,opt,name=user,proto3,oneof" json:"user,omitempty"`
	// Unique id when combined with user and cell field.
	Uid *int64 `protobuf:"varint,4,opt,name=uid,proto3,oneof" json:"uid,omitempty"`
	// Task index, which will not change across job restarts.
	TaskId *int64 `protobuf:"varint,5,opt,name=task_id,json=taskId,proto3,oneof" json:"task_id,omitempty"`
	// Task unique id, which may change across job restarts.
	TaskUid *int64 `protobuf:"varint,6,opt,name=task_uid,json=taskUid,proto3,oneof" json:"task_uid,omitempty"`
	// contains filtered or unexported fields
}

Defines compilation job information.

func (*JobInfo) Descriptor deprecated 

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

Deprecated: Use JobInfo.ProtoReflect.Descriptor instead.

func (*JobInfo) GetCell 

func (x *JobInfo) GetCell() string

func (*JobInfo) GetName 

func (x *JobInfo) GetName() string

func (*JobInfo) GetTaskId 

func (x *JobInfo) GetTaskId() int64

func (*JobInfo) GetTaskUid 

func (x *JobInfo) GetTaskUid() int64

func (*JobInfo) GetUid 

func (x *JobInfo) GetUid() int64

func (*JobInfo) GetUser 

func (x *JobInfo) GetUser() string

func (*JobInfo) ProtoMessage 

func (*JobInfo) ProtoMessage()

func (*JobInfo) ProtoReflect 

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

func (*JobInfo) Reset 

func (x *JobInfo) Reset()

func (*JobInfo) String 

func (x *JobInfo) String() string

type KeyValueMetric 

type KeyValueMetric struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value int64  `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Defines generic pass stats.

func (*KeyValueMetric) Descriptor deprecated 

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

Deprecated: Use KeyValueMetric.ProtoReflect.Descriptor instead.

func (*KeyValueMetric) GetKey 

func (x *KeyValueMetric) GetKey() string

func (*KeyValueMetric) GetValue 

func (x *KeyValueMetric) GetValue() int64

func (*KeyValueMetric) ProtoMessage 

func (*KeyValueMetric) ProtoMessage()

func (*KeyValueMetric) ProtoReflect 

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

func (*KeyValueMetric) Reset 

func (x *KeyValueMetric) Reset()

func (*KeyValueMetric) String 

func (x *KeyValueMetric) String() string

type PassMetrics 

type PassMetrics struct {

	// Unique ID of the module on which the pass was run.
	ModuleId uint64 `protobuf:"varint,1,opt,name=module_id,json=moduleId,proto3" json:"module_id,omitempty"`
	// The name of the pass.
	PassName string `protobuf:"bytes,2,opt,name=pass_name,json=passName,proto3" json:"pass_name,omitempty"`
	// Duration of the pass.
	PassDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=pass_duration,json=passDuration,proto3" json:"pass_duration,omitempty"`
	// Custom pass metrics. Used for cases where a more complex structure
	// is needed than a simple key - value pair (via generic metric).
	// This is kept opaque, via `google.protobuf.Any`, in order to
	// decouple pass agnostic compilation logs from possibly proprietary compiler
	// passes.
	CustomMetrics *anypb.Any `protobuf:"bytes,4,opt,name=custom_metrics,json=customMetrics,proto3" json:"custom_metrics,omitempty"`
	// Used to log any number of generic metrics per pass.
	// Encapsulates simple metrics regarding a pass via a key - value pair.
	// For more complex metrics for a pass, see custom_metric above.
	KvMetrics []*KeyValueMetric `protobuf:"bytes,5,rep,name=kv_metrics,json=kvMetrics,proto3" json:"kv_metrics,omitempty"`
	// contains filtered or unexported fields
}

Defines pass specific metrics.

func (*PassMetrics) Descriptor deprecated 

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

Deprecated: Use PassMetrics.ProtoReflect.Descriptor instead.

func (*PassMetrics) GetCustomMetrics 

func (x *PassMetrics) GetCustomMetrics() *anypb.Any

func (*PassMetrics) GetKvMetrics 

func (x *PassMetrics) GetKvMetrics() []*KeyValueMetric

func (*PassMetrics) GetModuleId 

func (x *PassMetrics) GetModuleId() uint64

func (*PassMetrics) GetPassDuration 

func (x *PassMetrics) GetPassDuration() *durationpb.Duration

func (*PassMetrics) GetPassName 

func (x *PassMetrics) GetPassName() string

func (*PassMetrics) ProtoMessage 

func (*PassMetrics) ProtoMessage()

func (*PassMetrics) ProtoReflect 

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

func (*PassMetrics) Reset 

func (x *PassMetrics) Reset()

func (*PassMetrics) String 

func (x *PassMetrics) String() string

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.