Query tunnel information - Tablestore SDK for Java - Tablestore

Prérequis

Installez le SDK Tablestore pour Java et initialisez TunnelClient.

Description de la fonctionnalité

Appelez describeTunnel pour interroger les informations relatives à un tunnel. La réponse inclut la configuration du tunnel, le point de consommation incrémentale global et l'objectif de point de reprise (RPO), ainsi que l'état et la progression de la consommation de chaque canal du tunnel.

DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
        throws TableStoreException, ClientException

L'exemple suivant interroge les informations du tunnel example_tunnel de la table example_table et affiche l'étape du tunnel ainsi que l'état et la progression de la consommation de chaque canal :

String tableName = "example_table";
String tunnelName = "example_tunnel";

DescribeTunnelRequest request =
        new DescribeTunnelRequest(tableName, tunnelName);
DescribeTunnelResponse response = tunnelClient.describeTunnel(request);

TunnelInfo tunnelInfo = response.getTunnelInfo();
System.out.printf(
        "name=%s, type=%s, stage=%s%n",
        tunnelInfo.getTunnelName(),
        tunnelInfo.getTunnelType(),
        tunnelInfo.getStage());

for (ChannelInfo channelInfo : response.getChannelInfos()) {
    System.out.printf(
            "channelId=%s, type=%s, status=%s, count=%d%n",
            channelInfo.getChannelId(),
            channelInfo.getChannelType(),
            channelInfo.getChannelStatus(),
            channelInfo.getChannelCount());
}

Paramètres

Le paramètre request est de type DescribeTunnelRequest et contient les paramètres suivants :

Nom

Type

Description

tableName (obligatoire)

String

Le nom de la table.

tunnelName (obligatoire)

String

Le nom du tunnel.

Valeurs de retour

La valeur de retour est de type DescribeTunnelResponse et contient les champs suivants :

Nom

Type

Description

tunnelConsumePoint

Date

Le dernier point de consommation incrémentale du tunnel. La valeur correspond au point de consommation du canal le plus lent du tunnel. Valeur par défaut : 00:00:00 le 1er janvier 1970 (UTC). Appelez getTunnelConsumePoint() pour obtenir ce champ.

tunnelRpo

long

L'objectif de point de reprise (RPO) de la consommation incrémentale du tunnel, qui représente la différence entre l'heure actuelle et le point de consommation du canal le plus lent. Unité : millisecondes. Appelez getTunnelRpo() pour obtenir ce champ.

tunnelInfo

TunnelInfo

Les informations relatives au tunnel. Appelez getTunnelInfo() pour obtenir ce champ. Les champs sont identiques à ceux des objets TunnelInfo renvoyés par List tunnels.

channelInfos

List<ChannelInfo>

La liste des canaux du tunnel. Si le tunnel n'a initialisé aucun canal, une liste vide est renvoyée. Appelez getChannelInfos() pour obtenir ce champ.

Remarque

Les champs tunnelConsumePoint et tunnelRpo s'appliquent uniquement à la consommation incrémentale. Si la consommation incrémentale n'a pas démarré ou si le tunnel consomme uniquement les données complètes, tunnelConsumePoint prend la valeur par défaut. Dans ce cas, n'utilisez pas tunnelRpo pour déterminer la latence de consommation.

Informations sur les canaux

Chaque élément de channelInfos[] est de type ChannelInfo et contient les champs suivants :

Nom

Type

Description

channelId

String

L'ID du canal.

channelType

ChannelType

Le type de canal. Les valeurs valides sont BaseData et Stream, qui indiquent respectivement un canal de données complètes et un canal de données incrémentales.

channelStatus

ChannelStatus

L'état du canal. Les valeurs valides sont WAIT, OPEN, CLOSING, CLOSE et TERMINATED, qui indiquent respectivement en attente, ouvert, en cours de fermeture, fermé et terminé.

clientId

String

L'ID du client qui consomme le canal. Ce champ peut être vide si aucun client n'est assigné au canal. L'ID client est généré à partir de TunnelWorkerConfig.clientTag. Vous pouvez appeler setClientTag() pour personnaliser l'identifiant du client.

channelConsumePoint

Date

Le dernier point de consommation incrémentale du canal. Valeur par défaut : 00:00:00 le 1er janvier 1970 (UTC). Ce champ ne s'applique pas aux canaux de données complètes.

channelRpo

long

L'objectif de point de reprise (RPO) de la consommation incrémentale du canal, qui représente la différence entre l'heure actuelle et channelConsumePoint. Unité : millisecondes. Ce champ ne s'applique pas aux canaux de données complètes.

channelCount

long

Le nombre de lignes synchronisées par le canal.