Guía de configuración rápida para Event Streams para IBM Cloud

Paso 2: Suministrar una instancia de Event Streams utilizando la consola

1. Inicie la sesión en la consola de IBM Cloud.

2. Pulse Servicio de Event Streams en Catálogo.

3. Seleccione el Plan Lite, el Plan estándar o el Plan empresarial en la sección Seleccionar un plan de precios.

4. Escriba un nombre para el servicio. Puede utilizar el valor predeterminado.

5. Pulse Crear. Se abre la página Event Streams Lista de recursos.

6. Cuando se haya creado la instancia, pulse el nombre de la instancia para ver más información.

7. Opcional. Puede completar los pasos de la Guía de aprendizaje de iniciación para ejecutar una app de inicio de ejemplo.

Paso 2: Suministrar una instancia de Event Streams utilizando la CLI

Si es la primera vez que utiliza la CLI, consulte Iniciación a la CLI.

Para aprovisionar una instancia del plan estándar de Event Streams con la CLI de IBM Cloud, complete los siguientes pasos:

1. Instale la CLI de IBM Cloud siguiendo los pasos de Iniciación a la CLI de IBM Cloud.

2. Inicie una sesión en IBM Cloud con el siguiente mandato:

   ibmcloud login -a cloud.ibm.com
   

3. Cree una instancia de Event Streams en IBM Cloud utilizando los planes Lite, Estándar o Empresa.

   Seleccione uno de los siguientes métodos:

   • Para crear una instancia desde la CLI en el plan Enterprise, ejecute el mandato siguiente:

     ibmcloud resource service-instance-create <INSTANCE_NAME> messagehub enterprise-3nodes-2tb <REGION>
     

     Dado que el plan Enterprise tiene sus propios recursos dedicados para cada clúster, requiere más tiempo para el aprovisionamiento, por lo que una nueva instancia Enterprise puede tardar hasta 3 horas.

   • Para crear una instancia desde la CLI en el plan Standard, ejecute el mandato siguiente:

     ibmcloud resource service-instance-create <INSTANCE_NAME> messagehub standard <REGION>
     

     El aprovisionamiento de una nueva instancia del plan Standard es instantáneo porque los recursos subyacentes ya están configurados.

Paso 2: Suministrar una instancia de Event Streams utilizando la API del controlador de recursos

El método preferido para suministrar una instancia es utilizar la CLI.

De forma alternativa, puede utilizar la API de controlador de recursos. En primer lugar, recupere una señal de acceso y, a continuación, ejecute un mandato de API de controlador de recursos con la señal de acceso para crear la instancia.

curl -X POST https://resource-controller.cloud.ibm.com/v2/resource_instances -H "Authorization: ${token}" -H "Content-Type: application/json" \
-d '{ "name": "JG-test-curl", "target": "us-south", "resource_group":"9eba3cff1b0540b9ab7fb93829911da0", "resource_plan_id": "ibm.message.hub.enterprise.3nodes.2tb", "parameters":{"service-endpoints":"public","throughput":"150"}}'

Paso 3: Crear un tema y seleccionar el número de particiones utilizando la consola

Para obtener ayuda sobre los valores que puede modificar al crear temas, consulte configuración de temas.

1. Desde la instancia recién suministrada, vaya a Temas utilizando el menú de la izquierda.

2. Pulse el botón Crear tema y especifique un nombre de tema. Pulse Siguiente. Los nombres de temas están restringidos a un máximo de 200 caracteres.

3. Seleccione el número de particiones.

   Una o varias particiones componen un tema. Una partición es una lista ordenada de mensajes. 1 partición es suficiente para empezar, pero los sistemas de producción a menudo tienen más.

   Las particiones se distribuyen entre los intermediarios para aumentar la escalabilidad de su tema. También puede utilizarlas para distribuir mensajes entre los miembros de un grupo de consumidores.

   Pulse Siguiente.

