CloudEvents: formato de evento JSON

CloudEvents (cloudevents.io) es una especificación para describir datos de eventos de forma común. La especificación está bajo la supervisión de la Cloud Native Computing Foundation (CNCF) y está organizada por el grupo de trabajo Serverless de la CNCF.

Eventarc envía eventos al receptor de eventos en formato CloudEvents a través de una solicitud HTTP. El destino, por ejemplo, el servicio Workflows, convierte el evento en un objeto JSON (siguiendo la especificación de CloudEvents) y lo transfiere a la ejecución del flujo de trabajo como argumento de tiempo de ejecución.

Formato de carga útil de JSON

El servicio de destino recibe eventos de los enrutadores de eventos y los formatea según el formato de evento JSON para CloudEvents versión 1.0.1 con los siguientes atributos de CloudEvents:

{
  "subscription": "projects/my-project/subscriptions/my-sub",
  "message": {
    "attributes": {
      "attr1":"attr1-value"
    },
    "data": "aGVsbG8gd29ybGQ=",
    "messageId": "2070443601311540",
    "publishTime":"2021-02-26T19:13:55.749Z"
  }
}

Según el tipo de evento, el formato de la carga útil es el siguiente:

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json; charset=utf-8",
  "id": "MESSAGE_ID",
  "source": "//cloudaudit.googleapis.com/projects/PROJECT_ID/logs/data_access",
  "specversion": "1.0",
  "type": "google.cloud.audit.log.v1.written",
  "time": "EVENT_GENERATION_TIME",
  "dataschema": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/cloud/audit/v1/LogEntryData.json",
  "methodName": "jobservice.jobcompleted",
  "resourceName": "projects/my-project/jobs/bqjob_r3ac45813612fa2d6_0000017d591922c9_1",
  "serviceName": "bigquery.googleapis.com",
  "subject": "bigquery.googleapis.com/projects/my-project/jobs/bqjob_r3ac45813612fa2d6_0000017d591922c9_1"
}

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json",
  "id": "MESSAGE_ID",
  "source": "//storage.googleapis.com/projects/_/buckets/BUCKET_NAME",
  "specversion": "1.0",
  "type": "google.cloud.storage.object.v1.finalized",
  "time": "EVENT_GENERATION_TIME",
  "subject": "objects/my-file.txt"
}

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json; charset=utf-8",
  "id": "MESSAGE_ID",
  "source": "//pubsub.googleapis.com/TOPIC_NAME",
  "specversion": "1.0",
  "type": "google.cloud.pubsub.topic.v1.messagePublished",
  "time": "EVENT_GENERATION_TIME"
}

Repositorio de código abierto

La estructura del cuerpo HTTP de todos los eventos está disponible en el repositorio de GitHub de CloudEvents.

El repositorio contiene lo siguiente para ayudarte a entender y usar los datos de CloudEvents en tu lenguaje de programación:

• Protocol buffers de Google para cargas útiles de datos de CloudEvents
• Esquemas JSON generados
• Un catálogo público de esquemas JSON

También se incluyen enlaces a bibliotecas de cliente.

Eventos comunes

Los búferes de protocolo (o protobufs) representan los datos de los eventos que genera Eventarc. Los Protocol Buffers de CloudEvents se proporcionan como esquemas legibles por máquina, lo que permite crear bibliotecas de tipos de datos y facilita el consumo de eventos.

Hay dos mensajes protobuf que son relevantes para cualquier tipo de CloudEvent:

• El mensaje envelope que representa el CloudEvent completo, incluidos los atributos de extensión; por ejemplo, AuditLogWrittenEvent.
• El mensaje de datos, por ejemplo, LogEntryData o StorageObjectData.

En las siguientes tablas se detallan los componentes de algunos eventos habituales: