protocol

package
v0.82.1 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2019 License: MIT Imports: 15 Imported by: 36

Documentation

Overview

Package protocol defines the consumer datamodel, validation behaviors, and gRPC APIs which are shared across clients and consumer application servers. Datamodel types and APIs are implemented as generated protobuf messages and stubs, typically extended with additional parsing, validation, and shared implementation behaviors. A central goal of this package to be highly exacting in defining allowed "shapes" that types & messages may take (through implementations of the Validator interface), providing strong guarantees to consumers and clients that messages are well-formed without need for additional ad-hoc, repetitive checks (which often become a maintenance burden).

By convention, this package is usually imported as `pc`, short for "Protocol of Consumer", due to it's ubiquity and to distinguish it from package go.gazette.dev/core/broker/protocol (imported as `pb`). Eg,

import pc "go.gazette.dev/core/consumer/protocol"

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthProtocol = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowProtocol   = fmt.Errorf("proto: integer overflow")
)
View Source 
var ReplicaStatus_Code_name = map[int32]string{
	0:   "IDLE",
	100: "BACKFILL",
	200: "TAILING",
	300: "PRIMARY",
	400: "FAILED",
}
View Source 
var ReplicaStatus_Code_value = map[string]int32{
	"IDLE":     0,
	"BACKFILL": 100,
	"TAILING":  200,
	"PRIMARY":  300,
	"FAILED":   400,
}
View Source 
var Status_name = map[int32]string{
	0: "OK",
	1: "SHARD_NOT_FOUND",
	2: "NO_SHARD_PRIMARY",
	3: "NOT_SHARD_PRIMARY",
	4: "ETCD_TRANSACTION_FAILED",
}
View Source 
var Status_value = map[string]int32{
	"OK":                      0,
	"SHARD_NOT_FOUND":         1,
	"NO_SHARD_PRIMARY":        2,
	"NOT_SHARD_PRIMARY":       3,
	"ETCD_TRANSACTION_FAILED": 4,
}

Functions

func ExtractShardSpecMetaLabels 

func ExtractShardSpecMetaLabels(spec *ShardSpec, out pb.LabelSet) pb.LabelSet

ExtractShardSpecMetaLabels returns meta-labels of the ShardSpec, using |out| as a buffer.

func RegisterShardServer 

func RegisterShardServer(s *grpc.Server, srv ShardServer)

Types

type ApplyRequest 

type ApplyRequest struct {
	Changes []ApplyRequest_Change `protobuf:"bytes,1,rep,name=changes,proto3" json:"changes"`
}

func (*ApplyRequest) Descriptor 

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

func (*ApplyRequest) Marshal 

func (m *ApplyRequest) Marshal() (dAtA []byte, err error)

func (*ApplyRequest) MarshalTo 

func (m *ApplyRequest) MarshalTo(dAtA []byte) (int, error)

func (*ApplyRequest) ProtoMessage 

func (*ApplyRequest) ProtoMessage()

func (*ApplyRequest) ProtoSize 

func (m *ApplyRequest) ProtoSize() (n int)

func (*ApplyRequest) Reset 

func (m *ApplyRequest) Reset()

func (*ApplyRequest) String 

func (m *ApplyRequest) String() string

func (*ApplyRequest) Unmarshal 

func (m *ApplyRequest) Unmarshal(dAtA []byte) error

func (*ApplyRequest) Validate 

func (m *ApplyRequest) Validate() error

Validate returns an error if the ApplyRequest is not well-formed.

func (*ApplyRequest) XXX_DiscardUnknown 

func (m *ApplyRequest) XXX_DiscardUnknown()

func (*ApplyRequest) XXX_Marshal 

func (m *ApplyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ApplyRequest) XXX_Merge 

func (m *ApplyRequest) XXX_Merge(src proto.Message)

func (*ApplyRequest) XXX_Size 

func (m *ApplyRequest) XXX_Size() int

func (*ApplyRequest) XXX_Unmarshal 

func (m *ApplyRequest) XXX_Unmarshal(b []byte) error

type ApplyRequest_Change 

type ApplyRequest_Change struct {
	// Expected ModRevision of the current ShardSpec. If the shard is being
	// created, expect_mod_revision is zero.
	ExpectModRevision int64 `protobuf:"varint,1,opt,name=expect_mod_revision,json=expectModRevision,proto3" json:"expect_mod_revision,omitempty"`
	// ShardSpec to be updated (if expect_mod_revision > 0) or created
	// (if expect_mod_revision == 0).
	Upsert *ShardSpec `protobuf:"bytes,2,opt,name=upsert,proto3" json:"upsert,omitempty"`
	// Shard to be deleted. expect_mod_revision must not be zero.
	Delete ShardID `protobuf:"bytes,3,opt,name=delete,proto3,casttype=ShardID" json:"delete,omitempty"`
}

Change defines an insertion, update, or deletion to be applied to the set of ShardSpecs. Exactly one of |upsert| or |delete| must be set.

func (*ApplyRequest_Change) Descriptor 

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

func (*ApplyRequest_Change) Marshal 

func (m *ApplyRequest_Change) Marshal() (dAtA []byte, err error)

func (*ApplyRequest_Change) MarshalTo 

func (m *ApplyRequest_Change) MarshalTo(dAtA []byte) (int, error)

func (*ApplyRequest_Change) ProtoMessage 

func (*ApplyRequest_Change) ProtoMessage()

func (*ApplyRequest_Change) ProtoSize 

func (m *ApplyRequest_Change) ProtoSize() (n int)

func (*ApplyRequest_Change) Reset 

