monitoring

package
v3.18.4 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	EntityState_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "HEALTHY",
		2: "REMOVED",
		3: "PENDING",
		4: "TERMINATING",
		5: "UNHEALTHY",
		6: "RESTARTING",
	}
	EntityState_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"HEALTHY":            1,
		"REMOVED":            2,
		"PENDING":            3,
		"TERMINATING":        4,
		"UNHEALTHY":          5,
		"RESTARTING":         6,
	}
)

Enum value maps for EntityState_Status.

View Source
var (
	EntityState_EntityType_name = map[int32]string{
		0: "ENTITY_TYPE_UNSPECIFIED",
		1: "BATCH_JOB",
		2: "STREAM",
		3: "BATCH_EXPORTER",
		4: "DATA_CONNECTOR",
		5: "KAFKA_EXPORTER",
	}
	EntityState_EntityType_value = map[string]int32{
		"ENTITY_TYPE_UNSPECIFIED": 0,
		"BATCH_JOB":               1,
		"STREAM":                  2,
		"BATCH_EXPORTER":          3,
		"DATA_CONNECTOR":          4,
		"KAFKA_EXPORTER":          5,
	}
)

Enum value maps for EntityState_EntityType.

View Source
var (
	EntityState_ResourceType_name = map[int32]string{
		0:   "RESOURCE_TYPE_UNSPECIFIED",
		100: "BATCH_JOB_JOB",
		101: "BATCH_JOB_SECRET",
		102: "BATCH_JOB_CONFIG_MAP",
		120: "STREAM_TOPIC",
		121: "STREAM_ENCRYPTION_KEYS_TOPIC",
		122: "STREAM_DECRYPTER_DEPLOYMENT",
		123: "STREAM_DECRYPTER_CONFIG_MAP",
		140: "BATCH_EXPORTER_DEPLOYMENT",
		141: "BATCH_EXPORTER_SECRET",
		150: "DATA_CONNECTOR_SECRET",
		160: "KAFKA_EXPORTER_DEPLOYMENT",
	}
	EntityState_ResourceType_value = map[string]int32{
		"RESOURCE_TYPE_UNSPECIFIED":    0,
		"BATCH_JOB_JOB":                100,
		"BATCH_JOB_SECRET":             101,
		"BATCH_JOB_CONFIG_MAP":         102,
		"STREAM_TOPIC":                 120,
		"STREAM_ENCRYPTION_KEYS_TOPIC": 121,
		"STREAM_DECRYPTER_DEPLOYMENT":  122,
		"STREAM_DECRYPTER_CONFIG_MAP":  123,
		"BATCH_EXPORTER_DEPLOYMENT":    140,
		"BATCH_EXPORTER_SECRET":        141,
		"DATA_CONNECTOR_SECRET":        150,
		"KAFKA_EXPORTER_DEPLOYMENT":    160,
	}
)

Enum value maps for EntityState_ResourceType.

View Source
var File_strmprivacy_api_monitoring_v1_monitoring_proto protoreflect.FileDescriptor
View Source
var MonitoringService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "strmprivacy.api.monitoring.v1.MonitoringService",
	HandlerType: (*MonitoringServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetLatestEntityStates",
			Handler:    _MonitoringService_GetLatestEntityStates_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "GetEntityState",
			Handler:       _MonitoringService_GetEntityState_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "UpdateEntityStates",
			Handler:       _MonitoringService_UpdateEntityStates_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "strmprivacy/api/monitoring/v1/monitoring.proto",
}

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

Functions

func RegisterMonitoringServiceServer

func RegisterMonitoringServiceServer(s grpc.ServiceRegistrar, srv MonitoringServiceServer)

Types

type EntityState