4. Establezca el periodo de retención de mensajes. Indica durante cuánto tiempo se retienen los mensajes antes de suprimirlos. Si un consumidor no lee sus mensajes durante este plazo de tiempo, se perderán. El periodo de retención predeterminado para los mensajes es de 24 horas. El valor mínimo es de 1 hora y el máximo de 30 días. Especifique este valor como múltiplo de horas.

   Haz clic en Crear tema.

Paso 3: Crear un tema y seleccionar el número de particiones utilizando la CLI

Para obtener ayuda sobre los valores que puede modificar al crear temas, consulte configuración de temas.

Utilice el siguiente mandato ibmcloud es topic-create para crear un nuevo tema con el número de particiones elegido:

ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value

Nombre de tema. Los nombres de temas están restringidos a un máximo de 200 caracteres.

--partitions value, -p value

Establecer el número de particiones para el tema.

Una o varias particiones componen un tema. Una partición es una lista ordenada de mensajes. 1 partición es suficiente para empezar, pero los sistemas de producción a menudo tienen más.

Las particiones se distribuyen entre los intermediarios para aumentar la escalabilidad de su tema. También puede utilizarlas para distribuir mensajes entre los miembros de un grupo de consumidores.

--config CLAVE=VALOR, -c CLAVE=VALOR(opcional)

Establecer una opción de configuración para el tema como par CLAVE=VALOR.

Puede especificar varias opciones --config. Cada opción '--config' puede especificar una lista de asignaciones delimitada por puntos y comas. La siguiente lista muestra las claves de configuración válidas:

• cleanup.policy
• retention.ms
• retention.bytes
• segment.bytes
• segment.ms
• segment.index.bytes

El periodo de retención predeterminado para los mensajes especificado por la clave retention.ms es de 24 horas. El valor mínimo es de 1 hora y el máximo de 30 días. Especifique este valor como múltiplo de horas.

ibmcloud es topics [--filter FILTER] [--json]

ibmcloud es cluster [--json]

Paso 3: Crear un tema y seleccionar el número de particiones utilizando la API REST de administración

Event Streams proporciona una API REST para la administración que puede utilizar para crear y listar temas.

Puede crear un tema Kafka emitiendo una solicitud POST a la vía de acceso /admin/topics. El cuerpo de la solicitud debe contener un documento JSON. Por ejemplo:

{
    "name": "topicname",
    "partitions": 1,
    "configs": {
        "retentionMs": 86400000,
        "cleanupPolicy": "delete"
    }
}

El documento JSON debe contener un atributo name, especificando el nombre del tema Kafka que se va a crear. Los nombres de tema están restringidos a un máximo de 200 characters.The también puede especificar el número de particiones que se asignarán al tema (utilizando la propiedad partitions ). Si no se especifica el número de particiones, el tema se crea con una sola partición.

Una o varias particiones componen un tema. Una partición es una lista ordenada de mensajes. 1 partición es suficiente para empezar, pero los sistemas de producción a menudo tienen más.

Las particiones se distribuyen entre los intermediarios para aumentar la escalabilidad de su tema. También puede utilizarlas para distribuir mensajes entre los miembros de un grupo de consumidores.

También puede especificar un objeto configs opcional dentro de la solicitud. Esto le permite especificar la propiedad retentionMs, que controla cuánto tiempo (en milisegundos) Kafka retiene los mensajes publicados en el tema. Una vez transcurrido este tiempo, los mensajes se suprimen automáticamente para liberar espacio. Debe especificar el valor de la propiedad retentionMs en un número entero de horas (por ejemplo, múltiplos de 3600000). El periodo de retención predeterminado para los mensajes es de 24 horas. El valor mínimo es de 1 hora y el máximo de 30 días.

Para obtener ayuda sobre los valores que puede modificar al crear temas, consulte configuración de temas.

Los códigos de estado de HTTP previstos son los siguientes:

• 202: Se ha aceptado la solicitud de creación de tema.
• 400: JSON de solicitud no válido.
• 403: No tiene autorización para crear el tema.
• 422: Solicitud no válida semánticamente.

