Estensione Google Stackdriver Logging

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

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 il ruolo Logging > Writer log e Logging > Visualizzatore log al membro del progetto che rappresenterà l'estensione per il sistema Stackdriver Logging. Per istruzioni su come concedere i ruoli, consulta l'articolo Concessione di ruoli a un account di servizio per risorse specifiche. Per ulteriori informazioni sui ruoli di logging, consulta la Guida al controllo dell'accesso.

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

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

Questa estensione supporta la chiamata da parte di un criterio ExtensionCallout situato in PostClientFlow. Se vuoi utilizzare le norme sulle estensioni callout per chiamare questa estensione da un PostClientFlow, assicurati che il flag features.allowExtensionsInPostClientFlow è impostato su true nella tua organizzazione.

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

• Se sei un cliente Apigee Edge per il cloud privato, utilizza API Aggiorna le proprietà dell'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 (Google Cloud). Include spazio di archiviazione per i log, un'interfaccia utente detta visualizzatore log e un'API per la gestione dei log in modo programmatico. Con Stackdriver Logging puoi leggere e scrivere voci di log, cercare e filtrare i log, esportare i log e creare metriche basate su log.

Al momento questa estensione scrive voci nel log. Per ulteriori informazioni, consulta la documentazione su Stackdriver Logging.

Esempi

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

Log globale

Il criterio seguente scrive il messaggio "Questo è un test" in un log denominato example-log nella risorsa globale di Stackdriver. In realtà, è probabile che il messaggio sia contenuto in una variabile di flusso di cui hai impostato il valore 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 la procedura di configurazione di 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 Stackdriver. Le voci di log sono costituite da metadati e dai dati delle voci. Per ulteriori informazioni sulle voci di log, consulta Riferimento per le 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 Debug di un'estensione.

Riferimento alla configurazione

Quando configuri questa estensione e ne esegui il deployment da usare nei proxy API, usa quanto segue.

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.