Правила StatisticsCollector

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Что

Позволяет собирать статистику по данным в сообщении, например идентификатору товара, цене, действию REST, URL клиента и целевому URL, а также длине сообщения. Данные могут поступать из переменных потока, заданных Apigee, или из пользовательских переменных, которые вы определяете сами.

Статистические данные передаются на сервер аналитики, который анализирует их и создает отчеты. Отчеты можно посмотреть в интерфейсе управления Edge или Edge API.

Примеры

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

Правила в отношении сборщика статистики

При выполнении правила "Сборщик статистики" записывает текущее значение одной или нескольких переменных. Это могут быть переменные потока, заданные Apigee, или пользовательские переменные, которые вы определяете сами. Эти данные записываются на сервер аналитики Edge.

Чтобы получить доступ к статистическим данным, собранным правилом, используйте Edge API или интерфейс управления Edge. Например, с помощью интерфейса управления Edge можно создать специальный отчет, в котором собранные данные будут представлены в разных форматах.

Полное руководство по использованию правила Statistics Collector приведено в статье Как анализировать содержимое сообщений API с помощью специальной аналитики.

Где разместить правила

Вы можете добавить правило Statistics Collector в поток запросов или ответов прокси API. Однако если в прокси-сервере задано несколько правил для сборщика статистики, то данные, записанные предыдущими правилами, будут потеряны, а на сервер аналитики будут отправлены только данные, собранные последним выполненным правилом.

В прокси-сервере API может быть несколько правил Statistics Collector, например если одно из них находится в потоке запроса или ответа, а другое – в обработчике ошибок. Если в прокси-сервере API возникает ошибка, сборщик статистики в обработчике ошибок определяет, какие данные будут собраны. Вы можете использовать этот сборщик статистики, чтобы записать информацию о неисправности или любую другую информацию, которую считаете необходимой. Сборщик статистики в обработчике ошибок определяет, какие данные будут собраны, независимо от того, был ли уже выполнен сборщик статистики в запросе или ответе.

Подробнее о том, как обрабатывать ошибки…

Сведения об элементах

Справочник по элементам содержит описание элементов и атрибутов правила "Сборщик статистики".

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

Атрибуты <StatisticsCollector>

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

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <Statistics>/<Statistic>

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

Справочник по ошибкам

В этом разделе описаны сообщения об ошибках и переменные потока, которые устанавливаются, когда это правило вызывает ошибку. Эта информация важна, если вы разрабатываете правила обработки ошибок для прокси. Подробнее о том, что нужно знать об ошибках в правилах и об обработке ошибок…

Ошибки времени выполнения

Нет.

Ошибки развертывания

Переменные ошибок

Нет.

Схема

Каждый тип правил определяется схемой XML (.xsd). Схемы правил доступны на GitHub.

Статьи по теме

Статьи по теме

• Анализ контента сообщений API с помощью специальной аналитики
• Как управлять специальными отчетами
• Как использовать API показателей для оценки эффективности программы API