advisory

Documentation

Index

• type ActionAdvisoryTypeV1
  • func (a ActionAdvisoryTypeV1) String() string
• type ConsumerDeliveryExceededAdvisoryV1
• type JSConsumerActionAdvisoryV1
• type JSConsumerDeliveryTerminatedAdvisoryV1
• type JSConsumerLeaderElectedV1
• type JSConsumerQuorumLostV1
• type JSRestoreCompleteAdvisoryV1
• type JSRestoreCreateAdvisoryV1
• type JSServerOutOfSpaceAdvisoryV1
• type JSSnapshotCompleteAdvisoryV1
• type JSSnapshotCreateAdvisoryV1
• type JSStreamActionAdvisoryV1
• type JSStreamLeaderElectedV1
• type JSStreamQuorumLostV1
• type JetStreamAPIAuditV1
• type PeerInfoV1

Types

type ActionAdvisoryTypeV1

type ActionAdvisoryTypeV1 string

ActionAdvisoryTypeV1 indicates which action against a stream, consumer or template triggered an advisory

const (
	CreateEvent ActionAdvisoryTypeV1 = "create"
	DeleteEvent ActionAdvisoryTypeV1 = "delete"
	ModifyEvent ActionAdvisoryTypeV1 = "modify"
)

func (ActionAdvisoryTypeV1) String

func (a ActionAdvisoryTypeV1) String() string

type ConsumerDeliveryExceededAdvisoryV1

type ConsumerDeliveryExceededAdvisoryV1 struct {
	event.NATSEvent

	Stream     string `json:"stream"`
	Consumer   string `json:"consumer"`
	StreamSeq  uint64 `json:"stream_seq"`
	Deliveries uint64 `json:"deliveries"`
}

ConsumerDeliveryExceededAdvisoryV1 is an advisory published when a consumer message reaches max delivery attempts

NATS Schema Type io.nats.jetstream.advisory.v1.max_deliver

type JSConsumerActionAdvisoryV1

type JSConsumerActionAdvisoryV1 struct {
	event.NATSEvent

	Stream   string               `json:"stream"`
	Consumer string               `json:"consumer"`
	Action   ActionAdvisoryTypeV1 `json:"action"`
}

JSConsumerActionAdvisoryV1 is a advisory published on create or delete of a Consumer

NATS Schema Type io.nats.jetstream.advisory.v1.consumer_action

type JSConsumerDeliveryTerminatedAdvisoryV1

type JSConsumerDeliveryTerminatedAdvisoryV1 struct {
	event.NATSEvent

	Stream      string `json:"stream"`
	Consumer    string `json:"consumer"`
	ConsumerSeq uint64 `json:"consumer_seq"`
	StreamSeq   uint64 `json:"stream_seq"`
	Deliveries  uint64 `json:"deliveries"`
}

JSConsumerDeliveryTerminatedAdvisoryV1 is an advisory informing that a message was terminated by the consumer, so might be a candidate for DLQ handling

NATS Schema: io.nats.jetstream.advisory.v1.terminated

type JSConsumerLeaderElectedV1

type JSConsumerLeaderElectedV1 struct {
	event.NATSEvent

	Stream   string        `json:"stream"`
	Consumer string        `json:"consumer"`
	Leader   string        `json:"leader"`
	Replicas []*PeerInfoV1 `json:"replicas"`
}

JSConsumerLeaderElectedV1 is a advisory published when a stream elects a new leader

NATS Schema Type io.nats.jetstream.advisory.v1.consumer_leader_elected

type JSConsumerQuorumLostV1

type JSConsumerQuorumLostV1 struct {
	event.NATSEvent

	Stream   string        `json:"stream"`
	Consumer string        `json:"consumer"`
	Replicas []*PeerInfoV1 `json:"replicas"`
}

JSConsumerQuorumLostV1 is a advisory published when a stream elects a new leader

NATS Schema Type io.nats.jetstream.advisory.v1.consumer_quorum_lost

type JSRestoreCompleteAdvisoryV1

type JSRestoreCompleteAdvisoryV1 struct {
	event.NATSEvent

	Stream string                `json:"stream"`
	Start  time.Time             `json:"start"`
	End    time.Time             `json:"end"`
	Bytes  int64                 `json:"bytes"`
	Client advisory.ClientInfoV1 `json:"client"`
}