func (m *ApplyRequest_Change) Reset()

func (*ApplyRequest_Change) String 

func (m *ApplyRequest_Change) String() string

func (*ApplyRequest_Change) Unmarshal 

func (m *ApplyRequest_Change) Unmarshal(dAtA []byte) error

func (*ApplyRequest_Change) Validate 

func (m *ApplyRequest_Change) Validate() error

Validate returns an error if the ApplyRequest_Change is not well-formed.

func (*ApplyRequest_Change) XXX_DiscardUnknown 

func (m *ApplyRequest_Change) XXX_DiscardUnknown()

func (*ApplyRequest_Change) XXX_Marshal 

func (m *ApplyRequest_Change) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ApplyRequest_Change) XXX_Merge 

func (m *ApplyRequest_Change) XXX_Merge(src proto.Message)

func (*ApplyRequest_Change) XXX_Size 

func (m *ApplyRequest_Change) XXX_Size() int

func (*ApplyRequest_Change) XXX_Unmarshal 

func (m *ApplyRequest_Change) XXX_Unmarshal(b []byte) error

type ApplyResponse 

type ApplyResponse struct {
	// Status of the Apply RPC.
	Status Status `protobuf:"varint,1,opt,name=status,proto3,enum=consumer.Status" json:"status,omitempty"`
	// Header of the response.
	Header protocol.Header `protobuf:"bytes,2,opt,name=header,proto3" json:"header"`
}

func (*ApplyResponse) Descriptor 

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

func (*ApplyResponse) Marshal 

func (m *ApplyResponse) Marshal() (dAtA []byte, err error)

func (*ApplyResponse) MarshalTo 

func (m *ApplyResponse) MarshalTo(dAtA []byte) (int, error)

func (*ApplyResponse) ProtoMessage 

func (*ApplyResponse) ProtoMessage()

func (*ApplyResponse) ProtoSize 

func (m *ApplyResponse) ProtoSize() (n int)

func (*ApplyResponse) Reset 

func (m *ApplyResponse) Reset()

func (*ApplyResponse) String 

func (m *ApplyResponse) String() string

func (*ApplyResponse) Unmarshal 

func (m *ApplyResponse) Unmarshal(dAtA []byte) error

func (*ApplyResponse) Validate 

func (m *ApplyResponse) Validate() error

Validate returns an error if the ApplyResponse is not well-formed.

func (*ApplyResponse) XXX_DiscardUnknown 

func (m *ApplyResponse) XXX_DiscardUnknown()

func (*ApplyResponse) XXX_Marshal 

func (m *ApplyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ApplyResponse) XXX_Merge 

func (m *ApplyResponse) XXX_Merge(src proto.Message)

func (*ApplyResponse) XXX_Size 

func (m *ApplyResponse) XXX_Size() int

func (*ApplyResponse) XXX_Unmarshal 

func (m *ApplyResponse) XXX_Unmarshal(b []byte) error

type ConsumerSpec 

type ConsumerSpec struct {
	// ProcessSpec of the consumer.
	protocol.ProcessSpec `protobuf:"bytes,1,opt,name=process_spec,json=processSpec,proto3,embedded=process_spec" json:"process_spec" yaml:",inline"`
	// Maximum number of assigned Shards.
	ShardLimit uint32 `protobuf:"varint,2,opt,name=shard_limit,json=shardLimit,proto3" json:"shard_limit,omitempty"`
}

ConsumerSpec describes a Consumer process instance and its configuration. It serves as a allocator MemberValue.

func (*ConsumerSpec) Descriptor 

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

func (*ConsumerSpec) ItemLimit 

func (m *ConsumerSpec) ItemLimit() int

ItemLimit is the maximum number of shards this consumer may process. allocator.MemberValue implementation.

func (*ConsumerSpec) Marshal 

func (m *ConsumerSpec) Marshal() (dAtA []byte, err error)

func (*ConsumerSpec) MarshalString 

func (m *ConsumerSpec) MarshalString() string

MarshalString returns the marshaled encoding of the ConsumerSpec as a string.

func (*ConsumerSpec) MarshalTo 

func (m *ConsumerSpec) MarshalTo(dAtA []byte) (int, error)

func (*ConsumerSpec) ProtoMessage 

func (*ConsumerSpec) ProtoMessage()

func (*ConsumerSpec) ProtoSize 

func (m *ConsumerSpec) ProtoSize() (n int)

func (*ConsumerSpec) Reset 

func (m *ConsumerSpec) Reset()

func (*ConsumerSpec) String 

func (m *ConsumerSpec) String() string

func (*ConsumerSpec) Unmarshal 

func (m *ConsumerSpec) Unmarshal(dAtA []byte) error

func (*ConsumerSpec) Validate 

func (m *ConsumerSpec) Validate() error

Validate returns an error if the ConsumerSpec is not well-formed.

func (*ConsumerSpec) XXX_DiscardUnknown 

func (m *ConsumerSpec) XXX_DiscardUnknown()

func (*ConsumerSpec) XXX_Marshal 

func (m *ConsumerSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConsumerSpec) XXX_Merge 

func (m *ConsumerSpec) XXX_Merge(src proto.Message)

func (*ConsumerSpec) XXX_Size 

func (m *ConsumerSpec) XXX_Size() int

func (*ConsumerSpec) XXX_Unmarshal 

func (m *ConsumerSpec) XXX_Unmarshal(b []byte) error

func (*ConsumerSpec) ZeroLimit 

func (m *ConsumerSpec) ZeroLimit()

ZeroLimit zeros the ConsumerSpec ShardLimit.

type GetHintsRequest 

