Tutorial: incorporar datos a un dominio mediante Amazon OpenSearch Ingestion - Amazon OpenSearch Service

Tutorial: incorporar datos a un dominio mediante Amazon OpenSearch Ingestion

En este tutorial se muestra cómo utilizar Amazon OpenSearch Ingestion para configurar una canalización sencilla e incorporar datos en un dominio de Amazon OpenSearch Service. Una canalización es un recurso que OpenSearch Ingestion aprovisiona y administra. Puede usar una canalización para filtrar, enriquecer, transformar, normalizar y agregar datos para el análisis y la visualización posteriores en OpenSearch Service.

Este tutorial recorre los pasos básicos para poner en marcha una canalización de forma rápida. Para obtener instrucciones más completas, consulte Creación de canalizaciones.

En este tutorial, deberá completar los siguientes pasos:

En este tutorial creará los recursos siguientes:

  • Un dominio llamado ingestion-domain al que la canalización escribe.

  • Una canalización llamada ingestion-pipeline

Permisos necesarios

Para completar este tutorial, su usuario o rol debe tener una política basada en la identidad adjunta con los siguientes permisos mínimos. Estos permisos le permiten crear un rol de canalización y adjuntar una política (iam:Create* y iam:Attach*), crear o modificar un dominio (es:*) y trabajar con canalizaciones (osis:*).

JSON
{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Resource":"*", "Action":[ "osis:*", "iam:Create*", "iam:Attach*", "es:*" ] }, { "Resource":[ "arn:aws:iam::111122223333:role/OpenSearchIngestion-PipelineRole" ], "Effect":"Allow", "Action":[ "iam:CreateRole", "iam:AttachRolePolicy", "iam:PassRole" ] } ] }

Paso 1: crear el rol de canalización

En primer lugar, cree un rol que asuma la canalización para acceder al receptor de dominio de OpenSearch Service. Incluirá esta función en la configuración de la canalización más adelante en este tutorial.

Cómo crear el rol de canalización
  1. Abra la consola AWS Identity and Access Management en https://console.aws.amazon.com/iamv2/.

  2. Seleccione Políticas y, a continuación, seleccione Crear política.

  3. En este tutorial, incorporará datos a un dominio llamado ingestion-domain, que creará en el siguiente paso. Seleccione JSON y pegue la siguiente política en el editor. Sustituya your-account-id por su Identificador de cuenta y modifique la región si es necesario.

    JSON
    { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "es:DescribeDomain", "Resource": "arn:aws:es:us-east-1:111122223333:domain/ingestion-domain" }, { "Effect": "Allow", "Action": "es:ESHttp*", "Resource": "arn:aws:es:us-east-1:111122223333:domain/ingestion-domain/*" } ] }

    Si desea escribir datos en un dominio existente, sustituya ingestion-domain por el nombre de su dominio.

    nota

    Para simplificar este tutorial, utilizaremos una política de acceso amplia. No obstante, en entornos de producción, se recomienda que se aplique una política de acceso más restrictiva a su rol de canalización. Para ver un ejemplo de política que proporciona los permisos mínimos necesarios, consulte Concesión de acceso a dominios para canalizaciones de Amazon OpenSearch Ingestion.

  4. Seleccione Siguiente, seleccione Siguiente y asigne a su política el nombre pipeline-policy.

  5. Seleccione Crear política.

  6. A continuación, cree un rol y añádale la política. Seleccione Roles y, a continuación, Crear rol.

  7. Seleccione Política de confianza personalizada y pegue la siguiente política en el editor:

    JSON
    { "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Principal":{ "Service":"osis-pipelines.amazonaws.com" }, "Action":"sts:AssumeRole" } ] }
  8. Seleccione Siguiente. A continuación, busque y seleccione pipeline-policy (que acaba de crear).

  9. Seleccione Siguiente y asigne al rol el nombre PipelineRole.

  10. Seleccione Crear rol.

