Política de StatisticsCollector

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

Qué

Permite recopilar estadísticas de datos en un mensaje, como ID del producto, precio y REST. acción, la URL de cliente y de destino, y la longitud del mensaje. Los datos pueden provenir de variables de flujo predefinidos por Apigee o variables personalizadas que definas.

Los datos de estadísticas se pasan al servidor de análisis, que las analiza. genera informes. Puedes ver los informes con la IU de administración o la API de Edge.

Ejemplos

Ejemplo básico

<StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="productID" ref="product.id" type="string">999999</Statistic>
    <Statistic name="price" ref="product.price" type="string">0</Statistic>
  </Statistics>
</StatisticsCollector>

En este ejemplo, recopila información estadística sobre dos variables personalizadas: product.id y product.price. En cada solicitud, el La política del Recopilador de estadísticas escribe el valor de estas dos variables en el análisis servidor.

En este ejemplo, también se establece un valor predeterminado opcional para cada variable, donde el valor el valor de product.id es 999999. y el valor predeterminado product.price es 0. Si una variable no está definida y no especificas un valor predeterminado, no se generan datos registrados para la variable. Si especificas un valor predeterminado, este es el se registran cuando la variable no está definida.

Después de recopilar datos estadísticos, puedes usar la IU o la API de administración perimetral para recuperar las estadísticas. Cuando recuperas estadísticas, debes hacer referencia a los datos recopilados para estas variables como productID y price, respectivamente.

Accede a las estadísticas

En este ejemplo, se usa la API de Edge Management para ver los datos estadísticos del colección llamada productID. Con esta solicitud, se crea un informe personalizado IDs de productos basados en la suma de recuentos de mensajes enviados para cada ID de producto de cada día. Sustituye el nombre de tu organización por la variable {org_name}. usa el correo electrónico y la contraseña de tu cuenta en Apigee Edge para email:password

Establece el parámetro timeRange para incluir el intervalo de tiempo en el que se almacenaron tus datos de los datos recopilados. De forma predeterminada, no se puede acceder a los datos anteriores a seis meses a partir de la fecha actual. Si Si deseas acceder a datos con más de seis meses de antigüedad, comunícate con el equipo de asistencia de Apigee Edge.

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/productID?"select=sum(message_count)&timeRange=1/19/2015%2000:00~6/21/2015%2000:00&timeUnit=day"
-u email:password

En la respuesta, el campo name contiene el ID del producto, y el valor muestra la cantidad de solicitudes de cada día:

