Surveillance d'Amazon DocumentDB

Instana surveille votre infrastructure Amazon ( DocumentDB ) et offre une visibilité sur votre environnement grâce au capteur Amazon ( DocumentDB ).

Une fois l'agent « Instana » installé, le capteur « Amazon DocumentDB » est automatiquement déployé et installé. Vous pouvez consulter les indicateurs liés à Amazon DocumentDB dans l'interface utilisateur d' Instana.

Amazon DocumentDB prend en charge les clusters basés sur des instances et les clusters élastiques. Le capteur Amazon DocumentDB surveille les deux types de grappes et les instances de grappes basées sur des instances.

Pour les clusters basés sur des instances, le capteur Amazon DocumentDB prend en charge les versions suivantes du moteur :

  • 5.0.0 (par défaut)
  • 4.0.0
  • 3.6.0

Pour plus d'informations sur les autres services pris en charge par l' AWS, consultez la documentation de l' AWS.

Droits requis

Le capteur Amazon DocumentDB nécessite l'autorisation de AWS Identity and Access Management (IAM) pour collecter des mesures à partir d'Amazon DocumentDB:

  • docdb-elastic:ListClusters
  • docdb-elastic:GetCluster
  • docdb-elastic:ListTagsForResource
  • rds:DescribeDBClusters
  • rds:DescribeDBInstances
  • rds:ListTagsForResource

Configuration du capteur Amazon DocumentDB

Une fois l'agent hôte d' Instana s installé, Instana est configuré automatiquement pour surveiller les clusters et les instances Amazon DocumentDB par défaut.

Les données de mesure pour l' DocumentDB d'Amazon sont collectées toutes les minutes; vous pouvez modifier cette fréquence en utilisant la configuration suivante dans le fichier de configuration de l'agent <agent_install_dir>/etc/instana/configuration.yamlInstana :

com.instana.plugin.aws.documentdb:
  cloudwatch_period: 300

Désactivation du capteur

Pour désactiver la surveillance des clusters et instances DocumentDB, utilisez la configuration suivante :

com.instana.plugin.aws.documentdb:
  enabled: false

Activation de la configuration du proxy

Pour permettre au capteur Amazon DocumentDB d'utiliser le proxy, ajoutez les paramètres de configuration de l'agent suivants :

com.instana.plugin.aws.documentdb:
  proxy_host: 'example.com' # proxy host name or ip address
  proxy_port: 3128 # proxy port
  proxy_protocol: 'HTTP' # proxy protocol: HTTP or HTTPS
  proxy_username: 'username' # OPTIONAL: proxy username
  proxy_password: 'password' # OPTIONAL: proxy password

Surveillance de plusieurs comptes AWS

Pour mettre en place la surveillance de plusieurs comptes AWS avec un agent AWS dans la même région, vous pouvez utiliser deux approches. Pour plus d'informations, voir Surveillance de plusieurs AWS comptes.

Approche des profils nommés AWS

Dans l'approche des profils nommés de AWS, vous pouvez définir le profil. Pour remplacer les profils utilisés pour surveiller DocumentDB, utilisez la configuration suivante dans le fichier de configuration de l'agent :

com.instana.plugin.aws.documentdb:
  profile_names:
    - 'profile2'
    - 'profile3'
Remarque : si vous définissez des profils au niveau du service, ceux-ci prévalent sur la configuration des profils globaux d' AWS.

AWS Approche du service de jetons de sécurité (STS)

Pour remplacer les rôles IAM utilisés pour surveiller Amazon DocumentDB, utilisez la configuration suivante dans le fichier de configuration de l'agent :

com.instana.plugin.aws.documentdb:
  role_arns:
    - 'arn:aws:iam::<account_1_id>:role/<role_1_name>'
    - 'arn:aws:iam::<account_2_id>:role/<role_2_name>'
Remarque : si vous définissez des rôles IAM au niveau du service, ceux-ci prévalent sur la configuration des rôles IAM globaux de AWS.

Filtrer les services par balises

Instana surveille par défaut tous les services d' DocumentDB d'Amazon. Vous pouvez définir les services que vous souhaitez surveiller en définissant plusieurs balises, séparées par une virgule. Vous devez fournir les balises sous la forme d'une paire clé-valeur séparée par deux points ( :) dans le fichier configuration.yaml. Pour configurer facilement le capteur Amazon DocumentDB, vous pouvez définir les balises que vous souhaitez inclure ou exclure de la détection. Si des balises sont définies dans les deux listes (inclusion et exclusion), la liste d'exclusion a une priorité plus élevée. Si le filtrage au niveau du service n'est pas nécessaire, vous n'avez pas besoin de définir la configuration pour DocumentDB, car celle-ci est déjà définie au niveau de la configuration de AWS.