type EntityState struct {
	StateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=state_time,json=stateTime,proto3" json:"state_time,omitempty"`
	Ref       *EntityState_Ref       `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// also used to indicate that the entity is being removed.
	Status EntityState_Status `protobuf:"varint,3,opt,name=status,proto3,enum=strmprivacy.api.monitoring.v1.EntityState_Status" json:"status,omitempty"`
	// generic status message, often empty, meant for resources that are not necessarily Kubernetes pods
	Message string `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`
	// logging in case the entity is unhealthy
	Logs         []string                 `protobuf:"bytes,5,rep,name=logs,proto3" json:"logs,omitempty"`
	ResourceType EntityState_ResourceType `` /* 158-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EntityState) Descriptor deprecated

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

Deprecated: Use EntityState.ProtoReflect.Descriptor instead.

func (*EntityState) GetLogs

func (x *EntityState) GetLogs() []string

func (*EntityState) GetMessage

func (x *EntityState) GetMessage() string

func (*EntityState) GetRef

func (x *EntityState) GetRef() *EntityState_Ref

func (*EntityState) GetResourceType

func (x *EntityState) GetResourceType() EntityState_ResourceType

func (*EntityState) GetStateTime

func (x *EntityState) GetStateTime() *timestamppb.Timestamp

func (*EntityState) GetStatus

func (x *EntityState) GetStatus() EntityState_Status

func (*EntityState) ProtoMessage

func (*EntityState) ProtoMessage()

func (*EntityState) ProtoReflect

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

func (*EntityState) Reset

func (x *EntityState) Reset()

func (*EntityState) String

func (x *EntityState) String() string

type EntityState_EntityType

type EntityState_EntityType int32

what kind of entity category or instance are we dealing with

const (
	EntityState_ENTITY_TYPE_UNSPECIFIED EntityState_EntityType = 0
	EntityState_BATCH_JOB               EntityState_EntityType = 1
	EntityState_STREAM                  EntityState_EntityType = 2
	EntityState_BATCH_EXPORTER          EntityState_EntityType = 3
	EntityState_DATA_CONNECTOR          EntityState_EntityType = 4
	EntityState_KAFKA_EXPORTER          EntityState_EntityType = 5
)

func (EntityState_EntityType) Descriptor

func (EntityState_EntityType) Enum

func (EntityState_EntityType) EnumDescriptor deprecated

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

Deprecated: Use EntityState_EntityType.Descriptor instead.

func (EntityState_EntityType) Number

func (EntityState_EntityType) String

func (x EntityState_EntityType) String() string

func (EntityState_EntityType) Type

type EntityState_Ref

type EntityState_Ref struct {
	Type      EntityState_EntityType `protobuf:"varint,1,opt,name=type,proto3,enum=strmprivacy.api.monitoring.v1.EntityState_EntityType" json:"type,omitempty"`
	ProjectId string                 `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	Name      string                 `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

a unique reference to the entity

func (*EntityState_Ref) Descriptor deprecated

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

Deprecated: Use EntityState_Ref.ProtoReflect.Descriptor instead.

func (*EntityState_Ref) GetName

func (x *EntityState_Ref) GetName() string

func (*EntityState_Ref) GetProjectId

func (x *EntityState_Ref) GetProjectId() string

func (*EntityState_Ref) GetType

func (*EntityState_Ref) ProtoMessage

func (*EntityState_Ref) ProtoMessage()

func (*EntityState_Ref) ProtoReflect

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

func (*EntityState_Ref) Reset

func (x *EntityState_Ref) Reset()

func (*EntityState_Ref) String

func (x *EntityState_Ref) String() string

type EntityState_ResourceType

type EntityState_ResourceType int32
const (
	EntityState_RESOURCE_TYPE_UNSPECIFIED    EntityState_ResourceType = 0
	EntityState_BATCH_JOB_JOB                EntityState_ResourceType = 100
	EntityState_BATCH_JOB_SECRET             EntityState_ResourceType = 101
	EntityState_BATCH_JOB_CONFIG_MAP         EntityState_ResourceType = 102
	EntityState_STREAM_TOPIC                 EntityState_ResourceType = 120
	EntityState_STREAM_ENCRYPTION_KEYS_TOPIC EntityState_ResourceType = 121
	EntityState_STREAM_DECRYPTER_DEPLOYMENT  EntityState_ResourceType = 122
	EntityState_STREAM_DECRYPTER_CONFIG_MAP  EntityState_ResourceType = 123
	EntityState_BATCH_EXPORTER_DEPLOYMENT    EntityState_ResourceType = 140
	EntityState_BATCH_EXPORTER_SECRET        EntityState_ResourceType = 141
	EntityState_DATA_CONNECTOR_SECRET        EntityState_ResourceType = 150
	EntityState_KAFKA_EXPORTER_DEPLOYMENT    EntityState_ResourceType = 160
)

func (EntityState_ResourceType) Descriptor

func (EntityState_ResourceType) Enum

func (EntityState_ResourceType) EnumDescriptor deprecated

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

Deprecated: Use EntityState_ResourceType.Descriptor instead.

func (EntityState_ResourceType) Number

func (EntityState_ResourceType) String

func (x EntityState_ResourceType) String() string

func (EntityState_ResourceType) Type

type EntityState_Status

type EntityState_Status int32

(-- api-linter: core::0216::synonyms=disabled

const (
	EntityState_STATUS_UNSPECIFIED EntityState_Status = 0
	EntityState_HEALTHY            EntityState_Status = 1
	EntityState_REMOVED            EntityState_Status = 2
	EntityState_PENDING            EntityState_Status = 3
	EntityState_TERMINATING        EntityState_Status = 4
	EntityState_UNHEALTHY          EntityState_Status = 5
	EntityState_RESTARTING         EntityState_Status = 6
)

func (EntityState_Status) Descriptor

func (EntityState_Status) Enum

func (EntityState_Status) EnumDescriptor deprecated

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

Deprecated: Use EntityState_Status.Descriptor instead.

func (EntityState_Status) Number

func (EntityState_Status) String

func (x EntityState_Status) String() string

func (EntityState_Status) Type

type GetEntityStateRequest

type GetEntityStateRequest struct {

	// Filter based on a specific entity ref (or partially based on the ref's fields)
	Ref *EntityState_Ref `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Filter based on a specific entity status
	Status EntityState_Status `protobuf:"varint,2,opt,name=status,proto3,enum=strmprivacy.api.monitoring.v1.EntityState_Status" json:"status,omitempty"`
	// Specify the fields that need to be part of the response. If left empty, all details will be returned.
	// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-masks-in-projections
	ProjectionMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=projection_mask,json=projectionMask,proto3" json:"projection_mask,omitempty"`
	// contains filtered or unexported fields
}

