Adds new domain elected advisory

Signed-off-by: R.I.Pienaar <[email protected]>
nats-io · Mar 11, 2024 · 3d7f46f · 3d7f46f
1 parent 1fc2f2b
commit 3d7f46f
Show file tree

Hide file tree

Showing 4 changed files with 165 additions and 0 deletions.
diff --git a/api/gen.go b/api/gen.go
@@ -203,6 +203,7 @@ func main() {
 		&schema{P: "jetstream/advisory/v1/restore_complete.json", St: "jsadvisory.JSRestoreCompleteAdvisoryV1"},
 		&schema{P: "jetstream/advisory/v1/stream_leader_elected.json", St: "jsadvisory.JSStreamLeaderElectedV1"},
 		&schema{P: "jetstream/advisory/v1/consumer_leader_elected.json", St: "jsadvisory.JSConsumerLeaderElectedV1"},
+		&schema{P: "jetstream/advisory/v1/domain_leader_elected.json", St: "jsadvisory.JSDomainLeaderElectedV1"},
 		&schema{P: "jetstream/advisory/v1/stream_quorum_lost.json", St: "jsadvisory.JSStreamQuorumLostV1"},
 		&schema{P: "jetstream/advisory/v1/consumer_quorum_lost.json", St: "jsadvisory.JSConsumerQuorumLostV1"},
 		&schema{P: "jetstream/advisory/v1/server_out_of_space.json", St: "jsadvisory.JSServerOutOfSpaceAdvisoryV1"},

diff --git a/api/jetstream/advisory/domain_leader_elected.go b/api/jetstream/advisory/domain_leader_elected.go
@@ -0,0 +1,43 @@
+package advisory
+
+import (
+	"github.com/nats-io/jsm.go/api/event"
+)
+
+// JSDomainLeaderElectedV1 is a advisory published when a domain leader is elected
+//
+// NATS Schema Type io.nats.jetstream.advisory.v1.domain_leader_elected
+type JSDomainLeaderElectedV1 struct {
+	event.NATSEvent
+
+	Leader   string        `json:"leader"`
+	Cluster  string        `json:"cluster"`
+	Domain   string        `json:"domain,omitempty"`
+	Replicas []*PeerInfoV1 `json:"replicas"`
+}
+
+func init() {
+	err := event.RegisterTextCompactTemplate("io.nats.jetstream.advisory.v1.domain_leader_elected", `{{ .Time | ShortTime }} [RAFT] Domain leader elected {{ .Leader }} in cluster {{.Cluster}} leader of {{ .Replicas | len }} peers`)
+	if err != nil {
+		panic(err)
+	}
+
+	err = event.RegisterTextExtendedTemplate("io.nats.jetstream.advisory.v1.domain_leader_elected", `
+[{{ .Time | ShortTime }}] [{{ .ID }}] Domain Leader Election
+
+        Leader: {{ .Leader }}
+       Cluster: {{ .Cluster }}
+{{- if .Domain }}
+        Domain: {{ .Domain }}
+{{- end }}
+      Replicas:
+{{ range .Replicas }}
+             Name: {{ .Name }}
+          Current: {{ .Current }}
+           Active: {{ .Active }}
+{{ end }}
+`)
+	if err != nil {
+		panic(err)
+	}
+}
diff --git a/schema_source/jetstream/advisory/v1/domain_leader_elected.json b/schema_source/jetstream/advisory/v1/domain_leader_elected.json
@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://nats.io/schemas/jetstream/advisory/v1/domain_leader_elected.json",
+  "description": "An Advisory sent when a meta leader is elected",
+  "title": "io.nats.jetstream.advisory.v1.domain_leader_elected",
+  "type": "object",
+  "required": [
+    "type",
+    "id",
+    "timestamp",
+    "leader",
+    "replicas",
+    "cluster"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "io.nats.jetstream.advisory.v1.domain_leader_elected"
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique correlation ID for this event"
+    },
+    "timestamp": {
+      "type": "string",
+      "description": "The time this event was created in RFC3339 format"
+    },
+    "leader": {
+      "type": "string",
+      "description": "The server name of the elected leader"
+    },
+    "replicas": {
+      "$ref": "../../../jetstream/api/v1/definitions.json#/definitions/peer_info"
+    },
+    "cluster": {
+      "type": "string",
+      "description": "The cluster holding the leader"
+    },
+    "domain": {
+      "type": "string",
+      "description": "The domain the leader is in"
+    }
+  }
+}
diff --git a/schemas/jetstream/advisory/v1/domain_leader_elected.json b/schemas/jetstream/advisory/v1/domain_leader_elected.json
@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://nats.io/schemas/jetstream/advisory/v1/domain_leader_elected.json",
+  "description": "An Advisory sent when a meta leader is elected",
+  "title": "io.nats.jetstream.advisory.v1.domain_leader_elected",
+  "type": "object",
+  "required": [
+    "type",
+    "id",
+    "timestamp",
+    "leader",
+    "replicas",
+    "cluster"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "io.nats.jetstream.advisory.v1.domain_leader_elected"
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique correlation ID for this event"
+    },
+    "timestamp": {
+      "type": "string",
+      "description": "The time this event was created in RFC3339 format"
+    },
+    "leader": {
+      "type": "string",
+      "description": "The server name of the elected leader"
+    },
+    "replicas": {
+      "type": "object",
+      "required": [
+        "name",
+        "current",
+        "active"
+      ],
+      "properties": {
+        "name": {
+          "description": "The server name of the peer",
+          "type": "string",
+          "minimum": 1
+        },
+        "current": {
+          "description": "Indicates if the server is up to date and synchronised",
+          "type": "boolean",
+          "default": false
+        },
+        "active": {
+          "description": "Nanoseconds since this peer was last seen",
+          "type": "number"
+        },
+        "offline": {
+          "description": "Indicates the node is considered offline by the group",
+          "type": "boolean",
+          "default": false
+        },
+        "lag": {
+          "description": "How many uncommitted operations this peer is behind the leader",
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "cluster": {
+      "type": "string",
+      "description": "The cluster holding the leader"
+    },
+    "domain": {
+      "type": "string",
+      "description": "The domain the leader is in"
+    }
+  }
+}