Vous pouvez spécifier l'intervalle du capteur (par défaut 60 secondes) pour interroger les ressources marquées AWS en utilisant la propriété de configuration tagged-services-poll-rate.

Remarque : les balises ne sont disponibles qu'avec l' agent « AWS ».

Pour définir l'intervalle entre les capteurs et les ressources marquées AWS, utilisez la configuration suivante :

com.instana.plugin.aws:
  tagged-services-poll-rate: 60 #default 60

Pour inclure les services par balises dans la découverte, mettez à jour la configuration suivante :

com.instana.plugin.aws.documentdb:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

Pour exclure les services par balises de la découverte, mettez à jour la configuration suivante :

com.instana.plugin.aws.documentdb:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

Les services AWS sans balises sont surveillés par défaut, mais vous pouvez les exclure en remplaçant le champ include_untagged par false, comme le montre l'exemple suivant :

com.instana.plugin.aws.documentdb:
  include_untagged: false # True value by default

Affichage des mesures

Pour afficher les métriques, suivez les étapes suivantes :

  1. Dans le menu de navigation de l'interface utilisateur d' Instana, sélectionnez « Infrastructure ».
  2. Cliquez sur une instance Amazon surveillée spécifique DocumentDB. Vous pouvez voir le tableau de bord de l'instance Amazon DocumentDB avec toutes les mesures collectées.
  3. Dans le fil d'Ariane situé en haut à gauche du tableau de bord, sélectionnez le cluster associé à l'instance. Vous pouvez voir les métriques de la grappe.

DocumentDB Cluster basé sur les instances

Les sections suivantes présentent les données de configuration et les mesures collectées pour les clusters basés sur les instances DocumentDB.

Données de configuration

Le tableau suivant présente les données de configuration collectées pour le cluster Amazon DocumentDB basé sur une instance :

DocumentDB détails du cluster Description
ARN Le nom de ressource Amazon (ARN) du cluster basé sur l'instance DocumentDB.
Type de cluster Le type de cluster (basé sur des instances ou élastique).
Heure de création du cluster L'heure à laquelle le cluster a été créé.
Nom Nom du cluster.
Version du moteur La version du moteur de la grappe. La valeur est 5.0.0 (par défaut), 4.0.0, ou 3.6.0.

Métriques

Le tableau suivant présente les détails des mesures pour le cluster Amazon DocumentDB basé sur une instance :

Métriques du cluster Description
Utilisation de l'UC Pourcentage d'utilisation de l'UC. Pour les clusters, cette mesure représente une agrégation des valeurs d'utilisation du CPU de toutes les instances.
DatabaseConnections Nombre de connexions ouvertes sur un cluster, collectées à une fréquence d'une minute.
Volume ReadIOPs Le nombre moyen d'opérations d'E/S en lecture facturées à partir d'un volume de cluster, qui sont rapportées à des intervalles de 5 minutes.
Volume WriteIOPs Le nombre moyen d'opérations d'E/S en écriture facturées à partir d'un volume de cluster, qui sont rapportées à des intervalles de 5 minutes.
Documents supprimés Nombre de documents supprimés en une minute.
Documents insérés Nombre de documents insérés en une minute.
Documents mis à jour Nombre de documents mis à jour en une minute.
Documents renvoyés Nombre de documents renvoyés en une minute.
Débit de lecture Nombre moyen d'octets lus depuis le disque par seconde.
Débit d'écriture Nombre moyen d'octets écrits sur le disque par seconde.
Transactions ouvertes Nombre de transactions ouvertes dans un cluster en une minute.
Nombre max de transactions ouvertes Nombre maximum de transactions ouvertes sur un cluster en une minute.
Transactions ouvertes utilisées Transactions ouvertes ÷ Transactions ouvertes max * 100.
Temps d'attente de lecture Durée moyenne des opérations d'E/S en lecture sur le disque.
Temps d'attente d'écriture Temps moyen (en millisecondes) nécessaire à chaque opération d'E/S sur disque.
ReplicaLag s maximales de DBCluster Le délai maximum (en millisecondes) entre l'instance primaire et chaque instance Amazon DocumentDB dans le cluster.
DBCluster ReplicaLag minimum Le délai minimum (en millisecondes) entre l'instance primaire et chaque instance répliquée dans le cluster.
Transactions commencées Nombre de transactions lancées en une minute.
Transactions abandonnées Nombre de transactions interrompues en une minute.
Transactions validées Nombre de transactions effectuées en une minute.