type GetHintsRequest struct {
	// Shard to fetch hints for.
	Shard ShardID `protobuf:"bytes,1,opt,name=shard,proto3,casttype=ShardID" json:"shard,omitempty"`
}

func (*GetHintsRequest) Descriptor 

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

func (*GetHintsRequest) Marshal 

func (m *GetHintsRequest) Marshal() (dAtA []byte, err error)

func (*GetHintsRequest) MarshalTo 

func (m *GetHintsRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetHintsRequest) ProtoMessage 

func (*GetHintsRequest) ProtoMessage()

func (*GetHintsRequest) ProtoSize 

func (m *GetHintsRequest) ProtoSize() (n int)

func (*GetHintsRequest) Reset 

func (m *GetHintsRequest) Reset()

func (*GetHintsRequest) String 

func (m *GetHintsRequest) String() string

func (*GetHintsRequest) Unmarshal 

func (m *GetHintsRequest) Unmarshal(dAtA []byte) error

func (*GetHintsRequest) Validate 

func (m *GetHintsRequest) Validate() error

Validate returns an error if the HintsRequest is not well-formed.

func (*GetHintsRequest) XXX_DiscardUnknown 

func (m *GetHintsRequest) XXX_DiscardUnknown()

func (*GetHintsRequest) XXX_Marshal 

func (m *GetHintsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetHintsRequest) XXX_Merge 

func (m *GetHintsRequest) XXX_Merge(src proto.Message)

func (*GetHintsRequest) XXX_Size 

func (m *GetHintsRequest) XXX_Size() int

func (*GetHintsRequest) XXX_Unmarshal 

func (m *GetHintsRequest) XXX_Unmarshal(b []byte) error

type GetHintsResponse 

type GetHintsResponse struct {
	// Status of the Hints RPC.
	Status Status `protobuf:"varint,1,opt,name=status,proto3,enum=consumer.Status" json:"status,omitempty"`
	// Header of the response.
	Header protocol.Header `protobuf:"bytes,2,opt,name=header,proto3" json:"header"`
	// Primary hints for the shard.
	PrimaryHints GetHintsResponse_ResponseHints `protobuf:"bytes,3,opt,name=primary_hints,json=primaryHints,proto3" json:"primary_hints"`
	// List of backup hints for a shard. The most recent recovery log hints will be
	// first, any subsequent hints are for historical backup. If there is no value
	// for a hint key the value corresponding hints will be nil.
	BackupHints []GetHintsResponse_ResponseHints `protobuf:"bytes,4,rep,name=backup_hints,json=backupHints,proto3" json:"backup_hints"`
}

func (*GetHintsResponse) Descriptor 

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

func (*GetHintsResponse) Marshal 

func (m *GetHintsResponse) Marshal() (dAtA []byte, err error)

func (*GetHintsResponse) MarshalTo 

func (m *GetHintsResponse) MarshalTo(dAtA []byte) (int, error)

func (*GetHintsResponse) ProtoMessage 

func (*GetHintsResponse) ProtoMessage()

func (*GetHintsResponse) ProtoSize 

func (m *GetHintsResponse) ProtoSize() (n int)

func (*GetHintsResponse) Reset 

func (m *GetHintsResponse) Reset()

func (*GetHintsResponse) String 

func (m *GetHintsResponse) String() string

func (*GetHintsResponse) Unmarshal 

func (m *GetHintsResponse) Unmarshal(dAtA []byte) error

func (*GetHintsResponse) Validate 

func (m *GetHintsResponse) Validate() error

Validate returns an error if the HintsResponse is not well-formed.

func (*GetHintsResponse) XXX_DiscardUnknown 

func (m *GetHintsResponse) XXX_DiscardUnknown()

func (*GetHintsResponse) XXX_Marshal 

func (m *GetHintsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetHintsResponse) XXX_Merge 

func (m *GetHintsResponse) XXX_Merge(src proto.Message)

func (*GetHintsResponse) XXX_Size 

func (m *GetHintsResponse) XXX_Size() int

func (*GetHintsResponse) XXX_Unmarshal 

func (m *GetHintsResponse) XXX_Unmarshal(b []byte) error

type GetHintsResponse_ResponseHints 

type GetHintsResponse_ResponseHints struct {
	// If the hints value does not exist Hints will be nil.
	Hints *recoverylog.FSMHints `protobuf:"bytes,1,opt,name=hints,proto3" json:"hints,omitempty"`
}

func (*GetHintsResponse_ResponseHints) Descriptor 

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

func (*GetHintsResponse_ResponseHints) Marshal 

func (m *GetHintsResponse_ResponseHints) Marshal() (dAtA []byte, err error)

func (*GetHintsResponse_ResponseHints) MarshalTo 

func (m *GetHintsResponse_ResponseHints) MarshalTo(dAtA []byte) (int, error)

func (*GetHintsResponse_ResponseHints) ProtoMessage 

func (*GetHintsResponse_ResponseHints) ProtoMessage()

func (*GetHintsResponse_ResponseHints) ProtoSize 

func (m *GetHintsResponse_ResponseHints) ProtoSize() (n int)

func (*GetHintsResponse_ResponseHints) Reset 

func (m *GetHintsResponse_ResponseHints) Reset()

func (*GetHintsResponse_ResponseHints) String 

func (m *GetHintsResponse_ResponseHints) String() string

func (*GetHintsResponse_ResponseHints) Unmarshal 

func (m *GetHintsResponse_ResponseHints) Unmarshal(dAtA []byte) error

func (GetHintsResponse_ResponseHints) Validate 

func (m GetHintsResponse_ResponseHints) Validate() error