Recuerde el nombre de recurso de Amazon (ARN) del rol (por ejemplo, ). , arn:aws:iam::your-account-id:role/PipelineRole). Lo necesitará cuando cree la canalización.

Paso 2: crear un dominio

Primero, cree un dominio denominado ingestion-domain al que desee incorporar datos.

Vaya a la consola de Amazon OpenSearch Service en https://console.aws.amazon.com/aos/home y cree un dominio que cumpla los siguientes requisitos:

  • Funciona en OpenSearch 1.0 o superior, o Elasticsearch 7.4 o superior

  • Utiliza el acceso público

  • No utiliza el control de acceso detallado

nota

Estos requisitos están pensados para garantizar la simplicidad de este tutorial. En los entornos de producción, puede configurar un dominio con acceso a VPC o utilizar un control de acceso detallado. Para utilizar un control de acceso detallado, consulte Map the pipeline role.

El dominio debe tener una política de acceso que otorgue permiso al rol de IAM OpenSearchIngestion-PipelineRole, que OpenSearch Service creará para usted en el siguiente paso. La canalización asumirá este rol para enviar datos al receptor de dominios.

Asegúrese de que el dominio tenga la siguiente política de acceso a nivel de dominio, que otorga al rol de canalización acceso al dominio. Sustituya la Región y el ID de cuenta por los suyos:

