Extension Google Stackdriver Logging

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Version 1.3.7

Écrivez des entrées dans les journaux Stackdriver Logging.

Ce contenu fournit des informations de référence pour configurer et utiliser cette extension.

Prérequis

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 et Logging > Lecteur de journaux au membre du projet qui représentera votre extension du système Stackdriver 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 la journalisation des rôles, consultez le guide du contrôle des accès.

2. Générez une clé pour le compte de service à l'aide de la console GCP.

3. Utilisez le contenu du fichier JSON de clé obtenu lors de l'ajout et de la configuration de l'extension à l'aide de la documentation de référence de configuration.

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

• Si vous êtes un client Apigee Edge for 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 la API Update Organization Properties pour définir l'option features.allowExtensionsInPostClientFlow sur true.

À propos de Stackdriver Logging

Stackdriver Logging fait partie de la suite de produits Stackdriver de Google Cloud Platform (GCP). Elle comprend un espace de stockage de journaux, une interface utilisateur appelée "visionneuse de journaux" et une API permettant de gérer les journaux par programmation. Avec Stackdriver Logging, vous pouvez lire et écrire des entrées de journal, rechercher et filtrer vos journaux, les exporter et créer des métriques basées sur les journaux.

Cette extension écrit actuellement des entrées dans le journal. Pour en savoir plus, consultez la documentation sur Stackdriver Logging.

Exemples

Les exemples suivants montrent comment configurer la prise en charge des actions de l'extension Stackdriver Logging à l'aide de la règle ExtensionCall.

Journal global

La stratégie suivante écrit le message "This is a test" (Ceci est un test) dans un journal appelé "example-log" dans la ressource globale Stackdriver. Dans la pratique, le message serait probablement contenu dans une variable de flux dont la valeur serait définie 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>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>

Ce contenu fournit des informations de référence pour configurer et utiliser cette extension. Pour savoir comment configurer 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 Stackdriver. Les entrées de journal sont constituées de métadonnées et de 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 l'objet LogEntry dans la documentation de 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>

Paramètres de requête

Réponse

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

Documentation de référence sur la configuration

Procédez comme suit lorsque vous configurez et déployez cette extension afin de l'utiliser dans des proxys d'API.

Propriétés courantes des extensions

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

Propriétés de ce package d'extension

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