StatisticsCollector-Richtlinie

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zuApigee X wechseln. info

Was

Ermöglicht das Erfassen von Statistiken für Daten in einer Nachricht, z. B. Produkt-ID, Preis, REST Aktion, Client- und Ziel-URL und Nachrichtenlänge. Die Daten können aus von Apigee vordefinierten Ablaufvariablen oder von Ihnen definierten benutzerdefinierten Variablen stammen.

Die Statistikdaten werden an den Analyseserver übergeben, der die Statistiken analysiert und Berichte erstellt. Sie können die Berichte über die Edge-Verwaltungs-UI oder die Edge API aufrufen.

Beispiele

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

Informationen zur Statistics Collector-Richtlinie

Bei der Ausführung erfasst die Statistics Collector-Richtlinie den aktuellen Wert einer oder mehrerer Variablen. Diese Variablen können von Apigee vordefinierte Ablaufvariablen oder von Ihnen definierte benutzerdefinierte Variablen sein. Diese Daten werden auf den Edge-Analyseserver geschrieben.

Um auf die von der Richtlinie erfassten statistischen Daten zuzugreifen, verwenden Sie die Edge API oder die Edge Verwaltungs-UI. Sie können beispielsweise mit der Edge-Verwaltungs-UI einen benutzerdefinierten Bericht erstellen, in dem die erfassten Daten in verschiedenen Formaten angezeigt werden.

Ein vollständiges Tutorial zur Verwendung der Statistics Collector-Richtlinie finden Sie unter API -Nachrichteninhalte mithilfe benutzerdefinierter Analysen auswerten.

Wo sollte die Richtlinie platziert werden?

Sie können eine Statistik-Collector-Richtlinie in den Anfrage- oder Antwortablauf eines API Proxys einfügen. Wenn Sie jedoch mehrere Statistics Collector-Richtlinien in einen Proxy einfügen, bestimmt die zuletzt auszuführende Richtlinie die Daten, die auf den Analyseserver geschrieben werden, und die Daten, die von den vorherigen Statistics Collector-Richtlinien geschrieben wurden, gehen verloren.

Ein Szenario, in dem Sie möglicherweise mehrere Statistics Collector-Richtlinien in einem API-Proxy haben, ist wenn Sie eine im Anforderungs- oder Antwortablauf und eine andere in einem Fehler-Handler haben. Wenn ein Fehler im API-Proxy auftritt, ermittelt der Statistics Collector im Fehlerbehandlungsprogramm die erfassten Daten. Sie können diesen Statistics Collector verwenden, um Informationen zum Fehler oder um andere Informationen zu erfassen, die Sie für erforderlich halten. Der Statistics Collector im Fehlerbehandlungsprogramm bestimmt die erfassten Daten unabhängig davon, ob der Statistics Collector in der Anfrage/Antwort bereits ausgeführt wurde.

Weitere Informationen finden sich unter Fehlerbehandlung.

Elementverweis

Die Elementreferenz beschreibt die Elemente und Attribute der Statistics Collector -Richtlinie.

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

Attribute von <StatisticsCollector>

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

In der folgenden Tabelle werden Attribute beschrieben, die für alle übergeordneten Richtlinienelemente gelten:

<DisplayName>-Element

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.

<DisplayName>Policy Display Name</DisplayName>

Elemente <Statistics>/<Statistic>

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

Fehlerreferenz

In diesem Abschnitt werden die Fehlermeldungen und Ablaufvariablen beschrieben, die festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Dieses Informationen sind wichtig, wenn Sie Fehlerregeln für einen Proxy entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

–

Bereitstellungsfehler

Fehlervariablen

Keine.

Schema

Jeder Richtlinientyp wird durch ein XML-Schema (.xsd) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.

Weitere Informationen

Weitere Informationen finden Sie unter:

• API-Nachrichteninhalte mithilfe benutzerdefinierter Analysen auswerten
• Benutzerdefinierte Berichte verwalten
• Mess-APIs zum Messen der API-Programmleistung verwenden