Notifiche Pub/Sub per Cloud Storage

Configurazione

Questa pagina fornisce una panoramica delle notifiche Pub/Sub per Cloud Storage.

Panoramica

Le notifiche Pub/Sub inviano informazioni sulle modifiche apportate agli oggetti nei bucket a Pub/Sub, in cui le informazioni vengono aggiunte a un argomento Pub/Sub a tua scelta sotto forma di messaggi. Ad esempio, puoi tenere traccia degli oggetti creati ed eliminati nel tuo bucket. Ogni notifica contiene informazioni che descrivono sia l'evento che l'ha attivata che l'oggetto modificato.

Puoi inviare notifiche a qualsiasi argomento Pub/Sub in qualsiasi progetto per il quale hai le autorizzazioni necessarie. Una volta ricevuti dall'argomento Pub/Sub, i iscritti all'argomento possono ricevere il messaggio associato. Consulta i prerequisiti per informazioni sulla connessione dei bucket Cloud Storage a un argomento Pub/Sub.

Altre opzioni di notifica

L'abbonamento alle notifiche Pub/Sub è un modo versatile per attivare avvisi e azioni in risposta alle modifiche in un bucket. Sono disponibili anche le seguenti opzioni:

  • Cloud Functions: se vuoi attivare una funzione autonoma leggera, in risposta agli eventi, e non vuoi gestire un argomento Pub/Sub, utilizza Cloud Functions. Cloud Functions ti consente di eseguire funzioni C#, Go, Java, Node.js, Python, PHP e Ruby quando cambia un oggetto nel tuo bucket. Tieni presente che il bucket deve risiedere nello stesso progetto di Cloud Functions. Guarda il tutorial associato per una dimostrazione di come utilizzare Cloud Functions con Cloud Storage.

  • Notifica di modifica degli oggetti: le notifiche di modifica degli oggetti sono una funzionalità precedente e separata all'interno di Cloud Storage per la generazione di notifiche. Questa funzionalità invia i messaggi HTTPS a un'applicazione client che hai configurato separatamente. Questa funzionalità di solito non è consigliata, perché le notifiche Pub/Sub sono più economiche, facili da usare e più flessibili.

Configurazioni delle notifiche

Una configurazione delle notifiche è una regola che colleghi a un bucket che specifica:

  • L'argomento in Pub/Sub che riceve le notifiche.
  • Gli eventi che attivano una notifica da inviare.
  • Le informazioni contenute nelle notifiche.

Puoi collegare più configurazioni di notifica a un bucket. Un bucket può avere fino a 100 configurazioni di notifica totali e fino a 10 configurazioni di notifica impostate per attivarsi per un evento specifico.

Ad esempio, se hai una configurazione di notifica che invia notifiche di eliminazione a un argomento Pub/Sub, puoi aggiungere una seconda configurazione di notifica al bucket che invia notifiche di eliminazione a un altro argomento. Tuttavia, se tenti di creare più di 10 configurazioni di notifica, riceverai un errore. Oltre a queste configurazioni di notifica, puoi anche creare configurazioni di notifica che inviano notifiche per altri eventi, come la creazione di oggetti, ad argomenti Pub/Sub utilizzati dalle notifiche di eliminazione o ad argomenti diversi.

Ogni configurazione di notifica è identificata da un numero intero. Viene restituito questo numero intero:

  • Quando crei la configurazione della notifica.
  • Quando indichi le configurazioni di notifica collegate a un bucket.
  • Nell'attributo notificationConfig di ogni notifica attivata dalla configurazione della notifica.

La creazione e l'eliminazione delle configurazioni di notifica aumentano il numero di metagenerazione di un bucket.

Tipi di evento

Di seguito è riportato un elenco dei tipi di eventi attualmente supportati da Cloud Storage:

Tipo di evento Descrizione
OBJECT_FINALIZE Inviato quando un nuovo oggetto (o una nuova generazione di un oggetto esistente) viene creato correttamente nel bucket. Sono considerate creazioni anche la copia o la riscrittura di un oggetto esistente. Questo evento non viene attivato da un caricamento non riuscito.
OBJECT_METADATA_UPDATE Inviato in caso di variazioni nei metadati di un oggetto esistente.
OBJECT_DELETE Inviato quando un oggetto è stato eliminato definitivamente. Sono inclusi gli oggetti che vengono sostituiti o eliminati come parte della configurazione del ciclo di vita del bucket. Non sono inclusi gli oggetti che diventano non aggiornati (vedi OBJECT_ARCHIVE) o i caricamenti multiparte interrotti.
OBJECT_ARCHIVE Inviato solo quando il bucket ha abilitato il controllo delle versioni degli oggetti. Questo evento indica che la versione live di un oggetto è diventata una versione non attuale perché è stata resa esplicitamente non aggiornata oppure perché è stata sostituita dal caricamento di un oggetto con lo stesso nome.

Sostituzione di oggetti

La sostituzione di un oggetto esistente con uno nuovo con lo stesso nome attiva due eventi separati: OBJECT_FINALIZE per la nuova versione dell'oggetto e OBJECT_ARCHIVE o OBJECT_DELETE per l'oggetto sostituito. L'evento OBJECT_FINALIZE contiene un attributo aggiuntivo overwroteGeneration che fornisce il numero di generazione dell'oggetto che è stato sostituito. L'evento OBJECT_ARCHIVE o OBJECT_DELETE contiene un attributo aggiuntivo overwrittenByGeneration che fornisce il numero di generazione del nuovo oggetto.

