Extensión de Google Stackdriver Logging

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Versión 1.3.7

Escribe entradas en los registros de Stackdriver Logging.

En este contenido, se proporciona información de referencia para configurar y usar esta extensión.

Requisitos previos

Antes de usar esta extensión desde un proxy de API, debes hacer lo siguiente:

1. En IAM, asigna los roles Logging > Logs Writer y Logging > Logs Viewer al miembro del proyecto que representará tu extensión en el sistema de Stackdriver Logging. Para obtener instrucciones sobre cómo otorgar roles, consulta Otorga roles a una cuenta de servicio para recursos específicos. Para obtener más información sobre los roles de Logging, consulta la Guía de control de acceso.

2. Usa GCP Console para generar una clave para la cuenta de servicio.

3. Usa el contenido del archivo JSON de la clave resultante cuando agregues y configures la extensión con la referencia de configuración.

Esta extensión admite que se la llame con una política ExtensionCallout ubicada en PostClientFlow. Si deseas usar la política ExtensionCallout para llamar a esta extensión desde un PostClientFlow, asegúrate de que la marca features.allowExtensionsInPostClientFlow esté establecida en true en tu organización.

• Si eres cliente de Apigee Edge para la nube pública, debes comunicarte con el equipo de asistencia de Apigee Edge para asegurarte de que la marca features.allowExtensionsInPostClientFlow esté establecida en true en tu organización.

• Si eres cliente de Apigee Edge para una nube privada, usa la API de Actualizar las propiedades de la organización para establecer la marca features.allowExtensionsInPostClientFlow en true.

Acerca de Stackdriver Logging

Stackdriver Logging forma parte del conjunto de productos de Stackdriver en Google Cloud Platform (GCP). Incluye almacenamiento para registros, una interfaz de usuario denominada el Visor de registros y una API con la que se pueden administrar los registros de manera programática. Con Stackdriver Logging, puedes leer y escribir entradas de registro, buscar y filtrar tus registros, exportarlos y crear métricas basadas en registros.

Actualmente, esta extensión escribe entradas en el registro. Para obtener más información, consulta los documentos de Stackdriver Logging.

Ejemplos

En los siguientes ejemplos, se ilustra cómo configurar la compatibilidad con las acciones de extensión de Stackdriver Logging a través de la política de ExtensionCallout.

Registro global

La siguiente política escribe el mensaje "This is a test" en un registro llamado example-log en el recurso global de Stackdriver. En el uso real, es probable que el mensaje se encuentre en una variable de flujo cuyo valor establezcas en otro lugar del proxy de 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>

En este contenido, se proporciona información de referencia para configurar y usar esta extensión. Si deseas conocer los pasos para configurar una extensión con la consola de Apigee, consulta Cómo agregar y configurar una extensión.

Acciones

log

Escribe un mensaje en el registro.

Esta acción escribe una entrada de registro de Stackdriver. Las entradas de registro constan de metadatos y los datos de la entrada. Para obtener más información sobre las entradas de registro, consulta la referencia de entrada. Para obtener información sobre el contenido de la propiedad metadata, consulta el objeto LogEntry en la documentación 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>

Parámetros de solicitud

Respuesta

Devuelve None si el mensaje se escribió en el registro. De lo contrario, la solicitud mostrará un error. Consulta también Cómo depurar una extensión.

Referencia de configuración

Usa la siguiente información cuando configures e implementes esta extensión para usarla en proxies de API.

Propiedades comunes de las extensiones

Las siguientes propiedades están presentes para cada extensión.

Propiedades de este paquete de extensión

Especifica valores para las siguientes propiedades de configuración específicas de esta extensión.