{
  "environments" : [ {
    "dimensions" : [ {
      "metrics" : [ {
        "name" : "sum(message_count)",
        "values" : [ {
          "timestamp" : 1353369600000,
          "value" : "4.0"
        } ]
      } ],
      "name" : "52"
    }, {
      "metrics" : [ {
        "name" : "sum(message_count)",
        "values" : [ {
          "timestamp" : 1353369600000,
          "value" : "19.0"
        } ]
      } ],
      "name" : "14"
    }, ...
  } ],
  "metaData" : {
    "samplingRate" : "100"
  }
}

Extraer datos para recopilarlos

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ExtractVariables async="false" continueOnError="false" enabled="true" name="GetWeatherData">
    <VariablePrefix>weather</VariablePrefix>
    <XMLPayload>
       <Namespaces>
          <Namespace prefix="yweather">http://xml.weather.yahoo.com/ns/rss/1.0</Namespace>
       </Namespaces>
       <Variable name="location" type="string">
          <XPath>/rss/channel/yweather:location/@city</XPath>
       </Variable>
       <Variable name="condition" type="string">
          <XPath>/rss/channel/item/yweather:condition/@text</XPath>
       </Variable>
    </XMLPayload>
</ExtractVariables>

La política Recopilador de estadísticas requiere que los datos recopilados se almacenen en variables. Apigee puede predefinir estas variables, o las variables personalizadas que definas.

En este ejemplo, usarás la política Extraer variables para extraer datos de una carga útil XML. que contiene información meteorológica. Esta política sirve para lo siguiente:

  • Extrae el nombre de la ciudad y lo escribe en una variable llamada weather.location.
  • Extrae las condiciones actuales y las escribe en una variable llamada weather.condition.

Luego, puedes usar la política Recopilador de estadísticas para recopilar información sobre el variables, como se muestra a continuación:

<StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="weatherLocation" ref="weather.location" type="string"></Statistic>
    <Statistic name="weatherCondition" ref="weather.condition" type="string"></Statistic>
  </Statistics>
</StatisticsCollector>

Para ver un tutorial completo que muestre cómo extraer datos de una carga útil XML para el Política del recopilador de estadísticas; consulta API de análisis el contenido de los mensajes con estadísticas personalizadas.


Acerca de la política Recopilador de estadísticas

Cuando se ejecuta, la política del Recopilador de estadísticas registra el valor actual de uno o más variables. Estas pueden ser variables de flujo predefinidas por Apigee o variables personalizadas que que definas. Estos datos se escriben en el servidor de estadísticas perimetrales.

Para acceder a los datos estadísticos que recopila la política, usa la API de Edge o Edge de administración de identidades y accesos. Por ejemplo, puedes usar la IU de administración perimetral para crear un informe personalizado que muestra los datos recopilados en diversos formatos.

Para ver un instructivo completo sobre el uso de la política Statistics Collector, consulta Analyze API el contenido de los mensajes con estadísticas personalizadas.

Dónde colocar la política

Puedes colocar una política del Recopilador de estadísticas en el flujo de solicitud o respuesta de una API proxy. Sin embargo, si coloca varias políticas del Recopilador de estadísticas en un proxy, la última uno a ejecutar determina los datos escritos en el servidor de análisis y los datos escritos por cualquier se pierden las políticas anteriores del Recopilador de estadísticas.

Una situación en la que podrías tener varias políticas del Recopilador de estadísticas en un proxy de API es cuando tiene una en el flujo de solicitud o respuesta y otra en un controlador de fallas. Si una falla en el proxy de API, el Recopilador de estadísticas en el controlador de fallas de los datos recopilados. Puedes usar ese Recopilador de estadísticas para registrar información sobre un error o para registra cualquier otra información que consideres necesaria. El Recopilador de estadísticas en la falla el controlador determina los datos recopilados independientemente de si el Recopilador de estadísticas en la solicitud/respuesta ya ejecutada.

Para obtener más información, consulta Soluciona fallas.

Referencia del elemento

La referencia de los elementos describe los elementos y atributos del Recopilador de estadísticas política de la empresa.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatisticsCollector async="false" continueOnError="false" enabled="true" name="Statistics-Collector-1">
    <DisplayName>Statistics Collector 1</DisplayName>
    <Statistics>
        <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
    </Statistics>
</StatisticsCollector>

&lt;StatisticsCollector&gt; atributos

<StatisticsCollector async="false" continueOnError="false" enabled="true" name="Stats-1">

En la siguiente tabla, se describen los atributos que son comunes a todos los elementos principales de las políticas:

Atributo Descripción Predeterminado Presencia
name

El nombre interno de la política. El valor del atributo name puede contener letras, números, espacios, guiones, guiones bajos y puntos. Este valor no puede superar los 255 caracteres.

De forma opcional, usa el elemento <DisplayName> para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

N/A Obligatorio
continueOnError

Configúralo como false para mostrar un error cuando una política falla. Este es el comportamiento previsto para la mayoría de las políticas.

Configúralo como true para continuar con la ejecución del flujo incluso después de que una política falle.

falso Opcional
enabled

Configúralo como true para aplicar la política.

Configúralo como false para desactivar la política. La política no se aplicará incluso si permanece adjunta a un flujo.

true Opcional
async

Este atributo dejó de estar disponible.

falso Obsoleta

Elemento <DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

<DisplayName>Policy Display Name</DisplayName>
Predeterminada

N/A

Si omites este elemento, se usa el valor del atributo name de la política.

Presencia Opcional
Tipo String

&lt;Statistics&gt;/&lt;Statistic&gt; elemento

<Statistics>
    <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
</Statistics>
Atributo Descripción Predeterminado Presencia
nombre

Es el nombre que se usa para hacer referencia a los datos recopilados para la variable especificada. Al ver datos de Analytics, usa este nombre para hacer referencia a los datos recopilados sobre la variable especificadas por el ref .

Si la variable especificada por ref no está definida en una solicitud o respuesta, entonces defaultStatValue especifica el valor recopilados para la variable. Si omites el valor predeterminado, no se recopilan datos del cuando la variable no está definida.

Restricciones de nombres

Las siguientes restricciones de denominación se aplican a variables de estadísticas personalizadas:

N/A Obligatorio
ref

La variable de flujo para la que recopilas estadísticas Esta variable puede ser un flujo variable predefinida de Apigee o una variable personalizada que definas en tu proxy de API.

El atributo ref suele hacer referencia a una variable personalizada definida por la función Extraer variables. política de la empresa. Consulta Extrae variables política para obtener más información.

N/A Obligatorio
tipo

Especifica el tipo de datos de la variable especificada por el atributo ref. Los valores válidos son los siguientes: string/integer/float/long/double/boolean.

Para los datos de tipo cadena, haz referencia a los datos estadísticos como una Dimensión en un informe personalizado. Para los tipos de datos numéricos (número entero/flotante/long/doble), haz referencia al datos estadísticos en un informe personalizado, como una Dimensión o una Métrica. Consulta Cómo administrar informes personalizados para obtener más información.

El valor de type solo se puede omitir si ref se refiere a un La variable de flujo de Apigee o el tipo se declara en la carga útil XML de las variables de extracción política de la empresa.

string Opcional

Referencia de errores

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

None.

Deployment errors

Error name Cause Fix
UnsupportedDatatype If the type of the variable specified by the ref attribute in the <Statistic> element of the Statistics Collector policy is unsupported, then the deployment of the API proxy fails. The supported data types are string, integer, float, long, double, and boolean.
InvalidName If the name used to reference the data collected for the specified variable defined within the <Statistic> element of the Statistics Collector policy conflicts with a system-defined variable, then the deployment of the API proxy fails. Some of the known system-defined variables are organization and environment.
DatatypeMissing If the type of the variable specified by the ref attribute in the <Statistic> element of the Statistics Collector policy is missing, then the deployment of the API proxy fails.

Fault variables

None.

Esquema

Un esquema XML (.xsd) define cada tipo de política. Como referencia, los esquemas de políticas están disponibles en GitHub.

Temas relacionados

Para obtener más información, consulta: