Règle StatisticsCollector

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Quoi

Vous permet de collecter des statistiques sur les données d'un message, telles que l'ID de produit, le prix, l'action REST , l'URL cible et client et la longueur du message. Les données peuvent provenir de variables de flux prédéfinies par Apigee ou de variables personnalisées que vous définissez.

Les données statistiques sont transmises au serveur de données analytiques, qui les analyse et génère des rapports. Vous pouvez afficher les rapports à l'aide de l'interface utilisateur de gestion Edge ou de l'API Edge.

Exemples

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

$ 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

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

<?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>

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

À propos de la règle StatisticsCollector

Lorsqu'elle est exécutée, la règle StatisticsCollector enregistre la valeur actuelle d'une ou de plusieurs variables. Ces variables peuvent être des variables de flux prédéfinies par Apigee ou des variables personnalisées que vous définissez. Ces données sont écrites sur le serveur de données analytiques Edge.

Pour accéder aux données statistiques collectées par la règle, vous devez utiliser l'API Edge ou l'interface utilisateur de gestion Edge. Par exemple, vous pouvez utiliser l'interface utilisateur de gestion Edge pour créer un rapport personnalisé qui affiche les données collectées dans différents formats.

Pour obtenir un tutoriel complet sur l'utilisation de la règle StatisticsCollector, consultez la page Analyser le contenu du message de l'API à l'aide de données analytiques personnalisées.

Où placer la règle

Vous pouvez ajouter une règle StatisticsCollector dans le flux de requête ou de réponse d'un proxy d'API. Cependant, si vous ajoutez plusieurs règles StatisticsCollector dans un proxy, la dernière règle exécutée détermine les données écrites sur le serveur de données analytiques. Les données écrites par les règles StatisticsCollector précédentes sont perdues.

Un proxy d'API peut contenir plusieurs règles StatisticsCollector dans le cas suivant : lorsqu'une règle se trouve dans le flux de requête ou de réponse et que l'autre se trouve dans un gestionnaire d'erreurs. Si une erreur survient dans le proxy d'API, la règle StatisticsCollector du gestionnaire d'erreurs détermine les données collectées. Vous pouvez utiliser cette règle StatisticsCollector pour enregistrer des informations sur l'erreur ou pour enregistrer toute autre information que vous jugez nécessaire. La règle StatisticsCollector du gestionnaire d'erreurs détermine les données collectées, que la règle Statistics Collector de la requête/réponse ait déjà été exécutée ou non.

Pour en savoir plus, consultez la page Handling faults.

Documentation de référence des éléments

La documentation de référence des éléments décrit les éléments et les attributs de la règle StatisticsCollector.

<?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>

Attributs <StatisticsCollector>

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

Le tableau suivant décrit les attributs communs à tous les éléments parents des règles :

Élément <DisplayName>

Utilisez-le, en plus de l'attribut name, pour appliquer un libellé à la règle dans l'éditeur de proxys de l'interface de gestion en utilisant un nom différent, en langage naturel.

<DisplayName>Policy Display Name</DisplayName>

Élément <Statistics>/<Statistic>

<Statistics>
    <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
</Statistics>

Informations de référence sur les erreurs

Cette section décrit les messages d'erreur et les variables de flux définies lorsque cette règle déclenche une erreur. Ces informations sont importantes si vous développez des règles de défaillance pour un proxy. Pour en savoir plus, consultez les pages Ce que vous devez savoir à propos des erreurs liées aux règles et Gérer les pannes.

Erreurs d'exécution

Aucune

Erreurs de déploiement

Variables de panne

Aucune.

Schéma

Chaque type de règle est défini par un schéma XML (.xsd). Pour référence, des schémas de règles sont disponibles sur GitHub.

Articles associés

Pour en savoir plus, consultez les pages suivantes :

• Analyser le contenu du message de l'API à l'aide de données analytiques personnalisées
• Gérer des rapports personnalisés
• Utiliser les API de métriques pour mesurer les performances des programmes API