Estensione Google Stackdriver Logging

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

Versione 1.3.7

Scrivi voci nei log di Stackdriver Logging.

Questi contenuti forniscono 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 i ruoli Logging > Logs Writer e Logging > Logs Viewer al membro del progetto che rappresenterà la tua estensione nel sistema Stackdriver Logging. Per istruzioni su come concedere i ruoli, vedi Concessione dei ruoli a un service account per risorse specifiche. Per saperne di più sui ruoli di logging, consulta la guida al controllo dell'accesso.

2. Utilizza la console GCP per generare una chiave per il service account.

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

Questa estensione supporta la chiamata da parte di un criterio ExtensionCallout che si trova in PostClientFlow. Se vuoi utilizzare la policy 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 Apigee Edge per assicurarti che il flag features.allowExtensionsInPostClientFlow sia impostato su true nella tua organizzazione.

• Se sei un cliente di Apigee Edge for Private Cloud, utilizza l'API Aggiorna proprietà organizzazione per impostare il flag features.allowExtensionsInPostClientFlow su true.

Informazioni su Stackdriver Logging

Stackdriver Logging fa parte della suite di prodotti Stackdriver in Google Cloud Platform (GCP). Include spazio di archiviazione per i log, un'interfaccia utente detta visualizzatore log e un'API per la gestione dei log a livello di programmazione. Con Stackdriver Logging, puoi leggere e scrivere voci di log, eseguire ricerche e applicare filtri nei log, esportarli e creare metriche basate su log.

Al momento questa estensione scrive voci nel log. Per saperne di più, consulta la documentazione di Stackdriver Logging.

Esempi

Gli esempi seguenti illustrano come configurare il supporto per le azioni di estensione di Stackdriver Logging utilizzando il criterio ExtensionCallout.

Log globale

La seguente policy scrive il messaggio "This is a test" (Questo è un test) in un log denominato example-log nella risorsa globale Stackdriver. Nell'utilizzo effettivo, probabilmente il messaggio sarà contenuto in una variabile di flusso il cui valore viene 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>stackdriver-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>

Questi contenuti forniscono un riferimento per la configurazione e l'utilizzo di questa estensione. Per i passaggi per configurare un'estensione utilizzando la console Apigee, vedi Aggiunta e configurazione di un'estensione.

Azioni

log

Scrive un messaggio nel log.

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

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

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

Parametri di richiesta

Risposta

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

Riferimento alla configurazione

Utilizza quanto segue quando configuri ed esegui il deployment di questa estensione per l'utilizzo nei proxy API.

Proprietà comuni delle estensioni

Per ogni estensione sono presenti le seguenti proprietà.

Proprietà di questo pacchetto di estensioni

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