Extensión de Google Stackdriver Logging

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Versión 1.2.0

Escribe entradas en los registros de Stackdriver Logging.

En este contenido, se proporciona 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 el campo Logging > Permiso de escritor de registros al miembro del proyecto que representará tu extensión en el sistema de Stackdriver Logging. Si quieres obtener instrucciones a fin de otorgar roles, consulta Otorga funciones a una cuenta de servicio para recursos específicos. Para obtener más información sobre las funciones de registro, consulta la Guía de control de acceso.

2. Usar GCP Console a fin de generar una clave para la cuenta de servicio

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

Acerca de Stackdriver Logging

Stackdriver Logging es parte del conjunto de productos de Stackdriver en Google Cloud Platform (GCP). Incluye almacenamiento para registros, una interfaz de usuario denominada 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 muestra cómo configurar la compatibilidad con las acciones de extensión de Stackdriver Logging con la política ExtensionReference.

Registro global

La siguiente política escribe el mensaje "Esto es una prueba". a un registro llamado example-log en el recurso Stackdriver Global. En el uso real, es probable que el mensaje se encuentre dentro de 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 referencia para configurar y usar esta extensión. Si quieres conocer los pasos para configurar una extensión con la consola de Apigee, consulta Agrega y configura 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 consisten en metadatos y los datos de 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

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 de extensión comunes

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.