Registra 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 suscripción de Apigee y de pago por uso pueden habilitar los registros de acceso de entrada de Cloud Logging para cada instancia de Apigee en su organización. Una vez habilitada, esta función te permite ver los registros que generan las puertas de enlace de entrada en la infraestructura de Apigee, como un balanceador de cargas de aplicaciones externo o una puerta de enlace de Anthos, para ayudar a solucionar problemas de llamadas a la API de Apigee.

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

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

Antes de comenzar

Para habilitar la función, debes tener el siguiente rol y los siguientes permisos:

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

Verifica los roles

  1. En la consola de Google Cloud, ve a la página IAM.

    Ir a IAM
  2. Selecciona el proyecto.

  3. En la columna Principal, busca la fila que tiene tu dirección de correo electrónico.

    Si tu dirección de correo electrónico no está en esa columna, no tienes ningún rol.

  4. En la columna Rol de la fila con la dirección de correo electrónico, verifica si la lista de roles incluye los roles necesarios.

Otorga los roles

  1. En la consola de Google Cloud, ve a la página IAM.

    Ir a IAM
  2. Selecciona el proyecto.
  3. Haz clic en Otorgar acceso.
  4. En el campo Principales nuevas, ingresa tu dirección de correo electrónico.
  5. En la lista Seleccionar un rol, elige un rol.
  6. Para otorgar funciones adicionales, haz clic en Agregar otro rol y agrega cada rol adicional.
  7. Haz clic en Guardar.

Habilita el registro de acceso de entrada para las instancias de Apigee

Puedes habilitar el registro de acceso de entrada de Cloud Logging cuando creas o editas una instancia de Apigee con la IU de Apigee en la consola de Cloud o la API.

Para habilitar la función cuando creas o actualizas una instancia de Apigee, sigue las instrucciones en Administra instancias para comenzar a crear o editar una instancia.

Apigee en la consola de Cloud

En la sección Logging de la página Crea una instancia o Editar instancia:

  1. Haz clic en el botón de activación Habilitar registro para habilitar la función.
  2. De forma opcional, selecciona un código de respuesta HTTP del cuadro código de respuesta para que actúe como filtro para los registros de acceso.

    Si deseas incluir todos los registros, sin importar el código de respuesta HTTP, selecciona None (all HTTP responses).

    Para crear un filtro personalizado, selecciona Custom y, luego, ingresa el filtro en el siguiente formato:

    status_code > XX && status code <= YY

    Por ejemplo:

    status_code >= 500 && status_code < 504

  3. Después de proporcionar toda la información necesaria para crear o editar tu instancia, haz clic en Guardar.

API de Apigee

Para actualizar una instancia existente con la API de Apigee, usa el siguiente comando: 

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 "
        }
      }'

Aquí:

  • ORG_NAME es el nombre de tu organización de Apigee.
  • INSTANCE_NAME es el nombre de la instancia de Apigee que deseas editar.

Ten en cuenta que, en este comando, el valor especificado para la propiedad filter mostrará todos los registros. Si deseas filtrar los registros según HTTP o algún otro código de estado, puedes ajustar el valor filter.

Una vez que la instancia se cree o actualice con éxito, los registros de acceso de entrada para esa instancia deberían estar disponibles en tu proyecto en cuestión de minutos.

Visualiza los registros de acceso de entrada

Una vez habilitada la función, 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 consola de Google Cloud.

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

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

    Ir al Explorador de registros

  2. Asegúrate de que tu proyecto de Google Cloud esté seleccionado.
  3. En la pestaña Consulta, ingresa el nombre de registro en el campo del Editor de consultas mediante uno de los siguientes métodos:
    • Para usar la casilla de selección Nombre del registro, sigue estos pasos:
      1. Haz clic en la casilla de selección Nombre del registro para abrir el panel Nombre del registro.
      2. Ingresa 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 de consulta.
    • En el campo del editor de consultas, ingresa el nombre del registro directamente:

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

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

Soluciona problemas con los registros de acceso de entrada

Una vez que la función habilitada y los registros estén disponibles en el Explorador de registros, puedes aprovechar una serie de funciones de Cloud Logging para solucionar problemas, incluidas las siguientes:

  • Compila consultas con el lenguaje de consulta de Cloud Logging

    Para recuperar y analizar registros cuando usas el Explorador de registros, escribe consultas en el campo del editor de consultas y realiza selecciones desde las opciones de menús de filtro incluidas en las entradas de registro. Para obtener más información sobre cómo compilar consultas y analizar datos en el Explorador de registros, visita Compila y guarda consultas con el lenguaje de consulta de Cloud Logging.

  • Habilita alertas y métricas basadas en registros

    Puedes definir su propia métrica basada en registros para capturar información específica de sus instancias de Apigee. Para obtener más información, consulta Descripción general de 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 pasos detallados, consulta Crea una política de alertas basada en registros mediante el Explorador de registros.

  • Filtrado por códigos de estado HTTP

    Puedes definir mejor tus consultas en el Explorador de registros para filtrar por códigos de estado HTTP, incluso si no elegiste filtrar tus registros de acceso de entrada por código de estado HTTP cuando habilitaste la función. Para agregar este filtro a tu consulta, usa el siguiente formato:

    status_code > XX && status code <= YY

    Por ejemplo:

    status_code >= 500 && status_code < 504

  • Filtrado 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 a menudo indica un problema de red o 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 Visualiza los registros con el Explorador de registros.

Inhabilita la función

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

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

Apigee en la consola de Cloud

Para inhabilitar la función con Apigee en la consola de Cloud, sigue estos pasos:

  • Abre la IU de Apigee en la consola de Cloud en tu navegador.
  • Selecciona Administración > Instancias.
  • Selecciona la instancia que deseas borrar.
  • En la página Detalles de la instancia, haz clic en Editar.
  • En la página Editar instancia, haz clic en el botón de activación Habilitar registro para inhabilitar la función.
  • Haz clic en Guardar.

    • API de Apigee

    Usa el siguiente comando para inhabilitar la función en tu 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": "false"
        }
        }'

    Aquí:

    • ORG_NAME es el nombre de tu organización de Apigee.
    • INSTANCE_NAME es el nombre de la instancia de Apigee que deseas editar.