DocumentDB par exemple

Le capteur Amazon DocumentDB collecte les données suivantes auprès de l'instance Amazon DocumentDB :

Données de configuration

DocumentDB détails de l'instance Description
ARN d'instance Le nom de ressource Amazon (ARN) de l'instance DocumentDB.
ARN du cluster L'ARN du cluster DocumentDB qui contient l'instance.
Heure de création de l'instance L'heure à laquelle l'instance est créée et ajoutée au cluster.
Nom Le nom de l'instance DocumentDB.
Niveau de promotion Le rôle qu'une instance joue au sein du cluster au moment du basculement et de la haute disponibilité. L'instance ayant la valeur de niveau de promotion la plus basse (généralement 1) a la priorité la plus élevée pour devenir la nouvelle instance primaire.

Métriques

Le tableau suivant présente les détails des mesures pour l'instance Amazon DocumentDB :

Métriques de noeud Description
Utilisation de l'UC Pourcentage d'utilisation de l'UC.
Connexions de base de données Le nombre de connexions ouvertes sur une instance, collectées à une fréquence d'une minute.
Nombre max de connexions à la base de données Le nombre maximum de connexions à la base de données qui sont ouvertes sur une instance en une minute.
Connexions de base de données utilisées Connexions de base de données ÷ Connexions de base de données Max * 100.
ReadIOPs Nombre moyen d'opérations de lecture du disque par seconde.
WriteIOPs Nombre moyen d'opérations d'écriture sur le disque par seconde.
Documents supprimés Nombre de documents supprimés en une minute.
Documents insérés Nombre de documents insérés en une minute.
Documents mis à jour Nombre de documents mis à jour en une minute.
Documents renvoyés Nombre de documents renvoyés en une minute.
Débit de lecture Nombre moyen d'octets lus depuis le disque par seconde.
Débit d'écriture Nombre moyen d'octets écrits sur le disque par seconde.
Transactions ouvertes Le nombre de transactions ouvertes dans une instance en une minute.
Nombre max de transactions ouvertes Le nombre maximum de transactions ouvertes sur une instance en une minute.
Transactions ouvertes utilisées Transactions ouvertes ÷ Transactions ouvertes max * 100.
Temps d'attente de lecture Durée moyenne des opérations d'E/S en lecture sur le disque.
Temps d'attente d'écriture Temps moyen (en millisecondes) nécessaire à chaque opération d'E/S sur disque.
ReplicaLag de l'instance de base de données Le temps de latence lorsque les mises à jour sont répliquées de l'instance primaire vers une instance répliquée.
Transactions commencées Nombre de transactions lancées en une minute.
Transactions abandonnées Nombre de transactions interrompues en une minute.
Transactions validées Nombre de transactions effectuées en une minute.

DocumentDB groupe élastique

Le capteur Amazon DocumentDB collecte les données suivantes auprès du cluster élastique Amazon DocumentDB :

Données de configuration

DocumentDB détails du cluster élastique Description
ARN Le nom de ressource Amazon (ARN) du cluster élastique DocumentDB.
Type de cluster Le type de cluster (basé sur des instances ou élastique).
Heure de création du cluster L'heure à laquelle le cluster a été créé.
Nom Nom du cluster.

Métriques

Métriques du cluster Description
Utilisation de l'UC Le pourcentage d'utilisation du CPU de l'instance primaire.
DatabaseConnections Nombre de connexions ouvertes sur un cluster, collectées à une fréquence d'une minute.
Volume ReadIOPs Le nombre moyen d'opérations d'E/S en lecture facturées à partir d'un volume en cluster qui sont rapportées à des intervalles de 5 minutes.
Volume WriteIOPs Le nombre moyen d'opérations d'E/S en écriture facturées à partir d'un volume en cluster qui sont rapportées à des intervalles de 5 minutes.
Documents supprimés Nombre de documents supprimés en une minute.
Documents insérés Nombre de documents insérés en une minute.
Documents mis à jour Nombre de documents mis à jour en une minute.
Documents renvoyés Nombre de documents renvoyés en une minute.
Débit de lecture Nombre moyen d'octets lus depuis le disque par seconde.
Débit d'écriture Nombre moyen d'octets écrits sur le disque par seconde.