zt/common/pb/mgmt_pb/mgmt.proto

syntax = "proto3";

package zt.mgmt_pb;
option go_package = "github.com/hanzozt/fabric/pb/mgmt_pb";

import "google/protobuf/timestamp.proto";

enum ContentType {
  // Protoc says this has to be here
  Zero = 0;

  // Streams
  StreamEventsRequestType = 10040;
  StreamEventsEventType = 10041;

  TogglePipeTracesRequestType = 10044;
  ToggleCircuitTracesRequestType = 10045;
  StreamTracesRequestType = 10046;
  StreamTracesEventType = 10047;


  // Inspect
  InspectRequestType = 10048;
  InspectResponseType = 10049;

  // Snapshot db
  SnapshotDbRequestType = 10070;

  // Router Mgmt
  RouterDebugForgetLinkRequestType = 10071;
  RouterDebugToggleCtrlChannelRequestType = 10072;
  RouterDebugUpdateRouteRequestType = 10073;
  RouterDebugDumpForwarderTablesRequestType = 10074;
  RouterDebugDumpLinksRequestType = 10075;
  RouterDebugUnrouteRequestType = 10076;
  RouterQuiesceRequestType = 10077;
  RouterDequiesceRequestType = 10078;
  RouterDecommissionRequestType = 10079;

  // Raft
  RaftListMembersRequestType = 10080;
  RaftListMembersResponseType = 10081;
  RaftAddPeerRequestType = 10082;
  RaftRemovePeerRequestType = 10083;
  RaftTransferLeadershipRequestType = 10084;
  RaftInitFromDb = 10085;
  RaftInit = 10086;
  RaftRestoreFromDb = 10087;

  // Validate
  ValidateTerminatorsRequestType = 10100;
  ValidateTerminatorResponseType = 10101;
  ValidateTerminatorResultType = 10102;
  ValidateTerminatorHostResultType = 10121;

  ValidateRouterLinksRequestType = 10103;
  ValidateRouterLinksResponseType = 10104;
  ValidateRouterLinksResultType = 10105;

  ValidateRouterSdkTerminatorsRequestType = 10106;
  ValidateRouterSdkTerminatorsResponseType = 10107;
  ValidateRouterSdkTerminatorsResultType = 10108;

  ValidateRouterDataModelRequestType = 10109;
  ValidateRouterDataModelResponseType = 10110;
  ValidateRouterDataModelResultType = 10111;

  ValidateIdentityConnectionStatusesRequestType = 10112;
  ValidateIdentityConnectionStatusesResponseType = 10113;
  ValidateIdentityConnectionStatusesResultType = 10114;

  ValidateRouterErtTerminatorsRequestType = 10115;
  ValidateRouterErtTerminatorsResponseType = 10116;
  ValidateRouterErtTerminatorsResultType = 10117;

  ValidateCircuitsRequestType = 10118;
  ValidateCircuitsResponseType = 10119;
  ValidateCircuitsResultType = 10120;

  // next id 10122
}

enum Header {
  NoneHeader = 0;

  EventTypeHeader = 10;
  CtrlChanToggle = 11;
  ControllerId = 12;
}

//
// --- Streams ------------------------------------------------------------------------------------------------------ //
//

message StreamMetricsRequest {
  repeated MetricMatcher matchers = 1;

  message MetricMatcher {
    string nameRegex = 1;
    string sourceIDRegex = 2;
  }
}

message StreamMetricsEvent {
  string sourceId = 1;
  google.protobuf.Timestamp timestamp = 2;
  map<string, string> tags = 3;

  map<string, int64> intMetrics = 4;
  map<string, double> floatMetrics = 5;

  repeated IntervalMetric intervalMetrics = 6;

  message IntervalMetric {
    string name = 1;
    google.protobuf.Timestamp intervalStartUTC = 2;
    google.protobuf.Timestamp intervalEndUTC = 3;
    map<string, uint64> values = 4;
  }

  map<string, string> metricGroup = 7;
}

enum StreamCircuitEventType {
  CircuitCreated = 0;
  CircuitDeleted = 1;
  CircuitPresent = 2;
  PathUpdated = 3;
  CircuitFailed = 4;
}

message Path {
  repeated string nodes = 1;
  repeated string links = 2;
  string terminatorLocalAddress = 3;
}

message StreamCircuitsEvent {
  StreamCircuitEventType eventType = 1;
  string circuitId = 2;
  string clientId = 3;
  string serviceId = 4;
  Path path = 5;
  optional int64 creationTimespan = 6;
  string terminatorId = 7;
}

message ToggleCircuitTracesRequest {
  bool enable = 1;
  string serviceRegex = 2;
  string clientRegex = 3;
}

enum TraceFilterType {
  EXCLUDE = 0;
  INCLUDE = 1;
}

message StreamTracesRequest {
  bool enabledFilter = 1;
  TraceFilterType filterType = 2;
  repeated int32 contentTypes = 3;
}

message InspectRequest {
  string appRegex = 1;
  repeated string requestedValues = 2;
}