* Initial call returns every entity state that's relevant to the caller.

Subsequent streaming gives changes only.

func (*GetEntityStateRequest) Descriptor deprecated

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

Deprecated: Use GetEntityStateRequest.ProtoReflect.Descriptor instead.

func (*GetEntityStateRequest) GetProjectionMask

func (x *GetEntityStateRequest) GetProjectionMask() *fieldmaskpb.FieldMask

func (*GetEntityStateRequest) GetRef

func (*GetEntityStateRequest) GetStatus

func (*GetEntityStateRequest) ProtoMessage

func (*GetEntityStateRequest) ProtoMessage()

func (*GetEntityStateRequest) ProtoReflect

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

func (*GetEntityStateRequest) Reset

func (x *GetEntityStateRequest) Reset()

func (*GetEntityStateRequest) String

func (x *GetEntityStateRequest) String() string

type GetEntityStateResponse

type GetEntityStateResponse struct {
	State *EntityState `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEntityStateResponse) Descriptor deprecated

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

Deprecated: Use GetEntityStateResponse.ProtoReflect.Descriptor instead.

func (*GetEntityStateResponse) GetState

func (x *GetEntityStateResponse) GetState() *EntityState

func (*GetEntityStateResponse) ProtoMessage

func (*GetEntityStateResponse) ProtoMessage()

func (*GetEntityStateResponse) ProtoReflect

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

func (*GetEntityStateResponse) Reset

func (x *GetEntityStateResponse) Reset()

func (*GetEntityStateResponse) String

func (x *GetEntityStateResponse) String() string

type GetLatestEntityStatesRequest

type GetLatestEntityStatesRequest struct {

	// Filter based on a specific entity ref (or partially based on the ref's fields)
	Ref *EntityState_Ref `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Filter based on a specific entity status
	Status EntityState_Status `protobuf:"varint,2,opt,name=status,proto3,enum=strmprivacy.api.monitoring.v1.EntityState_Status" json:"status,omitempty"`
	// Specify the fields that need to be part of the response. If left empty, all details will be returned.
	// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-masks-in-projections
	ProjectionMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=projection_mask,json=projectionMask,proto3" json:"projection_mask,omitempty"`
	// contains filtered or unexported fields
}

* Returns the latest entity state that's relevant to the caller.

func (*GetLatestEntityStatesRequest) Descriptor deprecated

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

Deprecated: Use GetLatestEntityStatesRequest.ProtoReflect.Descriptor instead.

func (*GetLatestEntityStatesRequest) GetProjectionMask

func (x *GetLatestEntityStatesRequest) GetProjectionMask() *fieldmaskpb.FieldMask

func (*GetLatestEntityStatesRequest) GetRef

func (*GetLatestEntityStatesRequest) GetStatus

func (*GetLatestEntityStatesRequest) ProtoMessage

func (*GetLatestEntityStatesRequest) ProtoMessage()

func (*GetLatestEntityStatesRequest) ProtoReflect

func (*GetLatestEntityStatesRequest) Reset

func (x *GetLatestEntityStatesRequest) Reset()

func (*GetLatestEntityStatesRequest) String

type GetLatestEntityStatesResponse

