Type alias ClusterSupportInfo

ClusterSupportInfo: {
    date: string;
    deployment: {
        agents: number;
        coordinators: number;
        dbServers: number;
        servers: Record<string, Record<string, any>>;
        shards: {
            collections: number;
            followers: number;
            leaders: number;
            realLeaders: number;
            servers: number;
            shards: number;
        };
        type: "cluster";
    };
    host: Record<string, any>;
}

Cluster deployment information for support purposes.

Type declaration

  • date: string

    ISO 8601 datetime string of when the information was requested.

  • deployment: {
        agents: number;
        coordinators: number;
        dbServers: number;
        servers: Record<string, Record<string, any>>;
        shards: {
            collections: number;
            followers: number;
            leaders: number;
            realLeaders: number;
            servers: number;
            shards: number;
        };
        type: "cluster";
    }

    Information about the deployment.

    • agents: number

      Number of agents in the cluster.

    • coordinators: number

      Number of coordinators in the cluster.

    • dbServers: number

      Number of DB-Servers in the cluster.

    • servers: Record<string, Record<string, any>>

      Information about the servers in the cluster.

    • shards: {
          collections: number;
          followers: number;
          leaders: number;
          realLeaders: number;
          servers: number;
          shards: number;
      }

      Information about the shards in the cluster.

      • collections: number

        Number of collections in the cluster.

      • followers: number

        Number of followers in the cluster.

      • leaders: number

        Number of leaders in the cluster.

      • realLeaders: number

        Number of real leaders in the cluster.

      • servers: number

        Number of servers in the cluster.

      • shards: number

        Number of shards in the cluster.

    • type: "cluster"

      Deployment mode:

      • "single": A single server deployment.

      • "cluster": A cluster deployment.

  • host: Record<string, any>

    (Cluster only.) Information about the ArangoDB instance as well as the host machine.

Settings

Theme