Descripción general de las anomalías de operaciones

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Anomalías de operaciones identifica patrones de datos inusuales o inesperados en tus APIs. Anomalías de operaciones supervisa y realiza análisis estadísticos de forma continua para encontrar anomalías.

Anomalías de operaciones detecta automáticamente estos tipos de anomalías:

  • Aumento de todos los errores HTTP 4xx o 5xx a nivel de organización, entorno y región
  • Aumento en la latencia total de respuesta para el percentil 90 (p90) a nivel de organización, entorno y región

Por ejemplo, en este gráfico de la tasa de errores de la API, la tasa aumenta repentinamente cerca de las 7 a.m. En comparación con los datos anteriores, este aumento es lo suficientemente inusual como para clasificarlo como una anomalía.

Grafo de una anomalía de tasa de error

Las anomalías de operaciones también pueden discernir variaciones que es menos probable que indiquen anomalías. Por ejemplo, puedes ver algunas variaciones menores en la tasa de error que conducen a la anomalía, pero no son lo suficientemente significativas como para clasificarse como una anomalía.

Anomalía en comparación con una variación de datos aleatorios.

Anomalías de operaciones te permite hacer lo siguiente:

  • Ver e investigar anomalías: Las anomalías de operaciones informan sobre eventos inusuales de la API (anomalías). Puedes desglosar para saber dónde y cuándo ocurrió el incidente, y qué lo activó, a fin de permitirte solucionar la situación con rapidez.
  • Crea alertas de anomalías y configura notificaciones para que Apigee te envíe un mensaje cuando ocurra un incidente.

Requisitos previos para usar las anomalías de operaciones

Para usar las anomalías de operaciones, sigue estos pasos:

  • El complemento de AAPI Ops debe estar habilitado para tu organización. Consulta Habilita AAPI Ops en una organización.
  • Los usuarios de anomalías de operaciones deben tener los siguientes roles:
    • roles/apigee.readOnlyAdmin
    • roles/logging.viewer
    • roles/monitoring.viewer
  • Los usuarios que investigan anomalías en el panel también necesitan el rol roles/logging.viewer.

Habilita AAPI Ops en una organización

Para usar AAPI Ops, debes habilitarla en tu organización. Antes de hacerlo, primero obtén un token de acceso de OAuth 2.0. Luego, puedes habilitar AAPI Ops mediante una llamada a la API que pase el token de acceso.

Visualiza la configuración actual de complementos

Antes de habilitar AAPI Ops, verifica si ya están habilitadas mediante la siguiente llamada a la API:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

En el ejemplo anterior, YOUR_ORG es el nombre de tu organización y $TOKEN es la variable de entorno para un token de acceso de OAuth. Esto muestra información básica sobre tu organización, que incluye una sección para los complementos de Apigee que comienza con la siguiente línea:

"addonsConfig": {

Verifica si esta sección contiene una entrada que comienza con "advancedApiOpsConfig", como en el siguiente ejemplo:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Si esta entrada está presente, AAPI Ops ya están habilitadas en la organización. De lo contrario, debes habilitarla como se describe a continuación.

Habilita AAPI Ops

Para habilitar AAPI Ops en la organización con la configuración predeterminada, emite una solicitud POST como la que se muestra a continuación.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

En el ejemplo anterior, <Current add-ons configuration> es la configuración actual de los complementos. Puedes encontrar la configuración actual de los complementos en la respuesta a la llamada para ver la configuración actual de los complementos. Por ejemplo, si la configuración actual de los complementos es

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

el comando para habilitar AAPI Ops sería 

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Después de enviar la solicitud, verás una respuesta como la siguiente:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Inhabilita AAPI Ops en tu organización

Si, por algún motivo, necesitas inhabilitar AAPI Ops en tu organización, puedes hacerlo mediante la emisión de una solicitud POST y el paso de la configuración de complementos en el cuerpo de la solicitud, como se muestra a continuación.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

A continuación, se ofrece un ejemplo de la respuesta que muestra que la operación está en curso: 

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Si deseas obtener más información, consulta Configura la API de complementos de la organización.

Cómo funciona la detección de anomalías

La detección de anomalías implica las siguientes etapas:

Entrena modelos

Anomalías de operaciones funciona entrenando un modelo del comportamiento de tus proxies de API a partir de datos históricos de series temporales. No es necesario que realices ninguna acción para entrenar el modelo. Apigee crea y entrena de forma automática modelos de las seis horas anteriores de los datos de API. Por lo tanto, Apigee requiere un mínimo de seis horas de datos en un proxy de API a fin de entrenar el modelo antes de que pueda registrar una anomalía.

El objetivo del entrenamiento es mejorar la exactitud del modelo, que, luego, se puede probar con datos históricos. La forma más simple de probar la exactitud de un modelo es calcular su tasa de error, la suma de falsos positivos y falsos negativos, dividida por la cantidad total de eventos previstos.

Registra eventos de anomalía

En el entorno de ejecución, Anomalías de operaciones compara el comportamiento actual de los proxies de API con el comportamiento que predice el modelo. Las anomalías de operaciones pueden determinar, con un nivel de confianza específico, cuando una métrica operativa excede el valor previsto. Por ejemplo, cuando la tasa de errores 5xx supera la tasa que predice el modelo.

Cuando Apigee detecta una anomalía, registra automáticamente el evento en el panel de anomalías de operaciones. La lista de eventos que se muestra en el panel incluye todas las anomalías detectadas, además de las alertas activadas.