Si la solicitud para crear un tema de Kafka tiene éxito, se devuelve el código de estado 202 (Aceptado) de HTTP. Si la operación falla, se devuelve un código de estado HTTP e de 422 (entidad no procesable) y un objeto JSON que contiene información adicional sobre el fallo como cuerpo de la respuesta.

curl -i -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: Bearer ${TOKEN}' --data '{ "name": "newtopic", "partitions": 1}' ${ADMIN_URL}/admin/topics

[
  {
    "name": "topic1",
    "partitions": 1,
    "retentionMs": 86400000,
    "cleanupPolicy": "delete"
  },
  { "name": "topic2",
    "partitions": 2,
    "retentionMs": 86400000,
    "cleanupPolicy": "delete"
  }
]

curl -i -X GET -H 'Accept: application/json' -H 'Authorization: Bearer ${TOKEN}' ${ADMIN_URL}/admin/topics

Paso 4: Crear una credencial de servicio utilizando la consola

Para permitirle conectarse a la instancia de Event Streams, cree una clave de servicio utilizando la consola de IBM Cloud:

1. Localice el servicio Event Streams en la Lista de recursos.
2. Pulse el mosaico del servicio.
3. Pulse Credenciales de servicio.
4. Pulse Nueva credencial.
5. Especifique los detalles de la nueva credencial, por ejemplo, un nombre y un rol y, a continuación, pulse Añadir. Aparece una nueva credencial en la lista de credenciales.
6. Expanda la sección de la nueva credencial para mostrar los detalles en formato JSON.

Paso 4: Crear una credencial de servicio utilizando la CLI

Cree una clave de servicio utilizando la CLI IBM Cloud, para que pueda conectarse a la instancia de Event Streams:

1. Localice el servicio:

   ibmcloud resource service-instances
   

2. Cree una clave de servicio:

   ibmcloud resource service-key-create <key_name> <key_role> --instance-name <your_service_name>
   

3. Imprima la clave de servicio:

   ibmcloud resource service-key <key_name>
   

   Cada clave de servicio contiene un único conjunto de detalles de punto final. Para las instancias de servicio configuradas para conectarse a un único tipo de red, ya sea la red pública IBM Cloud (el valor predeterminado) o la red privada IBM Cloud, la clave de servicio contiene los detalles relevantes para ese tipo de red. Para las instancias configuradas para dar soporte a las redes pública y privada, se devuelven los detalles de la red pública. Si desea detalles para la red privada, debe añadir el parámetro --service-endpoint private al mandato de CLI service-key-create anterior. Por ejemplo:

   ibmcloud resource service-key-create <private-key-name> <role> --instance-name <instance-name> --service-endpoint private
   

Paso 4: Crear una credencial de servicio utilizando la CLI y la API de productor REST

Para conectarse a la instancia de Event Streams, el mecanismo de autenticación soportado utiliza una señal portadora. Para obtener su token utilizando la CLI de IBM Cloud, primero inicie sesión en IBM Cloud y luego ejecute el siguiente comando:

ibmcloud iam oauth-tokens

Coloque esta señal en la cabecera de autorización de la solicitud HTTP en forma de Bearer<token>. Se admiten tanto señales de clave de API como señales JWT.

Paso 5: Producir datos utilizando la consola

No puede producir datos utilizando la consola. Puede generar datos utilizando la línea de mandatos, la API del productor REST o la APIKafka.

Sin embargo, puede completar los pasos para la consola en la Guía de aprendizaje de iniciación para ejecutar una app de inicio de ejemplo y ver los mensajes que fluyen a través de un tema.

Paso 5: Producir datos utilizando la línea de mandatos

Puede utilizar la herramienta de productor de consola Event Streams Kafka para generar datos. Las herramientas de consola se encuentran en el directorio bin de la descarga del cliente Kafka, que puede descargar desde descargas deApache Kafka. Le recomendamos que descargue la última versión binaria estable disponible. Las versiones de cliente Kafka son compatibles con la versión de Kafka en el servidor.