message InspectResponse {
  bool success = 1;
  repeated string errors = 2;
  repeated InspectValue values = 3;

  message InspectValue {
    string appId = 1;
    string name = 2;
    string value = 3;
  }
}

// Raft
message RaftMember  {
  string Id = 1;
  string Addr = 2;
  bool IsVoter = 3;
  bool IsLeader = 4;
  string Version = 5;
  bool IsConnected = 6;
}

message RaftMemberListResponse {
  repeated RaftMember members = 1;
}

message ValidateTerminatorsRequest {
  string terminatorsFilter = 1;
  bool fixInvalid = 2;
  string identitiesFilter = 3;
  uint32 expectedPerSvcAndHost = 4;
  uint32 expectedPerHost = 5;
}

message ValidateTerminatorsResponse {
  bool success = 1;
  string message = 2;
  uint64 terminatorCount = 3;
}

enum TerminatorState {
  Valid = 0;
  Unknown = 1;
  InvalidUnknownBinding = 2;
  InvalidUnknownTerminator = 3;
  InvalidBadState = 4;
}

message TerminatorDetail {
  string terminatorId = 1;
  string serviceId = 2;
  string serviceName = 3;
  string routerId = 4;
  string routerName = 5;
  string binding = 6;
  string address = 7;
  string hostId = 8;
  string createDate = 9;
  TerminatorState state = 10;
  bool fixed = 11;
  string detail = 12;
}

message InvalidTerminatorHostState {
  string identityId = 1;
  string serviceId = 2;
  string message = 3;
}

message ValidateRouterLinksRequest {
  string filter = 1;
}

message ValidateRouterLinksResponse {
  bool success = 1;
  string message = 2;
  uint64 routerCount = 3;
}

message RouterLinkDetails {
  string routerId = 1;
  string routerName = 2;
  bool validateSuccess = 3;
  string message = 4;
  repeated RouterLinkDetail linkDetails = 5;
}

enum LinkState {
  LinkUnknown = 0;
  LinkEstablished = 1;
  LinkPending = 2;
  LinkDialing = 3;
}

message RouterLinkDetail {
  string linkId = 1;
  LinkState ctrlState = 2;
  LinkState routerState = 3;
  bool destConnected = 4;
  bool isValid = 5;
  string destRouterId = 6;
  bool dialed = 7;
  repeated string messages = 8;
}

message ValidateRouterSdkTerminatorsRequest {
  string filter = 1;
}

message ValidateRouterSdkTerminatorsResponse {
  bool success = 1;
  string message = 2;
  uint64 routerCount = 3;
}

message RouterSdkTerminatorsDetails {
  string routerId = 1;
  string routerName = 2;
  bool validateSuccess = 3;
  string message = 4;
  repeated RouterSdkTerminatorDetail details = 5;
}

message RouterSdkTerminatorDetail {
  string terminatorId = 1;
  TerminatorState ctrlState = 2;
  string routerState = 3;
  bool isValid = 4;
  bool operationActive = 5;
  string createTime = 6;
  string lastAttempt = 7;
}

message ValidateRouterErtTerminatorsRequest {
  string filter = 1;
}

message ValidateRouterErtTerminatorsResponse {
  bool success = 1;
  string message = 2;
  uint64 routerCount = 3;
}

message RouterErtTerminatorsDetails {
  string routerId = 1;
  string routerName = 2;
  bool validateSuccess = 3;
  string message = 4;
  repeated RouterErtTerminatorDetail details = 5;
}

message RouterErtTerminatorDetail {
  string terminatorId = 1;
  TerminatorState ctrlState = 2;
  string routerState = 3;
  bool isValid = 4;
}

message ValidateRouterDataModelRequest {
  string routerFilter = 1;
  bool validateCtrl = 2;
  bool fix = 3;
}

message ValidateRouterDataModelResponse {
  bool success = 1;
  string message = 2;
  uint64 componentCount = 3;
}

message RouterDataModelDetails {
  string componentType = 1;
  string componentId = 2;
  string componentName = 3;
  bool validateSuccess = 4;
  repeated string errors = 5;
}

message ValidateIdentityConnectionStatusesRequest {
  string routerFilter = 1;
}

message ValidateIdentityConnectionStatusesResponse {
  bool success = 1;
  string message = 2;
  uint64 componentCount = 3;
}

message RouterIdentityConnectionStatusesDetails {
  string componentType = 1;
  string componentId = 2;
  string componentName = 3;
  bool validateSuccess = 4;
  repeated string errors = 5;
}

message InitRequest {
  string username = 1;
  string password = 2;
  string name = 3;
}

message ValidateCircuitsRequest {
  string routerFilter = 1;
}

message ValidateCircuitsResponse {
  bool success = 1;
  string message = 2;
  uint64 routerCount = 3;
}

message RouterCircuitDetails {
  string routerId = 1;
  string routerName = 2;
  bool validateSuccess = 3;
  string message = 4;
  map<string, RouterCircuitDetail> details = 5;
}

message RouterCircuitDetail {
  string circuitId = 1;
  bool missingInCtrl = 2;
  bool missingInForwarder = 3;
  bool missingInEdge = 4;
  bool missingInSdk = 5;

  map<string, string> destinations = 6;
}