JSRestoreCompleteAdvisoryV1 is an advisory sent after a snapshot is successfully started

NATS Schema type io.nats.jetstream.advisory.v1.restore_complete

type JSRestoreCreateAdvisoryV1

type JSRestoreCreateAdvisoryV1 struct {
	event.NATSEvent

	Stream string                `json:"stream"`
	Client advisory.ClientInfoV1 `json:"client"`
}

JSRestoreCreateAdvisoryV1 is an advisory sent after a snapshot is successfully started

NATS Schema io.nats.jetstream.advisory.v1.restore_create

type JSServerOutOfSpaceAdvisoryV1

type JSServerOutOfSpaceAdvisoryV1 struct {
	event.NATSEvent

	Server   string `json:"server"`
	ServerID string `json:"server_id"`
	Stream   string `json:"stream,omitempty"`
	Cluster  string `json:"cluster"`
}

JSServerOutOfSpaceAdvisoryV1 is an advisory sent when a server runs out of disk space

NATS Schema Type io.nats.jetstream.advisory.v1.server_out_of_space

type JSSnapshotCompleteAdvisoryV1

type JSSnapshotCompleteAdvisoryV1 struct {
	event.NATSEvent

	Stream string                `json:"stream"`
	Start  time.Time             `json:"start"`
	End    time.Time             `json:"end"`
	Client advisory.ClientInfoV1 `json:"client"`
}

JSSnapshotCompleteAdvisoryV1 is an advisory sent after a snapshot is successfully started

NATS Schema Type io.nats.jetstream.advisory.v1.snapshot_complete

type JSSnapshotCreateAdvisoryV1

type JSSnapshotCreateAdvisoryV1 struct {
	event.NATSEvent
	Stream  string                `json:"stream"`
	NumBlks int64                 `json:"blocks"`
	BlkSize int64                 `json:"block_size"`
	Client  advisory.ClientInfoV1 `json:"client"`
}

JSSnapshotCreateAdvisoryV1 is an advisory sent after a snapshot is successfully started

NATS Schema io.nats.jetstream.advisory.v1.snapshot_create

type JSStreamActionAdvisoryV1

type JSStreamActionAdvisoryV1 struct {
	event.NATSEvent

	Stream   string               `json:"stream"`
	Action   ActionAdvisoryTypeV1 `json:"action"`
	Template string               `json:"template,omitempty"`
}

JetStreamAPIAuditV1 is a advisory published on create, modify or delete of a Stream

NATS Schema Type io.nats.jetstream.advisory.v1.stream_action

type JSStreamLeaderElectedV1

type JSStreamLeaderElectedV1 struct {
	event.NATSEvent

	Stream   string        `json:"stream"`
	Leader   string        `json:"leader"`
	Replicas []*PeerInfoV1 `json:"replicas"`
}

JSStreamLeaderElectedV1 is a advisory published when a stream elects a new leader

NATS Schema Type io.nats.jetstream.advisory.v1.stream_leader_elected

type JSStreamQuorumLostV1

type JSStreamQuorumLostV1 struct {
	event.NATSEvent

	Stream   string        `json:"stream"`
	Replicas []*PeerInfoV1 `json:"replicas"`
}

JSStreamQuorumLostV1 is a advisory published when a stream elects a new leader

NATS Schema Type io.nats.jetstream.advisory.v1.stream_quorum_lost

type JetStreamAPIAuditV1

type JetStreamAPIAuditV1 struct {
	event.NATSEvent

	Server   string                `json:"server"`
	Client   advisory.ClientInfoV1 `json:"client"`
	Subject  string                `json:"subject"`
	Request  string                `json:"request,omitempty"`
	Response string                `json:"response"`
}

JetStreamAPIAuditV1 is a advisory published for any JetStream API access

NATS Schema Type io.nats.jetstream.advisory.v1.api_audit

type PeerInfoV1

type PeerInfoV1 struct {
	Name    string        `json:"name"`
	Current bool          `json:"current"`
	Active  time.Duration `json:"active"`
}

PeerInfoV1 is information about a specific peer in a cluster