View a markdown version of this page

Intégrez Amazon OpenSearch Service - Amazon CloudWatch
Conditions préalablesÉtape 1 : Configuration de la configuration de scrapeÉtape 2 : Création du grattoirMétriques disponiblesValider la collecte de métriquesCross-account observabilitéLimitations actuelles

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Intégrez Amazon OpenSearch Service

Avec un collecteur Prometheus CloudWatch géré par Amazon, vous pouvez collecter automatiquement des métriques Prometheus compatibles à partir de vos domaines Amazon OpenSearch Service. Le collecteur géré se connecte à votre VPC, collecte les métriques de cluster, de nœud et d'index à partir du domaine et les transmet directement à CloudWatch. Grâce à cette intégration, vous pouvez surveiller l'état et les performances de vos domaines CloudWatch sans avoir à déployer d'agents ou d'exportateurs.

Note

Lorsqu'un collecteur Prometheus CloudWatch géré par Amazon transmet vos métriques Amazon OpenSearch Service à CloudWatch, il enrichit automatiquement chaque métrique avec des attributs qui identifient son origine. Chaque métrique comporte l'étendue de l'instrumentation du collecteur, des attributs de cloud qui enregistrent le AWS compte et la région, et une unité que le collecteur déduit à partir du nom de la métrique. Vous pouvez filtrer et regrouper ces attributs lorsque vous interrogez vos métriques avec ProMQL.

Conditions préalables

Cette procédure suppose que vous êtes familiarisé avec l'administration du domaine Amazon OpenSearch Service et les concepts de mise en réseau Amazon VPC.

  • Un domaine Amazon OpenSearch Service avec accès VPC. Les collecteurs gérés ne prennent en charge que les domaines dotés d'un accès VPC. Les domaines accessibles au public ne sont pas pris en charge.

  • Au moins deux sous-réseaux dans différentes zones de disponibilité

  • Règles de groupe de sécurité qui permettent au collecteur d'atteindre le point de terminaison de votre domaine via HTTPS (port 443). Ajoutez une règle entrante au groupe de sécurité du domaine qui autorise le trafic HTTPS en provenance du groupe de sécurité que vous fournissez au collecteur.

Étape 1 : Configuration de la configuration de scrape

Voici un exemple de configuration de scrape pour Amazon OpenSearch Service. Le collecteur géré se connecte au domaine que vous spécifiez et collecte ses métriques automatiquement. Vous ne spécifiez donc pas de cibles de scrape dans la configuration. La configuration doit inclure une scrape_configs section contenant une job_name tâche préciseopensearch-exporter. Vous ferez référence à cette configuration lorsque vous créerez le scraper à l'étape suivante. Pour plus d'informations sur les options de configuration, consultezConfiguration du scraper.

global:
  external_labels:
    domain_name: my-opensearch-domain

scrape_configs:
  - job_name: opensearch-exporter
    scrape_interval: 60s

Étape 2 : Création du grattoir

Créez le grattoir avec une CloudWatch destination. Vous spécifiez le domaine à partir duquel effectuer les collectes exporters sur le terrain et vous indiquez le réseau (sous-réseaux et groupe de sécurité) source sur le terrain.

AWS API

Utilisez l'opération CreateScraper API pour créer un scraper avec une CloudWatch destination. Remplacez les informations relatives au sous-réseau, au groupe de sécurité, au domaine et à l'ensemble de données par vos propres valeurs.

POST /scrapers HTTP/1.1

{
  "alias": "opensearch-metrics-scraper",
  "source": {
    "vpcConfiguration": {
      "subnetIds": ["subnet-subnet-id-1", "subnet-subnet-id-2"],
      "securityGroupIds": ["sg-security-group-id"]
    }
  },
  "exporters": [
    {
      "openSearchConfiguration": {
        "domainArn": "arn:aws:es:us-west-2:123456789012:domain/my-opensearch-domain"
      }
    }
  ],
  "destination": {
    "cloudWatchConfiguration": {
      "datasetArn": "arn:aws:cloudwatch:us-west-2:123456789012:dataset/default"
    }
  },
  "scrapeConfiguration": {
    "configurationBlob": "base64-encoded-blob"
  }
}
AWS CLI

Utilisez la create-scraper commande pour créer un scraper avec une CloudWatch destination. Remplacez les informations relatives au sous-réseau, au groupe de sécurité, au domaine et à l'ensemble de données par vos propres valeurs.

aws amp create-scraper \
  --alias "opensearch-metrics-scraper" \
  --source '{
    "vpcConfiguration": {
      "subnetIds": ["subnet-subnet-id-1", "subnet-subnet-id-2"],
      "securityGroupIds": ["sg-security-group-id"]
    }
  }' \
  --exporters '[
    {
      "openSearchConfiguration": {
        "domainArn": "arn:aws:es:us-west-2:123456789012:domain/my-opensearch-domain"
      }
    }
  ]' \
  --scrape-configuration configurationBlob=$(base64 -w 0 opensearch-config.yaml) \
  --destination '{
    "cloudWatchConfiguration": {
      "datasetArn": "arn:aws:cloudwatch:us-west-2:123456789012:dataset/default"
    }
  }'

Métriques disponibles

  • Métriques du cluster  : santé et état du cluster, nombre de nœuds et de nœuds de données, partitions actives et déplacées et tâches en attente.

  • Métriques des nœuds  : utilisation du processeur, utilisation du tas de machines virtuelles Java et collecte des déchets, mémoire du système d'exploitation, utilisation du disque et activité du pool de threads pour chaque nœud.

  • Métriques d'indexation  : taux et latences d'indexation et de recherche, nombre de documents, activités de fusion et d'actualisation, utilisation du cache.

Pour obtenir la liste complète des mesures disponibles, consultez la section Mesures collectées auprès d'Amazon OpenSearch Service dans le guide de l'utilisateur d'Amazon Managed Service for Prometheus.

Valider la collecte de métriques

Pour vérifier que le collecteur fournit des métriques depuis votre domaine, exécutez la requête suivante dans CloudWatch Query Studio. La requête renvoie l'état de santé du cluster pour votre domaine. S'il renvoie des points de données, cela signifie que le collecteur collecte les métriques de votre domaine avec succès.

opensearch_cluster_health_status

Cross-account observabilité

Pour la surveillance d'Amazon OpenSearch Service entre comptes, nous vous recommandons d'utiliser la centralisation des CloudWatch métriques Amazon. Pour plus d'informations, consultez la section Centralisation CloudWatch des métriques.

Pour plus d'informations sur les autres configurations de scraper inter-comptes utilisant le chaînage de rôles, consultez Intégrer Amazon OpenSearch Service dans le guide de l'utilisateur d'Amazon Managed Service for Prometheus.

Limitations actuelles

  • Les collecteurs gérés ne prennent en charge que les domaines dotés d'un accès VPC.

  • Un scraper collecte des métriques à partir d'un seul domaine Amazon OpenSearch Service. Pour collecter des métriques provenant de plusieurs domaines, créez un scraper distinct pour chaque domaine.