Formato CloudEvents - Associazione del protocollo HTTP

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

CloudEvents (cloudevents.io) è una specifica per descrivere i dati degli eventi in modo comune. La specifica si trova nella Cloud Native Computing Foundation (CNCF) ed è organizzata dal Serverless Working Group del CNCF.

Eventarc invia gli eventi al ricevitore eventi nel formato CloudEvents tramite una richiesta HTTP.

Intestazioni delle richieste HTTP

I servizi di destinazione ricevono gli eventi dai router di eventi come richieste POST HTTP formattate nella specifica di associazione del protocollo CloudEvents 1.0 HTTP. Ogni richiesta HTTP contiene intestazioni specifiche per gli eventi e un corpo e viene inviata al percorso URL principale (/) del servizio.

Oltre ad altre intestazioni HTTP, tutti gli eventi hanno le seguenti intestazioni HTTP CloudEvents:

Intestazione Descrizione Esempio
ID CE Identificatore univoco per l'evento 1096434104173400
ce-source Identifica l'origine dell'evento //pubsub.googleapis.com/projects/my-project/topics/my-topic
ce-specversion La versione della specifica CloudEvents utilizzata per questo evento 1.0
tipo-ce Il tipo di dati sugli eventi google.cloud.pubsub.topic.v1.messagePublished
ce-time Data e ora di generazione dell'evento, nel formato RFC 3339 (facoltativo). 2020-12-20T13:37:33.647Z

Formato payload HTTP

Cloud Audit Logs

Gli eventi di tipo google.cloud.audit.log.v1.written hanno il seguente formato:

Intestazioni

ce-specversion: 1.0
ce-type: google.cloud.audit.log.v1.written
ce-source: //SERVICE_NAME/projects/PROJECT_ID
ce-id: MESSAGE_ID
ce-time: PUBLISH_TIME
Content-Type: application/json; charset=utf-8
Content-Length: CONTENT_LENGTH
  • SERVICE_NAME: l'URI dell'API Google per il servizio che emette l'evento, ad esempio bigquery.googleapis.com per gli eventi da BigQuery.
  • PROJECT_ID: il tuo ID progetto GCP.
  • MESSAGE_ID, PUBLISH_TIME, CONTENT_LENGTH: generato dal sistema.

Corpo

Il payload è un oggetto JSON che descrive in dettaglio l'evento Cloud Audit Logs. In protoPayload puoi trovare i valori resourceName, serviceName e methodName. Per ulteriori informazioni, consulta Determinare i filtri di eventi per Cloud Audit Logs.

Pub/Sub

Gli eventi di tipo google.cloud.pubsub.topic.v1.messagePublished hanno il seguente formato:

Intestazioni

ce-specversion: 1.0
ce-type: google.cloud.pubsub.topic.v1.messagePublished
ce-source: //pubsub.googleapis.com/TOPIC
ce-id: MESSAGE_ID
ce-time: PUBLISH_TIME
Content-Type: application/json; charset=utf-8
Content-Length: CONTENT_LENGTH
  • TOPIC: l'argomento Pub/Sub in cui è stato pubblicato l'evento.
  • MESSAGE_ID, PUBLISH_TIME, CONTENT_LENGTH: generato dal sistema.

Corpo

Il payload è un messaggio push di Pub/Sub. Nel campo data puoi trovare il messaggio come stringa codificata in Base64. Vedi l'esempio in questo documento.

Repository open source

La struttura del corpo HTTP per tutti gli eventi è disponibile nel repository GitHub CloudEvents.

Il repository contiene quanto segue per aiutarti a comprendere e utilizzare i dati CloudEvents nel tuo linguaggio di programmazione:

  • Buffer di protocollo Google per i payload di dati di CloudEvents
  • Schemi JSON generati
  • un catalogo di schemi JSON pubblico

Sono inclusi anche i link alle librerie client.

Eventi comuni

I buffer di protocollo (o protobuf) rappresentano i dati all'interno degli eventi generati da Eventarc. I buffer di protocollo per CloudEvents vengono forniti come schemi leggibili dal computer, consentendo la creazione di librerie di tipi di dati e rendendo più facile il consumo di eventi.

Esistono due messaggi protobuf pertinenti per qualsiasi tipo di CloudEvent:

  • Il messaggio envelope che rappresenta il evento CloudEvent completo, inclusi eventuali attributi di estensione, ad esempio AuditLogWrittenEvent.
  • Il messaggio dati, ad esempio LogEntryData o StorageObjectData.
Molti tipi di CloudEvent possono utilizzare lo stesso messaggio di dati. Ad esempio, ogni evento associato a un oggetto Cloud Storage utilizza StorageObjectData come messaggio di dati. Ogni messaggio busta specifica il tipo CloudEvent a cui è associato tramite un'annotazione proto. Per ulteriori informazioni, consulta la sezione Rapporto tra messaggi protobuf e tipi di CloudEvent.

Le seguenti tabelle descrivono i componenti di alcuni eventi comuni:

Cloud Audit Logs

File protocollogoogle/events/cloud/audit/v1/events.proto
google/events/cloud/audit/v1/data.proto
Busta messaggiogoogle.events.cloud.audit.v1.AuditLogWrittenEvent
Messaggio datigoogle.events.cloud.audit.v1.LogEntryData
Tipo di evento
(quando viene scritta una voce del log di controllo)
google.cloud.audit.log.v1.written
Estensioni evento
  • serviceName
  • methodName
  • resourceName
Esempio Log di controllo di Pub/Sub
Log di controllo di BigQuery

Cloud Storage

File protocollo google/events/cloud/storage/v1/events.proto
google/events/cloud/storage/v1/data.proto
Busta messaggigoogle.events.cloud.storage.v1.ObjectFinalizedEvent
google.events.cloud.storage.v1.ObjectArchivedEvent
google.events.cloud.storage.v1.ObjectDeletedEvent
google.events.cloud.storage.v1.ObjectMetadataUpdatedEvent
Messaggio datigoogle.events.cloud.storage.v1.StorageObjectData
Risorsa Objects
Tipi di eventi
(quando un job Cloud Storage viene finalizzato, archiviato, eliminato, aggiornato)
google.cloud.storage.object.v1.finalized
google.cloud.storage.object.v1.archived
google.cloud.storage.object.v1.deleted
google.cloud.storage.object.v1.metadataUpdated
Esempi Semplice
Complesso

Pub/Sub

File protocollo google/events/cloud/pubsub/v1/events.proto
google/events/cloud/pubsub/v1/data.proto
Busta messaggiogoogle.events.cloud.pubsub.v1.MessagePublishedEvent
Messaggio datigoogle.events.cloud.pubsub.v1.MessagePublishedData
Risorsa PubsubMessage
Tipo di evento
(quando viene pubblicato un messaggio Pub/Sub)
google.cloud.pubsub.topic.v1.messagePublished
Esempi Testo