Estensione Google Cloud Logging

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Versione 1.6.1

Scrivi voci nei log di Cloud Logging.

Questo contenuto fornisce un riferimento per la configurazione e l'utilizzo di questa estensione.

Prerequisiti

Prima di utilizzare questa estensione da un proxy API, devi:

1. In IAM, assegna il ruolo Logging > Writer log al membro del progetto che rappresenterà la tua estensione nel sistema Cloud Logging. Per istruzioni su come concedere i ruoli, consulta Concedere ruoli a un account di servizio per risorse specifiche. Per saperne di più sui ruoli di logging, consulta la Guida al controllo dell'accesso.

2. Utilizza la console Google Cloud per generare una chiave per l'account di servizio.

3. Utilizza i contenuti del file JSON della chiave risultante quando aggiungi e configuri l'estensione utilizzando il riferimento di configurazione.

Questa estensione supporta le chiamate da un criterio ExtensionCallout che si trova in PostClientFlow. Se vuoi utilizzare il criterio ExtensionCallout per chiamare questa estensione da un PostClientFlow, assicurati che il flag features.allowExtensionsInPostClientFlow sia impostato su true nella tua organizzazione.

• Se sei un cliente di Apigee Edge per il cloud pubblico, devi contattare l'assistenza di Apigee Edge per assicurarti che il features.allowExtensionsInPostClientFlow flag sia impostato su true nella tua organizzazione.

• Se sei un cliente di Apigee Edge per il cloud privato, utilizza l' API Update organization properties per impostare il flag features.allowExtensionsInPostClientFlow su true.

Informazioni su Cloud Logging

Cloud Logging fa parte della suite operativa di Google Cloud. Include spazio di archiviazione per i log, un'interfaccia utente chiamata Esplora log e un'API per la gestione dei log in modo programmatico. Con Cloud Logging, puoi leggere e scrivere voci di log, eseguire ricerche e applicare filtri nei log, esportare i log e creare metriche basate su log.

L'estensione Cloud Logging attualmente scrive le voci nel log. Per saperne di più, consulta la documentazione di Cloud Logging.

Esempi

Gli esempi seguenti illustrano come configurare il supporto per le azioni dell'estensione Cloud Logging utilizzando il criterio ExtensionCallout.

Log globale

Il seguente criterio scrive il messaggio This is a test in un log denominato example-log nella risorsa globale di Cloud. In pratica, probabilmente il messaggio sarà contenuto in una variabile di flusso il cui valore è impostato altrove nel proxy API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>cloud-extension-sample</Connector>
    <Action>log</Action>
    <Input><![CDATA[{
        "logName": "example-log",
        "metadata": {
            "resource": {
                "type": "global",
                "labels": {
                    "project_id": "my-test"
                }
            }
        },
        "message": "This is a test."
    }]]></Input>
</ConnectorCallout>

Questo contenuto fornisce un riferimento per la configurazione e l'utilizzo di questa estensione. Per i passaggi per configurare un'estensione utilizzando la console Apigee, vedi Aggiungere e configurare un'estensione.

Azioni

log

Scrive un messaggio nel log.

Questa azione scrive una voce di log di Cloud Logging. Le voci di log sono costituite da metadati e dati della voce. Per saperne di più sulle voci di log, consulta il riferimento per le voci. Per informazioni sui contenuti della proprietà metadata, consulta l'oggetto LogEntry nella documentazione di Cloud Logging.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "cloud-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

Parametri di richiesta

Risposta

None se il messaggio è stato scritto nel log. In caso contrario, la richiesta restituirà un errore. Consulta anche Eseguire il debug di un'estensione.

Riferimento per la configurazione

Utilizza le seguenti informazioni quando configuri e sottoponi a deployment questa estensione per l'utilizzo nei proxy API.

Proprietà comuni delle estensioni

Per ogni estensione sono presenti le seguenti proprietà.

Proprietà per questo pacchetto di estensioni

Specifica i valori per le seguenti proprietà di configurazione specifiche per questa estensione.