Политика сбора статистики

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

Что

Позволяет собирать статистику по данным в сообщении, таким как идентификатор продукта, цена, действие REST, 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.

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

Полное руководство по использованию политики сбора статистики см. в разделе «Анализ содержимого сообщений API с помощью пользовательской аналитики» .

Куда разместить полис

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

Один из сценариев, когда в API-прокси может быть несколько политик сбора статистики, — это когда одна находится в потоке запроса или ответа, а другая — в обработчике ошибок. Если в 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 name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
</Statistics>

Ссылка на ошибку

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

Fault variables

None.

Схема

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

Связанные темы

Для получения более подробной информации см.:

• Анализ содержимого сообщений API с помощью пользовательской аналитики.
• Управление пользовательскими отчетами
• Используйте API метрик для измерения производительности программ, использующих API.