Debe proporcionar una lista de intermediarios (utilizando la propiedad BOOTSTRAP_ENDPOINTS) y credenciales SASL.

Para proporcionar las credenciales SASL a esta herramienta, cree un archivo de propiedades basado en el siguiente ejemplo:

    sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username="<user>" password="<api_key>";
    security.protocol=SASL_SSL
    sasl.mechanism=PLAIN
    ssl.protocol=TLSv1.2
    ssl.enabled.protocols=TLSv1.2
    ssl.endpoint.identification.algorithm=HTTPS

Utilice el campo <user> de la clave de servicio como nombre de usuario y el campo <api_key> de la clave de servicio como contraseña. Puede encontrar estos valores en el separador Event Streams Credenciales de servicio en la consola de IBM Cloud.

Event Streams proporciona archivos producer.properties y consumer.properties de ejemplo para el cliente Java.

Después de crear el archivo de propiedades, puede ejecutar el productor de consola en un terminal de la siguiente manera:

   kafka-console-producer.sh --broker-list BOOTSTRAP_ENDPOINTS --producer.config CONFIG_FILE --topic TOPIC_NAME

Sustituya las siguientes variables del ejemplo por sus propios valores:

• BOOTSTRAP_ENDPOINTS con el valor de la pestaña Event Streams Credenciales de servicio en la consola de IBM Cloud.
• CONFIG_FILE por la vía de acceso del archivo de configuración.

• Utilice el campo <bootstrap_endpoints> de la clave de servicio como la propiedad bootstrap.servers de la aplicación Kafka.
• Utilice el campo <user> de la clave de servicio como nombre de usuario y el campo <api_key> de la clave de servicio como contraseña. Asegúrese de que la aplicación analiza los detalles.

Puede utilizar muchas de las otras opciones de esta herramienta, excepto aquellas que requieren acceso a ZooKeeper. Para obtener más información, consulte Utilización de las herramientas de consola de Kafka con Event Streams.

Paso 5: Producir datos utilizando la API del productor REST

Utilice el punto final v2 de la API REST Producer para enviar mensajes de tipo text, binary, JSON o avro a los temas. Con el punto final v2, puede utilizar el registro de esquemas Event Streams especificando el esquema para el tipo de datos avro.

• ¿Qué son las cabeceras? ¿Son opcionales? Las cabeceras se ven en el cuerpo del mensaje. Ese es el fragmento de datos que incluye todo en la solicitud o respuesta. Las cabeceras suelen ir después de la línea de solicitud o línea de respuesta. El valor del color es base64-¿cómo hacerlo?

El siguiente código muestra un ejemplo de envío de un mensaje de tipo text mediante el uso de curl:

curl -v -X POST \
-H "Authorization: Bearer $token" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{
  "headers": [
    {
      "name": "colour",
      "value": "YmxhY2s="
    }
  ],
  "key": {
    "type": "text",
    "data": "Test Key"
  },
  "value": {
    "type": "text",
    "data": "Test Value"
  }
}' \
"$kafka_http_url/v2/topics/$topic_name/records"

Para obtener más información, consulte la Referencia de API de punto final deEvent Streams REST Producer v2.

Paso 6: Consumir datos utilizando la consola

No puede consumir datos utilizando la consola. Puede consumir datos utilizando la línea de mandatos o la APIKafka.

Sin embargo, puede completar los pasos de la Guía de aprendizaje de iniciación para ejecutar una app de inicio de ejemplo y ver los mensajes que fluyen a través de un tema.

Paso 6: Consumir datos utilizando la línea de mandatos

Puede utilizar la herramienta de consumidor de consola Event Streams Kafka para consumir datos.

Las herramientas de consola se encuentran en el directorio bin de la descarga del cliente Kafka.

