Profilage des opérations Amazon DocumentDB

Avant de commencer, créez un cluster Amazon DocumentDB et un groupe de paramètres de cluster personnalisé si vous n'en avez pas déjà un. Pour plus d’informations, consultez Création de groupes de paramètres de cluster Amazon DocumentDB et Création d'un cluster Amazon DocumentDB.

À l'aide d'un groupe de paramètres de cluster personnalisé disponible, modifiez les paramètres suivants. Pour de plus amples informations, veuillez consulter Modification des groupes de paramètres du cluster Amazon DocumentDB.

Modifiez votre cluster pour utiliser le groupe de paramètres de cluster personnalisé et configurez les exportations du journal du profileur pour qu'elles soient publiées sur Amazon CloudWatch.

1. Dans le panneau de navigation, choisissez Clusters pour ajouter votre groupe de paramètres personnalisé à un cluster.

2. Cliquez sur le bouton situé à gauche du nom du cluster auquel vous souhaitez associer votre groupe de paramètres. Sélectionnez Actions, puis Modify (Modifier) pour modifier votre cluster.

3. Sous Cluster options (Options de cluster), choisissez le groupe de paramètres personnalisé à partir de l'étape ci-dessus pour l'ajouter à votre cluster.

4. Sous Exportations de journaux, sélectionnez les journaux Profiler à publier sur Amazon CloudWatch.

5. Sélectionnez Continuer pour afficher un résumé de vos modifications.

6. Après vérification de vos modifications, vous pouvez les appliquer immédiatement ou au cours de la fenêtre de maintenance suivante sous Scheduling of modifications (Planification des modifications).

7. Choisissez Modify cluster (Modifier le cluster) pour mettre à jour votre cluster avec votre nouveau groupe de paramètres.

Avant de commencer, vérifiez qu'un groupe de paramètres de cluster personnalisé est disponible en exécutant la commande suivante et en examinant la sortie d'un groupe de paramètres de cluster qui ne contient pas la valeur default dans son nom et qui comprend docdb3.6 comme famille de groupes de paramètres. Si vous ne disposez pas d'un groupe de paramètres de cluster autre que par défaut, veuillez consulter Création de groupes de paramètres de cluster Amazon DocumentDB.

aws docdb describe-db-cluster-parameter-groups \
    --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName,DBParameterGroupFamily]'

Dans la sortie suivante, seul sample-parameter-group répond à ces deux critères.

[
       [
           "default.docdb3.6",
           "docdb3.6"
       ],
       [
           "sample-parameter-group",
           "docdb3.6"
       ]
]

À l'aide de votre groupe de paramètres de cluster personnalisé, modifiez les paramètres suivants :

aws docdb modify-db-cluster-parameter-group \
    --db-cluster-parameter-group-name sample-parameter-group \
    --parameters ParameterName=profiler,ParameterValue=enabled,ApplyMethod=immediate \
                 ParameterName=profiler_threshold_ms,ParameterValue=100,ApplyMethod=immediate \
                 ParameterName=profiler_sampling_rate,ParameterValue=0.5,ApplyMethod=immediate

Modifiez votre cluster Amazon DocumentDB afin qu'il utilise le groupe de paramètres de cluster sample-parameter-group personnalisé de l'étape précédente et qu'il définisse le paramètre --enable-cloudwatch-logs-exports sur. profiler

Le code suivant modifie le cluster sample-cluster pour utiliser celui sample-parameter-group de l'étape précédente et ajoute profiler aux exportations de CloudWatch journaux activées.

aws docdb modify-db-cluster \
       --db-cluster-identifier sample-cluster \
       --db-cluster-parameter-group-name sample-parameter-group \
       --cloudwatch-logs-export-configuration '{"EnableLogTypes":["profiler"]}'
                  

Le résultat de cette opération ressemble à ceci.

{
    "DBCluster": {
        "AvailabilityZones": [
            "us-east-1c",
            "us-east-1b",
            "us-east-1a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "sample-cluster",
        "DBClusterParameterGroup": "sample-parameter-group",
        "DBSubnetGroup": "default",
        "Status": "available",
        "EarliestRestorableTime": "2020-04-07T02:05:12.479Z",
        "Endpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
        "ReaderEndpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
        "MultiAZ": false,
        "Engine": "docdb",
        "EngineVersion": "3.6.0",
        "LatestRestorableTime": "2020-04-08T22:08:59.317Z",
        "Port": 27017,
        "MasterUsername": "test",
        "PreferredBackupWindow": "02:00-02:30",
        "PreferredMaintenanceWindow": "tue:09:50-tue:10:20",
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "sample-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            },
            {
                "DBInstanceIdentifier": "sample-instance-2",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-abcd0123",
                "Status": "active"
            }
        ],
        "HostedZoneId": "ABCDEFGHIJKLM",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:<accountID>:key/sample-key",
        "DbClusterResourceId": "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "DBClusterArn": "arn:aws:rds:us-east-1:<accountID>:cluster:sample-cluster",
        "AssociatedRoles": [],
        "ClusterCreateTime": "2020-01-10T22:13:38.261Z",
        "EnabledCloudwatchLogsExports": [
            "profiler"
        ],
        "DeletionProtection": true
    }
}

Connectez-vous à la AWS Management Console console Amazon DocumentDB et ouvrez-la à l'adresse https://console.aws.amazon.com/docdb.

Dans le panneau de navigation, choisissez Groupes de paramètres. Choisissez ensuite le nom du groupe de paramètres de cluster sur lequel vous souhaitez désactiver le profileur.

Sur la page Cluster parameters (Paramètres de cluster) qui s'affiche, sélectionnez le bouton situé à gauche du paramètre profiler et choisissez Modifier.

Dans la boîte de dialogue Modify profiler (Modifier le profileur), choisissez disabled dans la liste.

Choisissez Modifier le paramètre de cluster.

Ouvrez la console Amazon DocumentDB à l'adresse https://console.aws.amazon.com/docdb.

Dans le panneau de navigation, choisissez Clusters. Choisissez le bouton à gauche du nom du cluster pour lequel vous souhaitez désactiver l'exportation des journaux.

Dans le menu Actions, choisissez Modify (Modifier).

Faites défiler la page jusqu'à la section Log exports (Exportations de journaux), puis choisissez Profiler logs (Journaux du profileur).

Choisissez Continuer.

Vérifiez vos modifications, puis choisissez quand cette modification devra être appliquée à votre cluster :

• Appliquer pendant la fenêtre de maintenance planifiée suivante

• Appliquer immédiatement

Choisissez Modifier le cluster.