Configurare avvisi e notifiche per le attività del catalogo della conoscenza

Questa pagina descrive come configurare gli avvisi per le esecuzioni dei job non riuscite di un task Knowledge Catalog (in precedenza Dataplex Universal Catalog).

Per configurare gli avvisi, puoi utilizzare Esplora log nella console Google Cloud o l'API Monitoring.

Terminologia

  • Durata chiusura automatica incidenti: puoi chiudere automaticamente un incidente se non sono presenti voci di log corrispondenti entro questa durata.
  • Intervallo di tempo tra le notifiche: puoi ridurre la frequenza delle notifiche ripetute impostando un intervallo di tempo tra una notifica e l'altra. Le voci di log che corrispondono a un filtro vengono ignorate durante questo periodo di tempo. Il tempo minimo che puoi impostare è 5 minuti.

Configurare le notifiche utilizzando Esplora log

  1. Nella console Google Cloud , vai alla pagina Esplora log.

    Vai a Esplora log

  2. Fai clic sul pulsante di attivazione/disattivazione Mostra query.

    1. Per configurare un avviso per l'esecuzione non riuscita di un job di qualsiasi attività del catalogo delle conoscenze in un progetto, digita la seguente query:

      severity=ERROR
resource.type = "dataplex.googleapis.com/Task"
logName = "projects/PROJECT_NAME/logs/dataplex.googleapis.com%2Fprocess"
jsonPayload.state = "FAILED"

    2. Per configurare un avviso per l'esecuzione non riuscita di un job di una specifica attività di Knowledge Catalog in un progetto, digita la seguente query:

      severity=ERROR
resource.type = "dataplex.googleapis.com/Task"
resource.labels.task_id = TASK_ID
logName = "projects/PROJECT_NAME/logs/dataplex.googleapis.com%2Fprocess"
jsonPayload.state = "FAILED"

  3. Fai clic su Crea avviso.

  4. Nel campo Nome criterio di avviso, inserisci un nome per il nuovo avviso.

  5. Nel campo Documentazione, inserisci la descrizione che vuoi includere nella notifica. Per ulteriori informazioni sui contenuti che puoi includere nel campo della documentazione di una criterio di avviso, consulta Utilizzo di Markdown e variabili nei modelli di documentazione.

  6. Fai clic su Avanti.

  7. Scegli i log da includere nell'avviso e fai clic su Avanti.

  8. Imposta Tempo tra le notifiche e Durata chiusura automatica incidenti e fai clic su Avanti.

  9. (Facoltativo) Seleziona un canale di notifica. Per saperne di più sulla configurazione dei canali di notifica utilizzando la console Google Cloud , consulta Gestire i canali di notifica.

  10. Fai clic su Salva.

Configurare le notifiche utilizzando l'API Monitoring

  1. (Facoltativo) Abilita l'API Monitoring e autorizza gli utenti ad accedervi. Per saperne di più, consulta Abilitare l'API Monitoring.
  2. (Facoltativo) Imposta i ruoli o le autorizzazioni necessari per creare una criterio di avviso. Per saperne di più, consulta Autorizzazione richiesta per creare criteri di avviso.
  3. Crea un canale di notifica utilizzando la consoleGoogle Cloud o Google Cloud CLI.

  4. Ottieni channel_id:

    gcloud beta monitoring channels list

  5. Crea un file policy.json con il seguente contenuto per log-based-alerting-policy:

    1. Configura un avviso per l'esecuzione non riuscita di qualsiasi attività del catalogo delle conoscenze in un progetto:

      {
"displayName": "Alert Using Monitoring API",
"documentation": {
  "content": "Log-based alert in project PROJECT.",
  "mimeType": "text/markdown"
},

"conditions": [
  {
    "displayName": "Log match condition: Failed Job Execution",
    "conditionMatchedLog": {
      "filter": "severity=\"ERROR\" resource.type = \"dataplex.googleapis.com/Task\" logName = \"projects/PROJECT_ID/logs/dataplex.googleapis.com%2Fprocess\" jsonPayload.state = \"FAILED\"",
    },
  }
],
"combiner": "OR",

"alertStrategy": {
  "notificationRateLimit": {
    "period": "300s"
  },
  "autoClose": "604800s",
},

"notificationChannels": [
  "projects/PROJECT_ID/notificationChannels/CHANNEL_ID"
]
}

    2. Configura un avviso per l'esecuzione non riuscita di un job per un'attività specifica del catalogo delle conoscenze in un progetto:

      {
"displayName": "Alert Using Monitoring API",
"documentation": {
  "content": "Log-based alert in project PROJECT.",
  "mimeType": "text/markdown"
},

"conditions": [
  {
    "displayName": "Log match condition: Failed Job Execution",
    "conditionMatchedLog": {
      "filter": "severity=\"ERROR\" resource.type = \"dataplex.googleapis.com/Task\" logName = \"projects/PROJECT_ID/logs/dataplex.googleapis.com%2Fprocess\" jsonPayload.state = \"FAILED\" resource.labels.task_id = \"TASK_ID\"",
    },
  }
],
"combiner": "OR",

"alertStrategy": {
  "notificationRateLimit": {
    "period": "300s"
  },
  "autoClose": "604800s",
},

"notificationChannels": [
  "projects/PROJECT_ID/notificationChannels/CHANNEL_ID"
]
}

  6. Passa il file policy.json alla CLI gcloud:

    gcloud monitoring policies create --policy-from-file="policy.json"

    In caso di esito positivo, il comando restituisce il nome della risorsa della nuova policy. Ad esempio:

    Created alert policy [projects/PROJECT_ID/alertPolicies/*POLICY_ID*].

Passaggi successivi