Debe suministrar una lista de intermediarios y credenciales de SASL. Después de crear el archivo de propiedades tal como se describe en producir datos utilizando la línea de mandatos, ejecute el consumidor de la consola en un terminal del modo siguiente:

   kafka-console-consumer.sh --bootstrap-server BOOTSTRAP_ENDPOINTS --consumer.config CONFIG_FILE --topic TOPIC_NAME

Sustituya las siguientes variables del ejemplo por sus propios valores:

• BOOTSTRAP_ENDPOINTS con el valor de la pestaña Event Streams Credenciales de servicio en la consola de IBM Cloud.
• CONFIG_FILE por la vía de acceso del archivo de configuración.

Puede utilizar muchas de las otras opciones de esta herramienta, excepto aquellas que requieren acceso a ZooKeeper. Para obtener más información, consulte Utilización de las herramientas de consola de Kafka con Event Streams.

Paso 6: Consumir datos utilizando una API

No puede consumir datos utilizando una API Event Streams aunque el consumo de datos de Kafka es posible utilizando las bibliotecas Kafka nativas. Para obtener más información, consulte API de consumidor deKafka.

Como alternativa, utilice la línea de mandatos.

Paso 7: Conecte IBM Cloud Monitoring para obtener visibilidad operativa utilizando la consola

Puede utilizar IBM Cloud Monitoring para obtener visibilidad operativa sobre el rendimiento y el estado de sus aplicaciones, servicios y plataformas. IBM Cloud Monitoring proporciona a los administradores, equipos de DevOps y desarrolladores telemetría de pila completa con características avanzadas para supervisar y resolver problemas, definir alertas y diseñar paneles de control personalizados.

Para obtener más información sobre cómo utilizar Monitoring con Event Streams, consulte:

• Participación en métricas
• Habilitación de métricas predeterminadas
• Habilitación de métricas mejoradas
• Visualización de detalles de métricas disponibles
• Información sobre el coste de las métricas

Paso 7: Conecte IBM Cloud Monitoring para obtener visibilidad operativa utilizando la CLI o la línea de mandatos

No puede conectar IBM Cloud Monitoring utilizando la CLI o la línea de mandatos. Utilice la consola para completar esta tarea.

Paso 7: Conecte IBM Cloud Monitoring para obtener visibilidad operativa utilizando una API

No puede conectar IBM Cloud Monitoring utilizando una API. Utilice la consola para completar esta tarea.

Paso 8: Conectar IBM Cloud® Activity Tracker para auditar la actividad del servicio

IBM Cloud Activity Tracker le permite ver, gestionar y auditar la actividad del servicio para cumplir con las políticas corporativas y las normativas del sector. Activity Tracker registra las actividades iniciadas por el usuario que cambian el estado de un servicio en IBM Cloud. Utilice Activity Tracker para realizar un seguimiento de cómo los usuarios y las aplicaciones interactúan con el servicio Event Streams en los planes Standard y Enterprise.

Para empezar a trabajar con Activity Tracker, consulte Iniciación a Activity Tracker.

Activity Tracker solo puede tener una instancia por ubicación. Para ver los sucesos, debe acceder a la interfaz de usuario web del servicio Activity Tracker en la misma ubicación en la que está disponible la instancia de servicio. Para obtener más información, consulte Iniciar la interfaz de usuario web.

Para obtener más información sobre los sucesos específicos de Event Streams, consulte:

• Dónde ver los sucesos
• Sucesos de temas
• Sucesos de auditoría de mensajes
• Otros sucesos

Los eventos se formatean de acuerdo con el estándar de la Federación de Datos de Auditoría en la Nube (CADF). Para obtener más detalles de la información que incluyen, consulte estándar CADF.

Paso 8: Conectar IBM Cloud® Activity Tracker utilizando la CLI o la línea de mandatos para auditar la actividad del servicio

No puede conectar Activity Tracker utilizando la CLI o la línea de mandatos. Utilice la consola para completar esta tarea.

Paso 8: Conectar IBM Cloud® Activity Tracker utilizando una API para auditar la actividad de servicio

No puede conectar Activity Tracker utilizando una API. Utilice la consola para completar esta tarea.