Validate returns an error if the GetHintsResponse_ResponseHints is not well-formed.

func (*GetHintsResponse_ResponseHints) XXX_DiscardUnknown 

func (m *GetHintsResponse_ResponseHints) XXX_DiscardUnknown()

func (*GetHintsResponse_ResponseHints) XXX_Marshal 

func (m *GetHintsResponse_ResponseHints) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetHintsResponse_ResponseHints) XXX_Merge 

func (m *GetHintsResponse_ResponseHints) XXX_Merge(src proto.Message)

func (*GetHintsResponse_ResponseHints) XXX_Size 

func (m *GetHintsResponse_ResponseHints) XXX_Size() int

func (*GetHintsResponse_ResponseHints) XXX_Unmarshal 

func (m *GetHintsResponse_ResponseHints) XXX_Unmarshal(b []byte) error

type ListRequest 

type ListRequest struct {
	// Selector optionally refines the set of shards which will be enumerated.
	// If zero-valued, all shards are returned. Otherwise, only ShardSpecs
	// matching the LabelSelector will be returned. One meta-label "id" is
	// additionally supported by the selector, where "id=example-shard-ID"
	// will match a ShardSpec with ID "example-shard-ID".
	Selector protocol.LabelSelector `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector"`
}

func (*ListRequest) Descriptor 

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

func (*ListRequest) Marshal 

func (m *ListRequest) Marshal() (dAtA []byte, err error)

func (*ListRequest) MarshalTo 

func (m *ListRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoSize 

func (m *ListRequest) ProtoSize() (n int)

func (*ListRequest) Reset 

func (m *ListRequest) Reset()

func (*ListRequest) String 

func (m *ListRequest) String() string

func (*ListRequest) Unmarshal 

func (m *ListRequest) Unmarshal(dAtA []byte) error

func (*ListRequest) Validate 

func (m *ListRequest) Validate() error

Validate returns an error if the ListRequest is not well-formed.

func (*ListRequest) XXX_DiscardUnknown 

func (m *ListRequest) XXX_DiscardUnknown()

func (*ListRequest) XXX_Marshal 

func (m *ListRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListRequest) XXX_Merge 

func (m *ListRequest) XXX_Merge(src proto.Message)

func (*ListRequest) XXX_Size 

func (m *ListRequest) XXX_Size() int

func (*ListRequest) XXX_Unmarshal 

func (m *ListRequest) XXX_Unmarshal(b []byte) error

type ListResponse 

type ListResponse struct {
	// Status of the List RPC.
	Status Status `protobuf:"varint,1,opt,name=status,proto3,enum=consumer.Status" json:"status,omitempty"`
	// Header of the response.
	Header protocol.Header      `protobuf:"bytes,2,opt,name=header,proto3" json:"header"`
	Shards []ListResponse_Shard `protobuf:"bytes,3,rep,name=shards,proto3" json:"shards"`
}

func (*ListResponse) Descriptor 

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

func (*ListResponse) Marshal 

func (m *ListResponse) Marshal() (dAtA []byte, err error)

func (*ListResponse) MarshalTo 

func (m *ListResponse) MarshalTo(dAtA []byte) (int, error)

func (*ListResponse) ProtoMessage 

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoSize 

func (m *ListResponse) ProtoSize() (n int)

func (*ListResponse) Reset 

func (m *ListResponse) Reset()

func (*ListResponse) String 

func (m *ListResponse) String() string

func (*ListResponse) Unmarshal 

func (m *ListResponse) Unmarshal(dAtA []byte) error

func (*ListResponse) Validate 

func (m *ListResponse) Validate() error

Validate returns an error if the ListResponse is not well-formed.

func (*ListResponse) XXX_DiscardUnknown 

func (m *ListResponse) XXX_DiscardUnknown()

func (*ListResponse) XXX_Marshal 

func (m *ListResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListResponse) XXX_Merge 

func (m *ListResponse) XXX_Merge(src proto.Message)

func (*ListResponse) XXX_Size 

func (m *ListResponse) XXX_Size() int

func (*ListResponse) XXX_Unmarshal 

func (m *ListResponse) XXX_Unmarshal(b []byte) error

type ListResponse_Shard 

type ListResponse_Shard struct {
	Spec ShardSpec `protobuf:"bytes,1,opt,name=spec,proto3" json:"spec"`
	// Current ModRevision of the ShardSpec.
	ModRevision int64 `protobuf:"varint,2,opt,name=mod_revision,json=modRevision,proto3" json:"mod_revision,omitempty"`
	// Route of the shard, including endpoints.
	Route protocol.Route `protobuf:"bytes,3,opt,name=route,proto3" json:"route"`
	// Status of each replica. Cardinality and ordering matches |route|.
	Status []ReplicaStatus `protobuf:"bytes,4,rep,name=status,proto3" json:"status"`
}

Shards of the response.

func (*ListResponse_Shard) Descriptor 

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

func (*ListResponse_Shard) Marshal 

func (m *ListResponse_Shard) Marshal() (dAtA []byte, err error)

func (*ListResponse_Shard) MarshalTo 

func (m *ListResponse_Shard) MarshalTo(dAtA []byte) (int, error)

func (*ListResponse_Shard) ProtoMessage 

func (*ListResponse_Shard) ProtoMessage()

func (*ListResponse_Shard) ProtoSize 

func (m *ListResponse_Shard) ProtoSize() (n int)

func (*ListResponse_Shard) Reset 

func (m *ListResponse_Shard) Reset()

func (*ListResponse_Shard) String 

func (m *ListResponse_Shard) String() string

func (*ListResponse_Shard) Unmarshal 

func (m *ListResponse_Shard) Unmarshal(dAtA []byte) error

func (*ListResponse_Shard) Validate 

func (m *ListResponse_Shard) Validate() error

Validate returns an error if the ListResponse_Shard is not well-formed.

func (*ListResponse_Shard) XXX_DiscardUnknown 

func (m *ListResponse_Shard) XXX_DiscardUnknown()

func (*ListResponse_Shard) XXX_Marshal 

func (m *ListResponse_Shard) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListResponse_Shard) XXX_Merge 

