Extension Google Cloud Logging

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Version 1.6.1

Écrire des entrées dans les journaux Cloud Logging

Ce contenu fournit une documentation de référence sur la configuration et l'utilisation de cette extension.

Conditions préalables

Avant d'utiliser cette extension à partir d'un proxy d'API, vous devez:

1. Dans IAM, attribuez le rôle Logging > Rédacteur de journaux au membre du projet qui représentera votre extension auprès du système Cloud Logging. Pour savoir comment attribuer des rôles, consultez Attribuer des rôles à un compte de service pour des ressources spécifiques. Pour en savoir plus sur les rôles de journalisation, consultez le guide du contrôle des accès.

2. Utilisez la console Google Cloud afin de générer une clé pour le compte de service.

3. Utilisez le contenu du fichier JSON de clé obtenu lorsque vous ajoutez et configurez l'extension à l'aide des documents de référence de configuration.

Cette extension peut être appelée par une règle ExtensionCallout située dans PostClientFlow. Si vous souhaitez utiliser la règle ExtensionCallout pour appeler cette extension à partir d'un PostClientFlow, assurez-vous que l'indicateur features.allowExtensionsInPostClientFlow est défini sur true dans votre organisation.

• Si vous êtes un client Apigee Edge pour Public Cloud, vous devez contacter l'assistance Apigee Edge pour vous assurer que l'option features.allowExtensionsInPostClientFlow est définie sur true dans votre organisation.

• Si vous êtes un client Apigee Edge pour Private Cloud, utilisez l'API Mettre à jour les propriétés de l'organisation pour définir l'option features.allowExtensionsInPostClientFlow sur true.

À propos de Cloud Logging

Cloud Logging fait partie de la suite Google Cloud Operations. Elle comprend un espace de stockage pour les journaux, une interface utilisateur appelée Explorateur de journaux et une API permettant une gestion automatisée des journaux. Avec Cloud Logging, vous pouvez lire et écrire des entrées de journal, rechercher et filtrer vos journaux, exporter vos journaux et créer des métriques basées sur les journaux.

L'extension Cloud Logging écrit actuellement des entrées dans le journal. Pour en savoir plus, consultez la documentation Cloud Logging.

Samples

Les exemples suivants montrent comment configurer la compatibilité des actions de l'extension Cloud Logging à l'aide de la règle ExtensionCallout.

Journal global

La stratégie suivante écrit le message This is a test dans un journal appelé example-log de la ressource cloud globale. En situation réelle, le message doit probablement être contenu dans une variable de flux dont vous avez défini la valeur ailleurs dans le proxy d'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>

Ce contenu fournit une documentation de référence sur la configuration et l'utilisation de cette extension. Pour connaître les étapes de configuration d'une extension à l'aide de la console Apigee, consultez Ajouter et configurer une extension.

Actions

log

Écrit un message dans le journal.

Cette action écrit une entrée de journal Cloud Logging. Les entrées de journal se composent de métadonnées et des données d'entrée. Pour en savoir plus sur les entrées de journal, consultez la documentation de référence sur les entrées. Pour en savoir plus sur le contenu de la propriété metadata, consultez la section sur l'objet LogEntry dans la documentation 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>

Paramètres de requête

Réponse

None si le message a été écrit dans le journal. Sinon, la requête renverra une erreur. Consultez également la section Déboguer une extension.

Documentation de référence sur la configuration

Utilisez le code suivant lorsque vous configurez et déployez cette extension pour l'utiliser dans des proxys d'API.

Propriétés d'extension courantes

Les propriétés suivantes sont présentes pour chaque extension.

Propriétés de ce package d'extension

Spécifiez les valeurs des propriétés de configuration suivantes spécifiques à cette extension.