Registrar los registros de acceso de Apigee

Esta página se aplica a Apigee, pero no a Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Los clientes de Apigee con suscripción y de pago por uso pueden habilitar los registros de acceso de entrada de Cloud Logging para cada instancia de Apigee de su organización. Una vez habilitada, esta función te permite ver los registros generados por las pasarelas de entrada de tu infraestructura de Apigee, como un balanceador de carga de aplicaciones externo o una pasarela de Anthos, para ayudarte a solucionar problemas con las llamadas a la API de Apigee.

Es importante tener en cuenta que, si esta función está habilitada en una o varias de tus instancias de Apigee, se te cobrarán los registros enviados a tu proyecto. Para obtener más información sobre los Google Cloud cargos por registro, consulta los precios de Cloud Logging.

En este tema se describe cómo pueden habilitar y usar los clientes de Apigee los registros de acceso de entrada de Cloud Logging para las instancias de Apigee de su organización.

Antes de empezar

Para habilitar la función, debe tener el siguiente rol y permisos:

• Roles: administrador de organización de Apigee (roles/apigee.admin)
• Permisos:
  • apigee.instances.create
  • apigee.instances.update

Habilitar el registro de acceso de entrada en las instancias de Apigee

Puedes habilitar el registro de acceso de entrada de Cloud Logging al crear o editar una instancia de Apigee mediante la interfaz de Apigee en la consola de Cloud o la API.

Para habilitar la función al crear o actualizar una instancia de Apigee, siga las instrucciones de Gestión de instancias para empezar a crear o editar una instancia.

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
          "enabled": "true",
          "filter": "status_code >= 0 && status_code < 600 "
        }
      }'

Una vez que la instancia se haya creado o actualizado correctamente, los registros de acceso de entrada de esa instancia deberían estar disponibles en tu proyecto en cuestión de minutos.

Ver los registros de acceso de entrada

Una vez que la función esté habilitada, podrás ver los registros de acceso de entrada de las instancias de tu proyecto en cuestión de minutos mediante el explorador de registros de la Google Cloud consola.

Para ver las entradas de registro en el Explorador de registros, sigue estos pasos:

1. En la Google Cloud consola, selecciona Registro > Explorador de registros.

   Ir a Explorador de registros

2. Asegúrate de que tu Google Cloud proyecto esté seleccionado.
3. En la pestaña Consulta, introduce el nombre del registro en el campo del editor Consulta con uno de los siguientes métodos:
   • Para usar el cuadro de selección Nombre de registro, sigue estos pasos:
     1. Haz clic en la casilla de selección Nombre de registro para abrir el panel Nombre de registro.
     2. Escribe ingress_instance en el cuadro Seleccionar nombres de registro.
     3. Haz clic en Aplicar.
     4. El nombre del registro aparece en el campo del editor Consulta.
   • En el campo del editor Consulta, introduce el nombre del registro directamente:

     logName="projects/ORG_NAME/logs/apigee.googleapis.com/ingress_instance"

4. Crea el resto de la consulta en el campo del editor Consulta. Los registros aparecerán en la lista Resultados de la consulta.
5. Haz clic en cualquier entrada de registro para ver más detalles.

Solucionar problemas con los registros de acceso de entrada

Una vez que la función esté habilitada y los registros estén disponibles en el explorador de registros, podrás aprovechar varias funciones de Cloud Logging para solucionar problemas, como las siguientes:

• Crear consultas con el lenguaje de consultas de Cloud Logging

  Puedes obtener y analizar registros con Explorador de registros escribiendo consultas en el campo del editor de consultas y seleccionando opciones de los menús de filtros incluidos en las entradas de registro. Para obtener más información sobre cómo crear consultas y analizar datos en el Explorador de registros, consulta el artículo Crear y guardar consultas con el lenguaje de consultas de Cloud Logging.

• Habilitar métricas y alertas basadas en registros

  Puedes definir tu propia métrica basada en registros para recoger información específica de tus instancias de Apigee. Para obtener más información, consulta el artículo Información general sobre las métricas basadas en registros.

  Puedes crear una política de alertas basada en registros desde el Explorador de registros. Para obtener más información y ver los pasos detallados, consulta Crear una política de alertas basada en registros con el Explorador de registros.

• Filtrar por códigos de estado HTTP

  Puedes acotar tus consultas en el Explorador de registros para filtrar por códigos de estado HTTP, aunque no hayas elegido filtrar tus registros de acceso de entrada por código de estado HTTP al habilitar la función. Para añadir este filtro a tu consulta, usa el siguiente formato:

  status_code > XX && status code <= YY

  Por ejemplo:

  status_code >= 500 && status_code < 504

• Filtrar por códigos de estado de entrada

  Además de filtrar por códigos de estado HTTP, puedes crear una consulta para filtrar por ingress status_code 0. Este código suele indicar un problema de red o de conectividad que impide que el cliente reciba una respuesta del servidor.

Para obtener una explicación detallada de todas las funciones disponibles en el Explorador de registros, consulta el artículo Ver registros con el Explorador de registros.

Inhabilitar la función

Una vez que hayas terminado de solucionar los problemas de tu instancia de Apigee, puedes editarla para inhabilitar la función. Si inhabilitas la función, se desactivará el acceso a los registros de ingress_instance de tu proyecto y se detendrá la facturación.

Puedes editar la instancia para inhabilitar la función mediante la interfaz de Apigee en la consola de Cloud o la API.

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
            "enabled": "false"
        }
        }'