Formato delle notifiche

Le notifiche inviate all'argomento Pub/Sub sono composte da due parti:

  • Attributi: un set di coppie chiave:valore che descrivono l'evento.
  • Payload: una stringa contenente i metadati dell'oggetto modificato.

Attributi

Gli attributi sono coppie chiave:valore contenute in tutte le notifiche inviate da Cloud Storage all'argomento Pub/Sub. Le notifiche contengono sempre il seguente insieme di coppie chiave-valore, indipendentemente dal carico di lavoro della notifica:

Nome dell'attributo Esempio Descrizione
notificationConfig projects/_/buckets/foo/notificationConfigs/3 Un identificatore della configurazione della notifica che ha attivato la notifica.
eventType OBJECT_FINALIZE Il tipo di evento che si è appena verificato. Vedi Tipi di eventi per un elenco di possibili valori.
payloadFormat JSON_API_V1 Il formato del payload dell'oggetto. Vedi Payload per un elenco di possibili valori.
ID bucket foo Il nome del bucket che contiene l'oggetto modificato.
ID oggetto bar Il nome dell'oggetto modificato.
generazione di oggetti 123456 Il numero di generazione dell'oggetto modificato.
eventTime 2021-01-15T01:30:15.01Z L'ora in cui si è verificato l'evento, espresso nel formato RFC 3339.

A volte le notifiche contengono il seguente insieme di coppie chiave-valore, indipendentemente dal payload della notifica:

Nome dell'attributo Esempio Descrizione
sovrascrittura da generazione 107458 Il numero di generazione dell'oggetto che ha sostituito l'oggetto a cui si riferisce la notifica. Questo attributo viene visualizzato solo negli eventi OBJECT_ARCHIVE o OBJECT_DELETE nel caso di una sostituzione.
generazione eccessiva 352947 Il numero di generazione dell'oggetto che è stato sostituito dall'oggetto a cui si riferisce la notifica. Questo attributo viene visualizzato solo negli eventi OBJECT_FINALIZE in caso di sostituzione.

La seguente coppia chiave-valore è deprecata. Non verrà mostrato per i nuovi abbonamenti e non verrà mostrato in nessun abbonamento dopo il 1° giugno 2018:

Nome dell'attributo Esempio Descrizione
resource projects/_/buckets/foo/objects/bar#123456 Il percorso dell'oggetto Cloud Storage modificato.

Oltre agli attributi sopra indicati, una configurazione di notifica può contenere fino a 10 attributi personalizzati. Gli attributi personalizzati vengono definiti quando crei una configurazione di notifica, utilizzando --custom-attributes in un comando gcloud storage, il flag -m in un comando gsutil notification o l'oggetto custom_attributes nel corpo di una POST notificationConfigsrichiesta JSON.

Payload

Il payload è una stringa che contiene i metadati dell'oggetto modificato. Quando crei una configurazione di notifica, devi specificare un tipo di payload da includere nelle notifiche attivate da quella configurazione. Puoi specificare i seguenti tipi di payload:

Tipo di payload Descrizione
NESSUNA Nessun payload incluso nella notifica.
API_JSON_V1 Il payload sarà una stringa UTF-8 contenente la rappresentazione delle risorse dei metadati dell'oggetto.

Per le notifiche OBJECT_DELETE, i metadati contenuti nel payload rappresentano i metadati degli oggetti come prima dell'eliminazione, insieme a un'ulteriore proprietà timeDeleted. Per tutte le altre notifiche, i metadati inclusi nel payload rappresentano i metadati dell'oggetto dopo la modifica.

Ad esempio, supponiamo di avere una configurazione di notifica che monitora gli eventi OBJECT_METADATA_UPDATE. Se un utente modifica la proprietà contentType di un oggetto da binary/octet-stream a video/mp4, viene inviata una notifica OBJECT_METADATA_UPDATE e i metadati nel payload includono "contentType":"video/mp4".

Garanzie di consegna

Quando aggiungi una configurazione di notifica, Cloud Storage può impiegare fino a 30 secondi per iniziare a inviare le notifiche associate. Una volta avviato, Cloud Storage garantisce la distribuzione "una volta sola" a Pub/Sub. Pub/Sub offre anche la consegna " una tantum "al destinatario", il che significa che potresti ricevere più messaggi, con più ID, che rappresentano lo stesso evento Cloud Storage.

Non è garantito che le notifiche vengano pubblicate nell'ordine in cui Pub/Sub le riceve. Se prevedi di modificare l'oggetto Cloud Storage in base a una notifica, ti consigliamo di utilizzare i numeri di generazione e metagenerazione dell'oggetto come precondizioni nella richiesta di aggiornamento.

Se una notifica non può essere recapitata in modo coerente a un argomento Pub/Sub, Cloud Storage potrebbe eliminarla dopo 7 giorni. Il mancato recapito può verificarsi quando l'argomento Pub/Sub non esiste più, quando Cloud Storage non è più autorizzato a pubblicare l'argomento o quando il progetto proprietario dell'argomento supera la quota di pubblicazione.

Passaggi successivi