View a markdown version of this page

Integración de Amazon OpenSearch Service - Amazon CloudWatch
Requisitos previosPaso 1: Definir la configuración de extracciónPaso 2: creación del analizadorMétricas disponiblesValidación de la recopilación de métricasObservabilidad entre cuentasLimitaciones actuales

Integración de Amazon OpenSearch Service

Con un recopilador de Prometheus administrado por Amazon CloudWatch, puede recopilar automáticamente métricas compatibles con Prometheus de sus dominios de Amazon OpenSearch Service. El recopilador administrado se conecta a su VPC, recopila métricas de clústeres, nodos e índices del dominio y envía dichas métricas directamente a CloudWatch. Con esta integración, puede supervisar el estado y el rendimiento de sus dominios en CloudWatch sin necesidad de implementar ningún agente o exportador.

nota

Cuando un recopilador de Prometheus administrado por Amazon CloudWatch envía sus métricas de Amazon OpenSearch Service a CloudWatch, enriquece automáticamente cada métrica con atributos que identifican su origen. Cada métrica incluye el alcance de la instrumentación del recopilador, los atributos en la nube que registran la cuenta y región de AWS y una unidad que el recopilador deduce del nombre de la métrica. Puede filtrar y agrupar estos atributos cuando consulte sus métricas con PromQL.

Requisitos previos

En este procedimiento se presupone que está familiarizado con los conceptos de administración de dominios de Amazon OpenSearch Service y redes de Amazon VPC.

  • Un dominio de Amazon OpenSearch Service con acceso a VPC. Los recopiladores administrados solo admiten dominios que tengan acceso a VPC. No se admiten dominios con acceso público.

  • Al menos dos subredes en diferentes zonas de disponibilidad.

  • Reglas del grupo de seguridad que permitan al recopilador acceder al punto de conexión de su dominio a través de HTTPS (puerto 443). Agregue una regla de entrada al grupo de seguridad del dominio que permita el tráfico HTTPS desde el grupo de seguridad que proporcione para el recopilador.

Paso 1: Definir la configuración de extracción

A continuación, se muestra un ejemplo de configuración de extracción para Amazon OpenSearch Service. El recopilador administrado se conecta al dominio que especifique y recopila sus métricas automáticamente, por lo que no es necesario especificar los destinos de extracción en la configuración. La configuración debe incluir una sección scrape_configs con un trabajo cuyo valor de job_name sea exactamente opensearch-exporter. Haga referencia a esta configuración al crear el extractor en el siguiente paso. Para obtener más información acerca de las opciones de configuración de , consulte Configuración del raspador.

global:
  external_labels:
    domain_name: my-opensearch-domain

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

Paso 2: creación del analizador

Cree el extractor con un destino de CloudWatch. Especifica el dominio desde el que se recopilará en el campo exporters y proporcione la red (subredes y grupo de seguridad) en el campo source.

AWS API

Utilice la operación de la API CreateScraper para crear un extractor con un destino de CloudWatch. Sustituya la información de subred, grupo de seguridad, dominio y conjunto de datos por sus propios valores.

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

Utilice el comando create-scraper para crear un extractor con un destino de CloudWatch. Sustituya la información de subred, grupo de seguridad, dominio y conjunto de datos por sus propios valores.

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étricas disponibles

  • Métricas del clúster: estado del clúster, número de nodos y nodos de datos, particiones activas y de reubicación y tareas pendientes.

  • Métricas de nodos: uso de la CPU, uso de montón de JVM y recopilación de elementos no utilizados, memoria del sistema operativo, uso del disco y actividad del grupo de subprocesos para cada nodo.

  • Métricas de índice: tasas y latencias de indexación y búsqueda, recuentos de documentos, actividad de fusión y actualización y uso de la caché.

Para ver una lista completa de las métricas disponibles, consulte Métricas recopiladas de Amazon OpenSearch Service en la Guía del usuario de Amazon Managed Service para Prometheus.

Validación de la recopilación de métricas

Para confirmar que el recopilador envíe las métricas de su dominio, ejecute la siguiente consulta en CloudWatch con Query Studio. La consulta devuelve el estado del clúster de su dominio. Si devuelve puntos de datos, el recopilador está recopilando correctamente las métricas de su dominio.

opensearch_cluster_health_status

Observabilidad entre cuentas

Para la supervisión de Amazon OpenSearch Service entre cuentas, recomendamos utilizar la centralización de métricas de Amazon CloudWatch. Para obtener más información, consulte Centralización de métricas de CloudWatch.

Para obtener más información sobre configuraciones alternativas de extractores entre cuentas que utilizan el encadenamiento de roles, consulte Integración de Amazon OpenSearch Service en la Guía del usuario de Amazon Managed Service para Prometheus.

Limitaciones actuales

  • Los recopiladores administrados solo admiten dominios con acceso a VPC.

  • Un extractor recopila métricas de un único dominio de Amazon OpenSearch Service. Para recopilar métricas de más de un dominio, cree un extractor independiente para cada dominio.