Extensión de Google Cloud Logging

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

Versión 1.6.0

Escribe entradas en los registros de Cloud 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 Registro > Escritor de registros para el miembro del proyecto que representará tu extensión en el sistema de Cloud 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. Usa la consola de Google Cloud 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.

Esta extensión admite que la llame una política ExtensionReference ubicada en PostClientFlow. Si desea utilizar la política ExtensionReference para llamar a esta extensión desde una PostClientFlow, asegúrate de que la marca features.allowExtensionsInPostClientFlow se estableció 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 el La marca features.allowExtensionsInPostClientFlow se estableció en true en tu organización.

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

Acerca de Cloud Logging

Cloud Logging forma parte del operations suite. Incluye almacenamiento para registros, una interfaz de usuario llamada explorador y una API para administrar registros de manera programática. Con Cloud Logging, puedes hacer lo siguiente: leer y escribir entradas de registro, buscar y filtrar tus registros, exportarlos y crear métricas basadas en registros.

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

Ejemplos

En los siguientes ejemplos, se muestra cómo configurar la compatibilidad con Cloud Logging acciones de extensión con la política ExtensionReference.

Registro global

La siguiente política escribe el mensaje This is a test en un registro llamado example-log en el recurso de Cloud Global. En el uso real, probablemente Hacer que el mensaje esté contenido en una variable de flujo cuyo valor establezcas en otro lugar. en el 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>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>

En este contenido, se proporciona referencia para configurar y usar esta extensión. Si deseas 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 Cloud Logging. 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 la LogEntry en la documentación de 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>

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 la 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.