func (m *ListResponse_Shard) XXX_Merge(src proto.Message)

func (*ListResponse_Shard) XXX_Size 

func (m *ListResponse_Shard) XXX_Size() int

func (*ListResponse_Shard) XXX_Unmarshal 

func (m *ListResponse_Shard) XXX_Unmarshal(b []byte) error

type ReplicaStatus 

type ReplicaStatus struct {
	Code ReplicaStatus_Code `protobuf:"varint,1,opt,name=code,proto3,enum=consumer.ReplicaStatus_Code" json:"code,omitempty"`
	// Errors encountered during replica processing. Set iff |code| is FAILED.
	Errors []string `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
}

ReplicaStatus is the status of a ShardSpec assigned to a ConsumerSpec. It serves as an allocator AssignmentValue. ReplicaStatus is reduced by taking the maximum enum value among statuses. Eg, if a primary is PRIMARY, one replica is BACKFILL and the other TAILING, then the status is PRIMARY. If one of the replicas transitioned to FAILED, than the status is FAILED. This reduction behavior is used to summarize status across all replicas.

func (*ReplicaStatus) Descriptor 

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

func (*ReplicaStatus) Marshal 

func (m *ReplicaStatus) Marshal() (dAtA []byte, err error)

func (*ReplicaStatus) MarshalString 

func (m *ReplicaStatus) MarshalString() string

MarshalString returns the marshaled encoding of the ReplicaStatus as a string.

func (*ReplicaStatus) MarshalTo 

func (m *ReplicaStatus) MarshalTo(dAtA []byte) (int, error)

func (*ReplicaStatus) ProtoMessage 

func (*ReplicaStatus) ProtoMessage()

func (*ReplicaStatus) ProtoSize 

func (m *ReplicaStatus) ProtoSize() (n int)

func (*ReplicaStatus) Reduce 

func (m *ReplicaStatus) Reduce(other *ReplicaStatus)

Reduce folds another ReplicaStatus into this one.

func (*ReplicaStatus) Reset 

func (m *ReplicaStatus) Reset()

func (*ReplicaStatus) String 

func (m *ReplicaStatus) String() string

func (*ReplicaStatus) Unmarshal 

func (m *ReplicaStatus) Unmarshal(dAtA []byte) error

func (*ReplicaStatus) Validate 

func (m *ReplicaStatus) Validate() error

Validate returns an error if the ReplicaStatus is not well-formed.

func (*ReplicaStatus) XXX_DiscardUnknown 

func (m *ReplicaStatus) XXX_DiscardUnknown()

func (*ReplicaStatus) XXX_Marshal 

func (m *ReplicaStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ReplicaStatus) XXX_Merge 

func (m *ReplicaStatus) XXX_Merge(src proto.Message)

func (*ReplicaStatus) XXX_Size 

func (m *ReplicaStatus) XXX_Size() int

func (*ReplicaStatus) XXX_Unmarshal 

func (m *ReplicaStatus) XXX_Unmarshal(b []byte) error

type ReplicaStatus_Code 

type ReplicaStatus_Code int32
const (
	ReplicaStatus_IDLE ReplicaStatus_Code = 0
	// The replica is actively playing the historical log.
	ReplicaStatus_BACKFILL ReplicaStatus_Code = 100
	// The replica has finished playing the historical log, and is tailing the
	// live log to locally mirror recorded operations as they are produced. It
	// is a "hot standby" and can take over as primary at any time.
	ReplicaStatus_TAILING ReplicaStatus_Code = 200
	// The replica is actively serving as primary.
	ReplicaStatus_PRIMARY ReplicaStatus_Code = 300
	// The replica has encountered an unrecoverable error.
	ReplicaStatus_FAILED ReplicaStatus_Code = 400
)

func (ReplicaStatus_Code) EnumDescriptor 

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

func (ReplicaStatus_Code) String 

func (x ReplicaStatus_Code) String() string

func (ReplicaStatus_Code) Validate 

func (x ReplicaStatus_Code) Validate() error

Validate returns an error if the ReplicaStatus_Code is not well-formed.

type RoutedShardClient 

type RoutedShardClient interface {
	ShardClient
	pb.DispatchRouter
}

RoutedShardClient composes a ShardClient and DispatchRouter.

func NewRoutedShardClient 

func NewRoutedShardClient(sc ShardClient, dr pb.DispatchRouter) RoutedShardClient

NewRoutedShardClient composes a ShardClient and DispatchRouter.

type ShardClient 

type ShardClient interface {
	// Stat returns detailed status of a given Shard.
	Stat(ctx context.Context, in *StatRequest, opts ...grpc.CallOption) (*StatResponse, error)
	// List Shards, their ShardSpecs and their processing status.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
	// Apply changes to the collection of Shards managed by the consumer.
	Apply(ctx context.Context, in *ApplyRequest, opts ...grpc.CallOption) (*ApplyResponse, error)
	// GetHints fetches hints for a shard.
	GetHints(ctx context.Context, in *GetHintsRequest, opts ...grpc.CallOption) (*GetHintsResponse, error)
}

ShardClient is the client API for Shard service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewShardClient 

func NewShardClient(cc *grpc.ClientConn) ShardClient

type ShardID 

type ShardID string

ShardID uniquely identifies a shard processed by a Gazette consumer.

func (ShardID) String 

func (id ShardID) String() string

String returns the Shard as a string.

func (ShardID) Validate 

func (id ShardID) Validate() error

Validate returns an error if the Shard is not well-formed.

type ShardServer 

type ShardServer interface {
	// Stat returns detailed status of a given Shard.
	Stat(context.Context, *StatRequest) (*StatResponse, error)
	// List Shards, their ShardSpecs and their processing status.
	List(context.Context, *ListRequest) (*ListResponse, error)
	// Apply changes to the collection of Shards managed by the consumer.
	Apply(context.Context, *ApplyRequest) (*ApplyResponse, error)
	// GetHints fetches hints for a shard.
	GetHints(context.Context, *GetHintsRequest) (*GetHintsResponse, error)
}

ShardServer is the server API for Shard service.

type ShardSpec 

type ShardSpec struct {
	// ID of the Shard.
	Id ShardID `protobuf:"bytes,1,opt,name=id,proto3,casttype=ShardID" json:"id,omitempty" yaml:",omitempty"`
	// Sources of the shard, uniquely ordered on Source journal.
	Sources []ShardSpec_Source `protobuf:"bytes,2,rep,name=sources,proto3" json:"sources" yaml:",omitempty"`
	// Prefix of the Journal into which the Shard's `recoverylog` will be recorded.
	// The complete Journal name is built as "{recovery_log_prefix}/{shard_id}".
	RecoveryLogPrefix string `` /* 151-byte string literal not displayed */
	// Prefix of Etcd keys into which `recoverylog` FSMHints are written to and
	// read from. FSMHints allow readers of the `recoverylog` to efficiently
	// determine the minimum fragments of log which must be read to fully recover
	// local store state. The complete hint key written by the Shard primary is:
	//
	//   "{hint_prefix}/{shard_id}.primary"
	//
	// The primary will regularly produce updated hints into this key, and
	// players of the log will similarly utilize hints from this key.
	HintPrefix string `protobuf:"bytes,4,opt,name=hint_prefix,json=hintPrefix,proto3" json:"hint_prefix,omitempty" yaml:"hint_prefix,omitempty"`
	// Backups of verified `recoverylog` FSMHints, retained as a disaster-recovery
	// mechanism. On completing playback, a player will write recovered hints to:
	//
	//   "{hints_prefix}/{shard_id}.backup.0".
	//
	// It also move hints previously stored under
	// "{hints_prefix/{shard_id}.backup.0" to
	// "{hints_prefix/{shard_id}.backup.1", and so on, keeping at most
	// |hint_backups| distinct sets of FSMHints.
	//
	// In the case of disaster or data-loss, these copied hints can be an important
	// fallback for recovering a consistent albeit older version of the Shard
	// store, with each relying on only progressively older portions of the
	// recoverylog.
	//
	// When pruning the recoverylog, log fragments which are older than (and no
	// longer required by) the *oldest* backup are discarded, ensuring that
	// all hints remain valid for playback.
	HintBackups int32 `protobuf:"varint,5,opt,name=hint_backups,json=hintBackups,proto3" json:"hint_backups,omitempty" yaml:"hint_backups,omitempty"`
	// Max duration of shard transactions. This duration upper-bounds the amount
	// of time during which a transaction may process messages before it must flush
	// and commit. It may run for less time if an input message stall occurs (eg,
	// no decoded journal message is ready without blocking). A typical value
	// would be `1s`: applications which perform extensive aggregation over message
	// streams exhibiting locality of "hot" keys may benefit from larger values.
	MaxTxnDuration time.Duration `` /* 141-byte string literal not displayed */
	// Min duration of shard transactions. This duration lower-bounds the amount
	// of time during which a transaction must process messages before it may flush
	// and commit. It may run for more time if additional messages are available
	// (eg, decoded journal messages are ready without blocking). Note also that
	// transactions are pipelined: a current transaction may process messages while
	// a prior transaction's recoverylog writes flush to Gazette, but it cannot
	// begin to commit until the prior transaction writes complete. In other words
	// even if |min_txn_quantum| is zero, some degree of message batching is
	// expected due to the network delay inherent in Gazette writes. A typical
	// value of would be `0s`: applications which perform extensive aggregation
	// may benefit from larger values.
	MinTxnDuration time.Duration `` /* 141-byte string literal not displayed */
	// Disable processing of the Shard.
	Disable bool `protobuf:"varint,8,opt,name=disable,proto3" json:"disable,omitempty" yaml:",omitempty"`
	// Hot standbys is the desired number of consumer processes which should be
	// replicating the primary consumer's recovery log. Standbys are allocated in
	// a separate availability zone of the current primary, and tail the live log
	// to continuously mirror the primary's on-disk DB file structure. Should the
	// primary experience failure, one of the hot standbys will be assigned to take
	// over as the new shard primary, which is accomplished by simply opening its
	// local copy of the RocksDB.
	//
	// Note that under regular operation, Shard hand-off is zero downtime even if
	// standbys are zero, as the current primary will not cede ownership until the
	// replacement process has completed log playback. However, a process failure
	// will leave the Shard without an owner until log playback can complete.
	HotStandbys uint32 `protobuf:"varint,9,opt,name=hot_standbys,json=hotStandbys,proto3" json:"hot_standbys,omitempty" yaml:"hot_standbys,omitempty"`
	// User-defined Labels of this ShardSpec. The label "id" is reserved and may
	// not be used with a ShardSpec's labels.
	protocol.LabelSet `protobuf:"bytes,10,opt,name=labels,proto3,embedded=labels" json:"labels" yaml:",omitempty,inline"`
}

ShardSpec describes a shard and its configuration. Shards represent the combination of a consumer application, a specific journal selected for consumption, and a recoverylog journal which replicates the stateful consumption of that journal by the consumer. ShardSpec serves as a allocator ItemValue.

func IntersectShardSpecs 

func IntersectShardSpecs(a, b ShardSpec) ShardSpec

IntersectShardSpecs returns a ShardSpec having a non-zero-valued field for each field value which is shared between |a| and |b|.

func SubtractShardSpecs 

func SubtractShardSpecs(a, b ShardSpec) ShardSpec

SubtractShardSpecs returns a ShardSpec derived from |a| but having a zero-valued field for each field which is matched by |b|.

func UnionShardSpecs 

func UnionShardSpecs(a, b ShardSpec) ShardSpec

UnionShardSpecs returns a ShardSpec combining all non-zero-valued fields across |a| and |b|. Where both |a| and |b| provide a non-zero value for a field, the value of |a| is retained.

func (*ShardSpec) Descriptor 

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

func (*ShardSpec) DesiredReplication 

func (m *ShardSpec) DesiredReplication() int

DesiredReplication is the desired number of shard replicas. allocator.ItemValue implementation.

func (*ShardSpec) HintBackupKeys 

func (m *ShardSpec) HintBackupKeys() []string

HintBackupKeys returns Etcd keys to which verified, disaster-recovery hints are written.

func (*ShardSpec) HintPrimaryKey 

func (m *ShardSpec) HintPrimaryKey() string

HintPrimaryKey returns the Etcd key to which recorded, primary hints are written.

func (*ShardSpec) IsConsistent 

func (m *ShardSpec) IsConsistent(assignment keyspace.KeyValue, all keyspace.KeyValues) bool

IsConsistent returns whether the shard assignment is consistent. allocator.ItemValue implementation.

func (*ShardSpec) Marshal 

func (m *ShardSpec) Marshal() (dAtA []byte, err error)

func (*ShardSpec) MarshalString 

func (m *ShardSpec) MarshalString() string

MarshalString returns the marshaled encoding of the ShardSpec as a string.

func (*ShardSpec) MarshalTo 

func (m *ShardSpec) MarshalTo(dAtA []byte) (int, error)

func (*ShardSpec) ProtoMessage 

func (*ShardSpec) ProtoMessage()

func (*ShardSpec) ProtoSize 

func (m *ShardSpec) ProtoSize() (n int)

func (*ShardSpec) RecoveryLog 

func (m *ShardSpec) RecoveryLog() pb.Journal

RecoveryLog returns the Journal to which the Shard's recoverylog is recorded.

func (*ShardSpec) Reset 

func (m *ShardSpec) Reset()

func (*ShardSpec) String 

func (m *ShardSpec) String() string

func (*ShardSpec) Unmarshal 

func (m *ShardSpec) Unmarshal(dAtA []byte) error

func (*ShardSpec) Validate 

func (m *ShardSpec) Validate() error

Validate returns an error if the ShardSpec is not well-formed.

func (*ShardSpec) XXX_DiscardUnknown 

func (m *ShardSpec) XXX_DiscardUnknown()

func (*ShardSpec) XXX_Marshal 

func (m *ShardSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ShardSpec) XXX_Merge 

func (m *ShardSpec) XXX_Merge(src proto.Message)

func (*ShardSpec) XXX_Size 

func (m *ShardSpec) XXX_Size() int

func (*ShardSpec) XXX_Unmarshal 

func (m *ShardSpec) XXX_Unmarshal(b []byte) error

type ShardSpec_Source 

type ShardSpec_Source struct {
	// Journal which this Shard is consuming.
	Journal go_gazette_dev_core_broker_protocol.Journal `protobuf:"bytes,1,opt,name=journal,proto3,casttype=go.gazette.dev/core/broker/protocol.Journal" json:"journal,omitempty"`
	// Minimum journal byte offset the shard should begin reading from. Typically
	// this should be zero, as read offsets are persisted to and recovered from
	// the shard store as the journal is processed. |min_offset| can be useful
	// for shard initialization, directing it to skip over undesired historical
	// sections of the journal.
	MinOffset int64 `protobuf:"varint,3,opt,name=min_offset,json=minOffset,proto3" json:"min_offset,omitempty" yaml:"min_offset,omitempty"`
}

Sources define the set of Journals which this Shard consumes. At least one Source must be specified, and in many use cases only one will be needed. For advanced use cases which can benefit, multiple sources may be specified to represent a "join" over messages of distinct journals. Note the effective mapping of messages to each of the joined journals should align (eg, joining a journal of customer updates with one of orders, where both are mapped on customer ID). Another powerful pattern is to join each partition of a high-volume event stream with a low-volume journal of queries, obtaining a reliable distributed scatter/gather query engine.

func (*ShardSpec_Source) Descriptor 

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

func (*ShardSpec_Source) Marshal 

func (m *ShardSpec_Source) Marshal() (dAtA []byte, err error)

func (*ShardSpec_Source) MarshalTo 

func (m *ShardSpec_Source) MarshalTo(dAtA []byte) (int, error)

func (*ShardSpec_Source) ProtoMessage 

func (*ShardSpec_Source) ProtoMessage()

func (*ShardSpec_Source) ProtoSize 

func (m *ShardSpec_Source) ProtoSize() (n int)

func (*ShardSpec_Source) Reset 

func (m *ShardSpec_Source) Reset()

func (*ShardSpec_Source) String 

func (m *ShardSpec_Source) String() string

func (*ShardSpec_Source) Unmarshal 

func (m *ShardSpec_Source) Unmarshal(dAtA []byte) error

func (*ShardSpec_Source) Validate 

func (m *ShardSpec_Source) Validate() error

Validate returns an error if the ShardSpec_Source is not well-formed.

func (*ShardSpec_Source) XXX_DiscardUnknown 

func (m *ShardSpec_Source) XXX_DiscardUnknown()

func (*ShardSpec_Source) XXX_Marshal 

func (m *ShardSpec_Source) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ShardSpec_Source) XXX_Merge 

func (m *ShardSpec_Source) XXX_Merge(src proto.Message)

func (*ShardSpec_Source) XXX_Size 

func (m *ShardSpec_Source) XXX_Size() int

func (*ShardSpec_Source) XXX_Unmarshal 

func (m *ShardSpec_Source) XXX_Unmarshal(b []byte) error

type StatRequest 

type StatRequest struct {
	// Header may be attached by a proxying consumer peer.
	Header *protocol.Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Shard to Stat.
	Shard ShardID `protobuf:"bytes,2,opt,name=shard,proto3,casttype=ShardID" json:"shard,omitempty"`
}

func (*StatRequest) Descriptor 

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

func (*StatRequest) Marshal 

func (m *StatRequest) Marshal() (dAtA []byte, err error)

func (*StatRequest) MarshalTo 

func (m *StatRequest) MarshalTo(dAtA []byte) (int, error)

func (*StatRequest) ProtoMessage 

func (*StatRequest) ProtoMessage()

func (*StatRequest) ProtoSize 

func (m *StatRequest) ProtoSize() (n int)

func (*StatRequest) Reset 

func (m *StatRequest) Reset()

func (*StatRequest) String 

func (m *StatRequest) String() string

func (*StatRequest) Unmarshal 

func (m *StatRequest) Unmarshal(dAtA []byte) error

func (*StatRequest) Validate 

func (m *StatRequest) Validate() error

Validate returns an error if the StatRequest is not well-formed.

func (*StatRequest) XXX_DiscardUnknown 

func (m *StatRequest) XXX_DiscardUnknown()

func (*StatRequest) XXX_Marshal 

func (m *StatRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatRequest) XXX_Merge 

func (m *StatRequest) XXX_Merge(src proto.Message)

func (*StatRequest) XXX_Size 

func (m *StatRequest) XXX_Size() int

func (*StatRequest) XXX_Unmarshal 

func (m *StatRequest) XXX_Unmarshal(b []byte) error

type StatResponse 

type StatResponse struct {
	// Status of the Stat RPC.
	Status Status `protobuf:"varint,1,opt,name=status,proto3,enum=consumer.Status" json:"status,omitempty"`
	// Header of the response.
	Header protocol.Header `protobuf:"bytes,2,opt,name=header,proto3" json:"header"`
	// Offsets of journals being read by the shard.
	Offsets map[go_gazette_dev_core_broker_protocol.Journal]int64 `` /* 208-byte string literal not displayed */
}

func (*StatResponse) Descriptor 

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

func (*StatResponse) Marshal 

func (m *StatResponse) Marshal() (dAtA []byte, err error)

func (*StatResponse) MarshalTo 

func (m *StatResponse) MarshalTo(dAtA []byte) (int, error)

func (*StatResponse) ProtoMessage 

func (*StatResponse) ProtoMessage()

func (*StatResponse) ProtoSize 

func (m *StatResponse) ProtoSize() (n int)

func (*StatResponse) Reset 

func (m *StatResponse) Reset()

func (*StatResponse) String 

func (m *StatResponse) String() string

func (*StatResponse) Unmarshal 

func (m *StatResponse) Unmarshal(dAtA []byte) error

func (*StatResponse) Validate 

func (m *StatResponse) Validate() error

Validate returns an error if the StatResponse is not well-formed.

func (*StatResponse) XXX_DiscardUnknown 

func (m *StatResponse) XXX_DiscardUnknown()

func (*StatResponse) XXX_Marshal 

func (m *StatResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatResponse) XXX_Merge 

func (m *StatResponse) XXX_Merge(src proto.Message)

func (*StatResponse) XXX_Size 

func (m *StatResponse) XXX_Size() int

func (*StatResponse) XXX_Unmarshal 

func (m *StatResponse) XXX_Unmarshal(b []byte) error

type Status 

type Status int32

Status is a response status code, used across Gazette Consumer RPC APIs. 

const (
	Status_OK Status = 0
	// The named shard does not exist.
	Status_SHARD_NOT_FOUND Status = 1
	// There is no current primary consumer process for the shard. This is a
	// temporary condition which should quickly resolve, assuming sufficient
	// consumer capacity.
	Status_NO_SHARD_PRIMARY Status = 2
	// The present consumer process is not the assigned primary for the shard,
	// and was not instructed to proxy the request.
	Status_NOT_SHARD_PRIMARY Status = 3
	// The Etcd transaction failed. Returned by Update RPC when an
	// expect_mod_revision of the UpdateRequest differs from the current
	// ModRevision of the ShardSpec within the store.
	Status_ETCD_TRANSACTION_FAILED Status = 4
)

func (Status) EnumDescriptor 

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

func (Status) String 

func (x Status) String() string

func (Status) Validate 

func (x Status) Validate() error

Validate returns an error if the Status is not well-formed.

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.