healthzdata

package
v0.0.0-...-a8d7af0 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_healthzdata_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BashCommand 

type BashCommand struct {
	Command string `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
	// data is a .tar.gz archive containing any output from
	// running the bash command on the system
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

A BashCommand datapoint captures information from running some bash command on the system.

func (*BashCommand) Descriptor deprecated 

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

Deprecated: Use BashCommand.ProtoReflect.Descriptor instead.

func (*BashCommand) GetCommand 

func (x *BashCommand) GetCommand() string

func (*BashCommand) GetData 

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

func (*BashCommand) ProtoMessage 

func (*BashCommand) ProtoMessage()

func (*BashCommand) ProtoReflect 

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

func (*BashCommand) Reset 

func (x *BashCommand) Reset()

func (*BashCommand) String 

func (x *BashCommand) String() string

type HealthzData 

type HealthzData struct {

	// healthzdata.proto version number
	Version uint32 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// data points collected for a component
	DataPoints []*HealthzDataPoint `protobuf:"bytes,2,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// contains filtered or unexported fields
}

A HealthzData message is returned in the GNOI Healthz RPC, to satisfy the ComponentStatus.healthz field, which is described as: ``` Opaque data for how the healthcheck is implemented. This can be any proto defined by the vendor. This could be the equivalent to outputs like "show tech" or core files or any other diagnostic data. ``` The size of the message may be large. Ensure that the client is configured to receive large message sizes.

func (*HealthzData) Descriptor deprecated 

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

Deprecated: Use HealthzData.ProtoReflect.Descriptor instead.

func (*HealthzData) GetDataPoints 

func (x *HealthzData) GetDataPoints() []*HealthzDataPoint

func (*HealthzData) GetVersion 

func (x *HealthzData) GetVersion() uint32

func (*HealthzData) ProtoMessage 

func (*HealthzData) ProtoMessage()

func (*HealthzData) ProtoReflect 

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

func (*HealthzData) Reset 

func (x *HealthzData) Reset()

func (*HealthzData) String 

func (x *HealthzData) String() string

type HealthzDataPoint 

type HealthzDataPoint struct {

	// Types that are assignable to Datapoint:
	//
	//	*HealthzDataPoint_ShowCommand
	//	*HealthzDataPoint_SupportScript
	//	*HealthzDataPoint_Logs
	//	*HealthzDataPoint_BashCommand
	Datapoint isHealthzDataPoint_Datapoint `protobuf_oneof:"datapoint"`
	// contains filtered or unexported fields
}

A HealthzDataPoint represents data from one source that relates to a component. For example, the data relating to one 'show' command. If multiple sources are being used to collect data, each one will be captured in its own datapoint.

func (*HealthzDataPoint) Descriptor deprecated 

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

Deprecated: Use HealthzDataPoint.ProtoReflect.Descriptor instead.

func (*HealthzDataPoint) GetBashCommand 

func (x *HealthzDataPoint) GetBashCommand() *BashCommand

func (*HealthzDataPoint) GetDatapoint 

func (m *HealthzDataPoint) GetDatapoint() isHealthzDataPoint_Datapoint

func (*HealthzDataPoint) GetLogs 

func (x *HealthzDataPoint) GetLogs() *Logs

func (*HealthzDataPoint) GetShowCommand 

func (x *HealthzDataPoint) GetShowCommand() *ShowCommand

func (*HealthzDataPoint) GetSupportScript 

func (x *HealthzDataPoint) GetSupportScript() *SupportScript

func (*HealthzDataPoint) ProtoMessage 

func (*HealthzDataPoint) ProtoMessage()

func (*HealthzDataPoint) ProtoReflect 

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

func (*HealthzDataPoint) Reset 

func (x *HealthzDataPoint) Reset()

func (*HealthzDataPoint) String 

func (x *HealthzDataPoint) String() string

type HealthzDataPoint_BashCommand 

type HealthzDataPoint_BashCommand struct {
	BashCommand *BashCommand `protobuf:"bytes,4,opt,name=bash_command,json=bashCommand,proto3,oneof"`
}

type HealthzDataPoint_Logs 

type HealthzDataPoint_Logs struct {
	Logs *Logs `protobuf:"bytes,3,opt,name=logs,proto3,oneof"`
}

type HealthzDataPoint_ShowCommand 

type HealthzDataPoint_ShowCommand struct {
	ShowCommand *ShowCommand `protobuf:"bytes,1,opt,name=show_command,json=showCommand,proto3,oneof"`
}

type HealthzDataPoint_SupportScript 

type HealthzDataPoint_SupportScript struct {
	SupportScript *SupportScript `protobuf:"bytes,2,opt,name=support_script,json=supportScript,proto3,oneof"`
}

type Logs 

type Logs struct {
	LogsDescription string `protobuf:"bytes,1,opt,name=logs_description,json=logsDescription,proto3" json:"logs_description,omitempty"`
	// data is a .tar.gz archive containing log file(s)
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Logs datapoint captures information from one or more log files on the system.

func (*Logs) Descriptor deprecated 

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

Deprecated: Use Logs.ProtoReflect.Descriptor instead.

func (*Logs) GetData 

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

func (*Logs) GetLogsDescription 

func (x *Logs) GetLogsDescription() string

func (*Logs) ProtoMessage 

func (*Logs) ProtoMessage()

func (*Logs) ProtoReflect 

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

func (*Logs) Reset 

func (x *Logs) Reset()

func (*Logs) String 

func (x *Logs) String() string

type ShowCommand 

type ShowCommand struct {
	ShowCommand string `protobuf:"bytes,1,opt,name=show_command,json=showCommand,proto3" json:"show_command,omitempty"`
	// data is a .tar.gz archive containing
	// a JSON or text file with show command output
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

A ShowCommand datapoint captures information from running a CLI show command on the system

func (*ShowCommand) Descriptor deprecated 

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

Deprecated: Use ShowCommand.ProtoReflect.Descriptor instead.

func (*ShowCommand) GetData 

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

func (*ShowCommand) GetShowCommand 

func (x *ShowCommand) GetShowCommand() string

func (*ShowCommand) ProtoMessage 

func (*ShowCommand) ProtoMessage()

func (*ShowCommand) ProtoReflect 

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

func (*ShowCommand) Reset 

func (x *ShowCommand) Reset()

func (*ShowCommand) String 

func (x *ShowCommand) String() string

type SupportScript 

type SupportScript struct {
	ScriptName string `protobuf:"bytes,1,opt,name=script_name,json=scriptName,proto3" json:"script_name,omitempty"`
	// data is a .tar.gz archive containing file(s)
	// generated by the support script
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

A SupportScript datapoint captures information from running an existing support script on the system.

func (*SupportScript) Descriptor deprecated 

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

Deprecated: Use SupportScript.ProtoReflect.Descriptor instead.

func (*SupportScript) GetData 

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

func (*SupportScript) GetScriptName 

func (x *SupportScript) GetScriptName() string

func (*SupportScript) ProtoMessage 

func (*SupportScript) ProtoMessage()

func (*SupportScript) ProtoReflect 

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

func (*SupportScript) Reset 

func (x *SupportScript) Reset()

func (*SupportScript) String 

func (x *SupportScript) 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.