Suivi actif dans Amazon SNS

Vous pouvez l'utiliser AWS X-Ray pour suivre et analyser les demandes des utilisateurs lorsqu'elles passent par vos rubriques Amazon SNS jusqu'à vos abonnements Amazon Data Firehose, Amazon AWS LambdaSQS et HTTP/S endpoint. Dans la mesure où X-Ray vous donne un end-to-end aperçu de l'intégralité d'une demande, vous pouvez voir ce qui s'appelle votre rubrique Amazon SNS et ce qui se trouve en aval des abonnements à votre rubrique. Vous pouvez analyser les latences de vos messages et de leurs services backend (par exemple, combien de temps une demande passe dans une rubrique et combien de temps il a fallu pour transmettre le message à chacun des abonnements de la rubrique).

Important

Les rubriques Amazon SNS ayant de nombreux abonnements peuvent atteindre une taille limite et ne pas être entièrement suivies. Pour plus d'informations sur les limites de taille des documents de suivi, consultez la section Quotas des services de radiographie dans la section Référence AWS générale.

Si vous appelez une API Amazon SNS à partir d'un service qui est déjà suivi, Amazon SNS transmet le suivi, même si le suivi X-Ray n'est pas activé sur l'API.

Amazon SNS prend en charge le suivi X-Ray pour les rubriques standard et FIFO. Vous pouvez activer X-Ray pour une rubrique Amazon SNS à l'aide de la console Amazon SNS, de l'API Amazon SNS SetTopicAttributes, de la Référence d'interface de ligne de commande Amazon Simple Notification Service ou d'AWS CloudFormation.

Pour en savoir plus sur l'utilisation d'Amazon SNS avec X-Ray, consultez Amazon SNS et AWS X-Ray dans le Guide du développeur AWS X-Ray .

Autorisations de suivi actif

Lorsque vous utilisez la console Amazon SNS, Amazon SNS tente de créer les autorisations nécessaires pour que la rubrique Amazon SNS appelle X-Ray. La tentative peut être rejetée si vous ne disposez pas des autorisations nécessaires pour utiliser la console Amazon SNS. Pour plus d’informations, consultez Gestion des identités et des accès dans Amazon SNS et Cas d'exemple pour le contrôle d'accès Amazon SNS.

Lorsque vous utilisez l'interface de ligne de commande, vous devez configurer les autorisations manuellement. Ces autorisations sont configurées à l'aide de politiques de ressources. Pour en savoir plus sur l'utilisation des autorisations requises dans X-Ray, consultez Amazon SNS et AWS X-Ray.

Activation du suivi actif sur une rubrique Amazon SNS à l'aide de la console AWS

Lorsque le suivi actif est activé sur une rubrique Amazon SNS, il lit l'ID de suivi, envoie les données au client en fonction de l'ID de suivi et propage l'ID de suivi aux services en aval.

1. Connectez-vous à la console Amazon SNS.

2. Choisissez une rubrique ou créez-en une. Pour plus d'informations sur la création de rubriques, consultez Création d'une rubrique Amazon SNS.

3. Sur la page Créer une rubrique, dans la section Détails, choisissez un type de rubrique : FIFO ou Standard.

   1. Entrez un Nom pour la rubrique.

   2. (Facultatif) Entrez un Nom d'affichage pour votre rubrique.

4. Développez Active tracing (Suivi actif) et choisissez Use active tracing (Utiliser le suivi actif).

Une fois que vous avez activé X-Ray pour votre rubrique Amazon SNS, vous pouvez utiliser la carte des services X-Ray pour afficher les end-to-end traces et les cartes de service associées à cette rubrique.

Activation du suivi actif sur une rubrique Amazon SNS à l'aide du SDK AWS

L'exemple de code suivant montre comment activer le suivi actif sur une rubrique Amazon SNS à l'aide du AWS SDK pour Java.

public static void enableActiveTracing(SnsClient snsClient, String topicArn) {

        try {

            SetTopicAttributesRequest request = SetTopicAttributesRequest.builder()
                .attributeName("TracingConfig")
                .attributeValue("Active")
                .topicArn(topicArn)
                .build();

            SetTopicAttributesResponse result = snsClient.setTopicAttributes(request);
            System.out.println("\n\nStatus was " + result.sdkHttpResponse().statusCode() + "\n\nTopic " + request.topicArn()
                + " updated " + request.attributeName() + " to " + request.attributeValue());

        } catch (SnsException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
        }
    }

Activation du suivi actif sur une rubrique Amazon SNS à l'aide de la CLI AWS

L'exemple de code suivant montre comment activer le suivi actif sur une rubrique Amazon SNS à l'aide de la CLI AWS .

aws sns set-topic-attributes \
    --topic-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
    --attribute-name TracingConfig \
    --attribute-value Active

Activation du suivi actif sur une rubrique Amazon SNS à l'aide de AWS CloudFormation

La AWS CloudFormation pile suivante montre comment activer le suivi actif sur une rubrique Amazon SNS.

AWSTemplateFormatVersion: 2010-09-09
Resources:
  MyTopicResource:
    Type: 'AWS::SNS::Topic'
    Properties:
      TopicName: 'MyTopic'
      TracingConfig: 'Active'

Vérifier que le suivi actif est activé pour votre rubrique

Vous pouvez utiliser la console Amazon SNS pour vérifier si le suivi actif est activé pour votre rubrique ou quand la politique de ressources n'a pas pu être ajoutée.

1. Connectez-vous à la console Amazon SNS.

2. Dans le panneau de navigation de gauche, choisissez Rubriques.

3. Sur la page Topics (Rubriques), choisissez une rubrique.

4. Sélectionnez l'onglet Integrations (Intégrations).

   Lorsque le suivi actif est activé, une icône Active (Actif) verte s'affiche.

5. Si vous avez activé le suivi actif et que vous ne voyez pas que la politique de ressources a été ajoutée, choisissez Create policy (Créer une politique) pour ajouter les autorisations supplémentaires requises.

Tester le suivi actif

1. Connectez-vous à la console Amazon SNS.

2. Créer une rubrique Amazon SNS. Pour plus d'informations sur la manière de procéder, consultez Pour créer un sujet à l'aide du AWS Management Console.

3. Développez Active tracing (Suivi actif) et choisissez Use active tracing (Utiliser le suivi actif).

4. Publiez un message dans la rubrique Amazon SNS. Pour plus d'informations sur la manière de procéder, consultez Pour publier des messages dans une rubrique Amazon SNS à l'aide de la AWS Management Console.

5. Utilisez la carte des services X-Ray pour afficher les end-to-end traces et les cartes de service associées au sujet.