package storage_broker

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc SubscribeSafekeeperInfo (SubscribeSafekeeperInfoRequest, stream SafekeeperTimelineInfo)

  broker.proto:9

  Subscribe to safekeeper updates.

  message SubscribeSafekeeperInfoRequest

  broker.proto:21

  • oneof subscription_key

    • google.protobuf.Empty all = 1

      subscribe to everything

    • TenantTimelineId tenant_timeline_id = 2

      subscribe to specific timeline

• rpc PublishSafekeeperInfo (stream SafekeeperTimelineInfo, google.protobuf.Empty)

  broker.proto:12

  Publish safekeeper updates.

• rpc SubscribeByFilter (SubscribeByFilterRequest, stream TypedMessage)

  broker.proto:15

  Subscribe to all messages, limited by a filter.

  message SubscribeByFilterRequest

  broker.proto:72

  • repeated TypeSubscription types = 1

    Subscription will emit messages only of the specified types. You need to specify at least one type to receive any messages.

  • optional FilterTenantTimelineId tenant_timeline_id = 2

    If set and enabled, subscription will emit messages only for the specified tenant/timeline.

• rpc PublishOne (TypedMessage, google.protobuf.Empty)

  broker.proto:18

  Publish one message.

Used in: SubscribeByFilterRequest

• bool enabled = 1

  If true, only messages related to `tenant_timeline_id` will be emitted. Otherwise, messages for all timelines will be emitted.

• optional TenantTimelineId tenant_timeline_id = 2

Used in: TypeSubscription, TypedMessage

• UNKNOWN = 0

• SAFEKEEPER_TIMELINE_INFO = 2

• SAFEKEEPER_DISCOVERY_REQUEST = 3

• SAFEKEEPER_DISCOVERY_RESPONSE = 4

Used in: TypedMessage

• optional TenantTimelineId tenant_timeline_id = 1

Shorter version of SafekeeperTimelineInfo, contains only necessary fields.

Used in: TypedMessage

• uint64 safekeeper_id = 1

• optional TenantTimelineId tenant_timeline_id = 2

• uint64 commit_lsn = 3

  WAL available to download.

• string safekeeper_connstr = 4

  A connection string to use for WAL downloading.

• optional string availability_zone = 5

  Availability zone of a safekeeper.

• uint64 standby_horizon = 6

  Replica apply LSN

Used as request type in: BrokerService.PublishSafekeeperInfo

Used as response type in: BrokerService.SubscribeSafekeeperInfo

Used as field type in: TypedMessage

• uint64 safekeeper_id = 1

• optional TenantTimelineId tenant_timeline_id = 2

• uint64 term = 12

  Safekeeper term

• uint64 last_log_term = 3

  Term of the last entry.

• uint64 flush_lsn = 4

  LSN of the last record.

• uint64 commit_lsn = 5

  Up to which LSN safekeeper regards its WAL as committed.

• uint64 backup_lsn = 6

  LSN up to which safekeeper has backed WAL.

• uint64 remote_consistent_lsn = 7

  LSN of last checkpoint uploaded by pageserver.

• uint64 peer_horizon_lsn = 8

• uint64 local_start_lsn = 9

• uint64 standby_horizon = 14

• string safekeeper_connstr = 10

  A connection string to use for WAL receiving.

• string http_connstr = 13

  HTTP endpoint connection string.

• optional string https_connstr = 15

  HTTPS endpoint connection string.

• optional string availability_zone = 11

  Availability zone of a safekeeper.

Used in: FilterTenantTimelineId, SafekeeperDiscoveryRequest, SafekeeperDiscoveryResponse, SafekeeperTimelineInfo, SubscribeSafekeeperInfoRequest

• bytes tenant_id = 1

• bytes timeline_id = 2

Used in: SubscribeByFilterRequest

• MessageType type = 1

A message with a type.

Used as request type in: BrokerService.PublishOne

Used as response type in: BrokerService.SubscribeByFilter

• MessageType type = 1

• optional SafekeeperTimelineInfo safekeeper_timeline_info = 2

• optional SafekeeperDiscoveryRequest safekeeper_discovery_request = 3

• optional SafekeeperDiscoveryResponse safekeeper_discovery_response = 4