type GetLatestEntityStatesResponse struct {
	State []*EntityState `protobuf:"bytes,1,rep,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLatestEntityStatesResponse) Descriptor deprecated

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

Deprecated: Use GetLatestEntityStatesResponse.ProtoReflect.Descriptor instead.

func (*GetLatestEntityStatesResponse) GetState

func (x *GetLatestEntityStatesResponse) GetState() []*EntityState

func (*GetLatestEntityStatesResponse) ProtoMessage

func (*GetLatestEntityStatesResponse) ProtoMessage()

func (*GetLatestEntityStatesResponse) ProtoReflect

func (*GetLatestEntityStatesResponse) Reset

func (x *GetLatestEntityStatesResponse) Reset()

func (*GetLatestEntityStatesResponse) String

type MonitoringServiceClient

type MonitoringServiceClient interface {
	// will be called by end users from the cli or console, to retrieve entity states
	// and indicate them to users.
	GetEntityState(ctx context.Context, in *GetEntityStateRequest, opts ...grpc.CallOption) (MonitoringService_GetEntityStateClient, error)
	// can be called via the CLI and the Console, to get the latest entity state for all entities included
	// in this request
	GetLatestEntityStates(ctx context.Context, in *GetLatestEntityStatesRequest, opts ...grpc.CallOption) (*GetLatestEntityStatesResponse, error)
	// will be called from entity agents so that they can send the entity states
	// of items they're responsible for to the monitoring service.
	UpdateEntityStates(ctx context.Context, opts ...grpc.CallOption) (MonitoringService_UpdateEntityStatesClient, error)
}

MonitoringServiceClient is the client API for MonitoringService service.

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

type MonitoringServiceServer

type MonitoringServiceServer interface {
	// will be called by end users from the cli or console, to retrieve entity states
	// and indicate them to users.
	GetEntityState(*GetEntityStateRequest, MonitoringService_GetEntityStateServer) error
	// can be called via the CLI and the Console, to get the latest entity state for all entities included
	// in this request
	GetLatestEntityStates(context.Context, *GetLatestEntityStatesRequest) (*GetLatestEntityStatesResponse, error)
	// will be called from entity agents so that they can send the entity states
	// of items they're responsible for to the monitoring service.
	UpdateEntityStates(MonitoringService_UpdateEntityStatesServer) error
}

MonitoringServiceServer is the server API for MonitoringService service. All implementations should embed UnimplementedMonitoringServiceServer for forward compatibility

type MonitoringService_GetEntityStateClient

type MonitoringService_GetEntityStateClient interface {
	Recv() (*GetEntityStateResponse, error)
	grpc.ClientStream
}

type MonitoringService_GetEntityStateServer

type MonitoringService_GetEntityStateServer interface {
	Send(*GetEntityStateResponse) error
	grpc.ServerStream
}

type MonitoringService_UpdateEntityStatesClient

type MonitoringService_UpdateEntityStatesClient interface {
	Send(*UpdateEntityStatesRequest) error
	CloseAndRecv() (*UpdateEntityStatesResponse, error)
	grpc.ClientStream
}

type MonitoringService_UpdateEntityStatesServer

type MonitoringService_UpdateEntityStatesServer interface {
	SendAndClose(*UpdateEntityStatesResponse) error
	Recv() (*UpdateEntityStatesRequest, error)
	grpc.ServerStream
}

type UnimplementedMonitoringServiceServer

type UnimplementedMonitoringServiceServer struct {
}

UnimplementedMonitoringServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedMonitoringServiceServer) UpdateEntityStates

type UnsafeMonitoringServiceServer

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

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

type UpdateEntityStatesRequest

type UpdateEntityStatesRequest struct {
	States []*EntityState `protobuf:"bytes,1,rep,name=states,proto3" json:"states,omitempty"`
	// contains filtered or unexported fields
}

Only when changes occur to resources, an entity state is sent (-- api-linter: core::0134::request-mask-required=disabled

func (*UpdateEntityStatesRequest) Descriptor deprecated

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

Deprecated: Use UpdateEntityStatesRequest.ProtoReflect.Descriptor instead.

func (*UpdateEntityStatesRequest) GetStates

func (x *UpdateEntityStatesRequest) GetStates() []*EntityState

func (*UpdateEntityStatesRequest) ProtoMessage

func (*UpdateEntityStatesRequest) ProtoMessage()

func (*UpdateEntityStatesRequest) ProtoReflect

func (*UpdateEntityStatesRequest) Reset

func (x *UpdateEntityStatesRequest) Reset()

func (*UpdateEntityStatesRequest) String

func (x *UpdateEntityStatesRequest) String() string

type UpdateEntityStatesResponse

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

func (*UpdateEntityStatesResponse) Descriptor deprecated

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

Deprecated: Use UpdateEntityStatesResponse.ProtoReflect.Descriptor instead.

func (*UpdateEntityStatesResponse) ProtoMessage

func (*UpdateEntityStatesResponse) ProtoMessage()

func (*UpdateEntityStatesResponse) ProtoReflect

func (*UpdateEntityStatesResponse) Reset

func (x *UpdateEntityStatesResponse) Reset()

func (*UpdateEntityStatesResponse) String

func (x *UpdateEntityStatesResponse) String() string

Jump to

Keyboard shortcuts

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