JSON
{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/OpenSearchIngestion-PipelineRole" }, "Action": "es:*", "Resource": "arn:aws:es:us-east-1:111122223333:domain/ingestion-domain/*" } ] }

Para obtener más información sobre cómo crear políticas de acceso a nivel de dominio, consulte Políticas basadas en recursos.

Si ya ha creado un dominio, modifique su política de acceso actual para proporcionar los permisos anteriores a OpenSearchIngestion-PipelineRole.

Paso 3: crear una canalización

Ahora que tiene un dominio, puede crear una canalización.

Para crear una canalización
  1. En la consola de Amazon OpenSearch Service, seleccione Canalizaciones en el panel de navegación izquierdo.

  2. Seleccione Create pipeline.

  3. Seleccione la canalización en blanco y, a continuación, elija Seleccionar esquema.

  4. En este tutorial, crearemos una canalización simple que utiliza el complemento de origen HTTP. El complemento acepta datos de registro en un formato de matriz JSON. Especificaremos un único dominio de OpenSearch Service como destino e incorporaremos todos los datos en el índice application_logs.

    En el menú Fuente, seleccione HTTP. Para la ruta, ingrese /logs.

  5. Para simplificar este tutorial, configuraremos el acceso público para la canalización. En las opciones de red de origen, seleccione Acceso público. Para obtener información acerca de la configuración del acceso a VPC, consulte Configuración del acceso a la VPC para canalizaciones de Amazon OpenSearch Ingestion.

  6. Elija Siguiente.

  7. En Procesador, introduzca la fecha y seleccione Agregar.

  8. Habilite Desde la hora de recepción. Deje el resto de opciones con sus valores predeterminados.

  9. Elija Siguiente.

  10. Configure los detalles del destino. Para el tipo de recurso de OpenSearch, elija Clúster administrado. Luego, elija el dominio de OpenSearch Service que usted creó en la sección anterior.

    En Nombre de índice, escriba application_logs. OpenSearch Ingestion crea automáticamente este índice en el dominio si aún no existe.

  11. Elija Siguiente.

  12. Asigne a la canalización el nombre ingestion-pipeline. Deje la configuración de capacidad con sus valores predeterminados.

  13. Para el rol de canalización, seleccione Crear y usar un nuevo rol de servicio. El rol de canalización proporciona los permisos necesarios para que una canalización escriba en el destino del dominio y lea desde orígenes basados en extracción. Al seleccionar esta opción, usted permite que OpenSearch Ingestion cree el rol por usted, en lugar de crearlo manualmente en IAM. Para obtener más información, consulte Configuración de roles y usuarios en Amazon OpenSearch Ingestion.

  14. Para el sufijo del nombre del rol de servicio, ingrese PipelineRole. En IAM, el rol tendrá el formato arn:aws:iam::your-account-id:role/OpenSearchIngestion-PipelineRole.

  15. Elija Siguiente. Revise la configuración de la canalización y elija Crear canalización. La canalización tarda entre 5 y 10 minutos en activarse.

Paso 4: incorporar algunos datos de muestra

Cuando el estado de la canalización sea Active, puede empezar a incorporarle datos. Debe firmar todas las solicitudes HTTP que se envíen a la canalización mediante la versión 4 de Signature. Use una herramienta HTTP como Postman o awscurl para enviar algunos datos a la canalización. Al igual que ocurre con la indexación de datos directamente en un dominio, la incorporación de datos a una canalización siempre requiere un rol de IAM o una clave de acceso y una clave secreta de IAM.

nota

La entidad principal que firma la solicitud debe tener el permiso de IAM osis:Ingest.

Primero, obtenga la URL de incorporación en la página de Configuración de canalización:

Pipeline settings page showing ingestion URL and other configuration details.

A continuación, incorpore algunos datos de muestra. La siguiente solicitud utiliza awscurl para enviar un único archivo de registro a la canalización:

awscurl --service osis --region us-east-1 \ -X POST \ -H "Content-Type: application/json" \ -d '[{"time":"2014-08-11T11:40:13+00:00","remote_addr":"122.226.223.69","status":"404","request":"GET http://www.k2proxy.com//hello.html HTTP/1.1","http_user_agent":"Mozilla/4.0 (compatible; WOW64; SLCC2;)"}]' \ https://pipeline-endpoint.us-east-1.osis.amazonaws.com/logs

Debería ver una respuesta 200 OK. Si recibe un error de autenticación, es posible que se deba a que está incorporando datos de una cuenta distinta a la de la canalización. Consulte Solución de problemas de permisos.

Ahora, consulte el índice application_logs para asegurarse de que la entrada de registro se haya incorporado correctamente:

awscurl --service es --region us-east-1 \ -X GET \ https://search-ingestion-domain.us-east-1.es.amazonaws.com/application_logs/_search | json_pp

Respuesta de ejemplo:

{ "took":984, "timed_out":false, "_shards":{ "total":1, "successful":5, "skipped":0, "failed":0 }, "hits":{ "total":{ "value":1, "relation":"eq" }, "max_score":1.0, "hits":[ { "_index":"application_logs", "_type":"_doc", "_id":"z6VY_IMBRpceX-DU6V4O", "_score":1.0, "_source":{ "time":"2014-08-11T11:40:13+00:00", "remote_addr":"122.226.223.69", "status":"404", "request":"GET http://www.k2proxy.com//hello.html HTTP/1.1", "http_user_agent":"Mozilla/4.0 (compatible; WOW64; SLCC2;)", "@timestamp":"2022-10-21T21:00:25.502Z" } } ] } }

Solución de problemas de permisos

Si ha seguido los pasos del tutorial y sigue viendo errores de autenticación cuando intenta incorporar datos, puede que se deba a que la función que escribe en una canalización Cuenta de AWS no es la canalización misma. En este caso, debe crear y asumir un rol que le permita específicamente incorporar datos. Para obtener instrucciones, consulte Provisión de acceso de ingesta entre cuentas.

Recursos relacionados

Este tutorial presenta un caso práctico sencillo de incorporación de un único documento a través de HTTP. En escenarios de producción, configurará las aplicaciones de cliente (como Fluent Bit, Kubernetes u OpenTelemetry Collector) para enviar datos a una o más canalizaciones. Es probable que sus canalizaciones sean más complejas que en el ejemplo sencillo de este tutorial.

Para empezar a configurar sus clientes e incorporar datos, consulte los siguientes recursos: