mirror of
https://github.com/gogrlx/nats-server.git
synced 2026-04-02 03:38:42 -07:00
273 lines
10 KiB
Go
273 lines
10 KiB
Go
// Copyright 2020-2021 The NATS Authors
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package server
|
|
|
|
import (
|
|
"encoding/json"
|
|
"time"
|
|
)
|
|
|
|
func (s *Server) publishAdvisory(acc *Account, subject string, adv interface{}) {
|
|
if acc == nil {
|
|
acc = s.SystemAccount()
|
|
if acc == nil {
|
|
return
|
|
}
|
|
}
|
|
ej, err := json.Marshal(adv)
|
|
if err == nil {
|
|
err = s.sendInternalAccountMsg(acc, subject, ej)
|
|
if err != nil {
|
|
s.Warnf("Advisory could not be sent for account %q: %v", acc.Name, err)
|
|
}
|
|
} else {
|
|
s.Warnf("Advisory could not be serialized for account %q: %v", acc.Name, err)
|
|
}
|
|
}
|
|
|
|
// JSAPIAudit is an advisory about administrative actions taken on JetStream
|
|
type JSAPIAudit struct {
|
|
TypedEvent
|
|
Server string `json:"server"`
|
|
Client *ClientInfo `json:"client"`
|
|
Subject string `json:"subject"`
|
|
Request string `json:"request,omitempty"`
|
|
Response string `json:"response"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
const JSAPIAuditType = "io.nats.jetstream.advisory.v1.api_audit"
|
|
|
|
// ActionAdvisoryType indicates which action against a stream, consumer or template triggered an advisory
|
|
type ActionAdvisoryType string
|
|
|
|
const (
|
|
CreateEvent ActionAdvisoryType = "create"
|
|
DeleteEvent ActionAdvisoryType = "delete"
|
|
ModifyEvent ActionAdvisoryType = "modify"
|
|
)
|
|
|
|
// JSStreamActionAdvisory indicates that a stream was created, edited or deleted
|
|
type JSStreamActionAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Action ActionAdvisoryType `json:"action"`
|
|
Template string `json:"template,omitempty"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
const JSStreamActionAdvisoryType = "io.nats.jetstream.advisory.v1.stream_action"
|
|
|
|
// JSConsumerActionAdvisory indicates that a consumer was created or deleted
|
|
type JSConsumerActionAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
Action ActionAdvisoryType `json:"action"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
const JSConsumerActionAdvisoryType = "io.nats.jetstream.advisory.v1.consumer_action"
|
|
|
|
// JSConsumerAckMetric is a metric published when a user acknowledges a message, the
|
|
// number of these that will be published is dependent on SampleFrequency
|
|
type JSConsumerAckMetric struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
ConsumerSeq uint64 `json:"consumer_seq"`
|
|
StreamSeq uint64 `json:"stream_seq"`
|
|
Delay int64 `json:"ack_time"`
|
|
Deliveries uint64 `json:"deliveries"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerAckMetricType is the schema type for JSConsumerAckMetricType
|
|
const JSConsumerAckMetricType = "io.nats.jetstream.metric.v1.consumer_ack"
|
|
|
|
// JSConsumerDeliveryExceededAdvisory is an advisory informing that a message hit
|
|
// its MaxDeliver threshold and so might be a candidate for DLQ handling
|
|
type JSConsumerDeliveryExceededAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
StreamSeq uint64 `json:"stream_seq"`
|
|
Deliveries uint64 `json:"deliveries"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerDeliveryExceededAdvisoryType is the schema type for JSConsumerDeliveryExceededAdvisory
|
|
const JSConsumerDeliveryExceededAdvisoryType = "io.nats.jetstream.advisory.v1.max_deliver"
|
|
|
|
// JSConsumerDeliveryNakAdvisory is an advisory informing that a message was
|
|
// naked by the consumer
|
|
type JSConsumerDeliveryNakAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
ConsumerSeq uint64 `json:"consumer_seq"`
|
|
StreamSeq uint64 `json:"stream_seq"`
|
|
Deliveries uint64 `json:"deliveries"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerDeliveryNakAdvisoryType is the schema type for JSConsumerDeliveryNakAdvisory
|
|
const JSConsumerDeliveryNakAdvisoryType = "io.nats.jetstream.advisory.v1.nak"
|
|
|
|
// JSConsumerDeliveryTerminatedAdvisory is an advisory informing that a message was
|
|
// terminated by the consumer, so might be a candidate for DLQ handling
|
|
type JSConsumerDeliveryTerminatedAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
ConsumerSeq uint64 `json:"consumer_seq"`
|
|
StreamSeq uint64 `json:"stream_seq"`
|
|
Deliveries uint64 `json:"deliveries"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerDeliveryTerminatedAdvisoryType is the schema type for JSConsumerDeliveryTerminatedAdvisory
|
|
const JSConsumerDeliveryTerminatedAdvisoryType = "io.nats.jetstream.advisory.v1.terminated"
|
|
|
|
// JSSnapshotCreateAdvisory is an advisory sent after a snapshot is successfully started
|
|
type JSSnapshotCreateAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
State StreamState `json:"state"`
|
|
Client *ClientInfo `json:"client"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSSnapshotCreatedAdvisoryType is the schema type for JSSnapshotCreateAdvisory
|
|
const JSSnapshotCreatedAdvisoryType = "io.nats.jetstream.advisory.v1.snapshot_create"
|
|
|
|
// JSSnapshotCompleteAdvisory is an advisory sent after a snapshot is successfully started
|
|
type JSSnapshotCompleteAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Start time.Time `json:"start"`
|
|
End time.Time `json:"end"`
|
|
Client *ClientInfo `json:"client"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSSnapshotCompleteAdvisoryType is the schema type for JSSnapshotCreateAdvisory
|
|
const JSSnapshotCompleteAdvisoryType = "io.nats.jetstream.advisory.v1.snapshot_complete"
|
|
|
|
// JSRestoreCreateAdvisory is an advisory sent after a snapshot is successfully started
|
|
type JSRestoreCreateAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Client *ClientInfo `json:"client"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSRestoreCreateAdvisoryType is the schema type for JSSnapshotCreateAdvisory
|
|
const JSRestoreCreateAdvisoryType = "io.nats.jetstream.advisory.v1.restore_create"
|
|
|
|
// JSRestoreCompleteAdvisory is an advisory sent after a snapshot is successfully started
|
|
type JSRestoreCompleteAdvisory struct {
|
|
TypedEvent
|
|
Stream string `json:"stream"`
|
|
Start time.Time `json:"start"`
|
|
End time.Time `json:"end"`
|
|
Bytes int64 `json:"bytes"`
|
|
Client *ClientInfo `json:"client"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSRestoreCompleteAdvisoryType is the schema type for JSSnapshotCreateAdvisory
|
|
const JSRestoreCompleteAdvisoryType = "io.nats.jetstream.advisory.v1.restore_complete"
|
|
|
|
// Clustering specific.
|
|
|
|
// JSStreamLeaderElectedAdvisoryType is sent when the system elects a leader for a stream.
|
|
const JSStreamLeaderElectedAdvisoryType = "io.nats.jetstream.advisory.v1.stream_leader_elected"
|
|
|
|
// JSStreamLeaderElectedAdvisory indicates that a stream has lost quorum and is stalled.
|
|
type JSStreamLeaderElectedAdvisory struct {
|
|
TypedEvent
|
|
Account string `json:"account,omitempty"`
|
|
Stream string `json:"stream"`
|
|
Leader string `json:"leader"`
|
|
Replicas []*PeerInfo `json:"replicas"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSStreamQuorumLostAdvisoryType is sent when the system detects a clustered stream and
|
|
// its consumers are stalled and unable to make progress.
|
|
const JSStreamQuorumLostAdvisoryType = "io.nats.jetstream.advisory.v1.stream_quorum_lost"
|
|
|
|
// JSStreamQuorumLostAdvisory indicates that a stream has lost quorum and is stalled.
|
|
type JSStreamQuorumLostAdvisory struct {
|
|
TypedEvent
|
|
Account string `json:"account,omitempty"`
|
|
Stream string `json:"stream"`
|
|
Replicas []*PeerInfo `json:"replicas"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerLeaderElectedAdvisoryType is sent when the system elects a leader for a consumer.
|
|
const JSConsumerLeaderElectedAdvisoryType = "io.nats.jetstream.advisory.v1.consumer_leader_elected"
|
|
|
|
// JSConsumerLeaderElectedAdvisory indicates that a stream has lost quorum and is stalled.
|
|
type JSConsumerLeaderElectedAdvisory struct {
|
|
TypedEvent
|
|
Account string `json:"account,omitempty"`
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
Leader string `json:"leader"`
|
|
Replicas []*PeerInfo `json:"replicas"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSConsumerQuorumLostAdvisoryType is sent when the system detects a clustered consumer and
|
|
// is stalled and unable to make progress.
|
|
const JSConsumerQuorumLostAdvisoryType = "io.nats.jetstream.advisory.v1.consumer_quorum_lost"
|
|
|
|
// JSConsumerQuorumLostAdvisory indicates that a consumer has lost quorum and is stalled.
|
|
type JSConsumerQuorumLostAdvisory struct {
|
|
TypedEvent
|
|
Account string `json:"account,omitempty"`
|
|
Stream string `json:"stream"`
|
|
Consumer string `json:"consumer"`
|
|
Replicas []*PeerInfo `json:"replicas"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSServerOutOfStorageAdvisoryType is sent when the server is out of storage space.
|
|
const JSServerOutOfStorageAdvisoryType = "io.nats.jetstream.advisory.v1.server_out_of_space"
|
|
|
|
// JSServerOutOfSpaceAdvisory indicates that a stream has lost quorum and is stalled.
|
|
type JSServerOutOfSpaceAdvisory struct {
|
|
TypedEvent
|
|
Server string `json:"server"`
|
|
ServerID string `json:"server_id"`
|
|
Stream string `json:"stream,omitempty"`
|
|
Cluster string `json:"cluster"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|
|
|
|
// JSServerRemovedAdvisoryType is sent when the server has been removed and JS disabled.
|
|
const JSServerRemovedAdvisoryType = "io.nats.jetstream.advisory.v1.server_removed"
|
|
|
|
// JSServerRemovedAdvisory indicates that a stream has lost quorum and is stalled.
|
|
type JSServerRemovedAdvisory struct {
|
|
TypedEvent
|
|
Server string `json:"server"`
|
|
ServerID string `json:"server_id"`
|
|
Cluster string `json:"cluster"`
|
|
Domain string `json:"domain,omitempty"`
|
|
}
|