Tutorial: incorporar datos en una colección mediante Amazon OpenSearch Ingestion - Amazon OpenSearch Service

Tutorial: incorporar datos en una colección 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 una colección de Amazon OpenSearch sin servidor. 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.

Para ver un tutorial que muestra cómo incorporar datos en un dominio de OpenSearch Service aprovisionado, consulte Tutorial: incorporar datos a un dominio mediante Amazon OpenSearch Ingestion.

En este tutorial, deberá completar los siguientes pasos:

En este tutorial creará los recursos siguientes:

  • Una colección llamada ingestion-collection donde escribirá la canalización

  • Una canalización llamada ingestion-pipeline-serverless

Permisos necesarios

Para completar este tutorial, su usuario o rol debe tener una política basada en 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 una colección (aoss:*) y trabajar con canalizaciones (osis:*).

Además, se requieren varios permisos de IAM para crear automáticamente el rol de canalización y transferirlo a OpenSearch Ingestion para que pueda escribir datos en la colección.

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

Paso 1: crear una colección

A continuación, cree una colección para incorporar datos. El nombre que le pondremos a la colección será ingestion-collection.

  1. Vaya a la consola de Amazon OpenSearch Service en https://console.aws.amazon.com/aos/home.

  2. Seleccione Colecciones del panel de navegación de la izquierda y elija Crear colección.

  3. Nombre la colección ingestion-collection.

  4. En Seguridad, elija Creación estándar.

  5. En Configuración de acceso a la red, cambie el tipo de acceso a Público.

  6. Mantenga todas las demás configuraciones en sus valores predeterminados y elija Siguiente.

  7. Ahora, configure una política de acceso a los datos para la colección. Anule la selección de Coincidir automáticamente la configuración de la política de acceso.

  8. Seleccione JSON para el Método de definición y pegue la siguiente política en el editor. Esta política realiza dos tareas:

    • Permite que el rol de canalización escriba en la colección.

    • Le permite leer de la colección. Más adelante, después de incorporar algunos datos de muestra a la canalización, consultará la colección para garantizar que los datos se hayan incorporado y escrito correctamente en el índice.

      [ { "Rules": [ { "Resource": [ "index/ingestion-collection/*" ], "Permission": [ "aoss:CreateIndex", "aoss:UpdateIndex", "aoss:DescribeIndex", "aoss:ReadDocument", "aoss:WriteDocument" ], "ResourceType": "index" } ], "Principal": [ "arn:aws:iam::your-account-id:role/OpenSearchIngestion-PipelineRole", "arn:aws:iam::your-account-id:role/Admin" ], "Description": "Rule 1" } ]
  9. Modifique los elementos Principal para incluir su ID de Cuenta de AWS. Para la segunda entidad principal, especifique un usuario o rol que pueda utilizar para consultar la colección más tarde.

  10. Elija Siguiente. Nombre la política de acceso pipeline-collection-access y elija Siguiente de nuevo.

  11. Revise la configuración de la colección y seleccione Enviar.

Paso 2: crear una canalización

Ahora que tiene una colección, 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 una única colección de OpenSearch sin servidor como el receptor e incorporaremos todos los datos al índice my_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 Colección (sin servidor). Luego, elija la colección de OpenSearch Service que creó en la sección anterior.

    Deje el nombre de la política de red como predeterminado. En Nombre de índice, escriba my_logs. OpenSearch Ingestion crea automáticamente este índice en la colección si aún no existe.

  11. Elija Siguiente.

  12. Asigne el nombre ingestion-pipeline-serverless a la canalización. 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 de colección 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 3: 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 una colección, 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, envíe algunos datos de muestra a la ruta de ingesta. La siguiente solicitud de muestra 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.

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

awscurl --service aoss --region us-east-1 \ -X GET \ https://collection-id.us-east-1.aoss.amazonaws.com/my_logs/_search | json_pp

Respuesta de ejemplo:

{ "took":348, "timed_out":false, "_shards":{ "total":0, "successful":0, "skipped":0, "failed":0 }, "hits":{ "total":{ "value":1, "relation":"eq" }, "max_score":1.0, "hits":[ { "_index":"my_logs", "_id":"1%3A0%3ARJgDvIcBTy5m12xrKE-y", "_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":"2023-04-26T05:22:16.204Z" } } ] } }

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: