Norme di Statisticscollector

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X.
Informazioni

Cosa

Consente di raccogliere le statistiche relative ai dati di un messaggio, ad esempio ID prodotto, prezzo, REST l'azione, l'URL del client e di destinazione e la lunghezza del messaggio. I dati possono provenire da variabili di flusso predefinite da Apigee o variabili personalizzate da te definite.

I dati statistici vengono trasmessi al server di analisi, che li analizza e genera report. Puoi visualizzare i report utilizzando l'interfaccia utente di gestione perimetrale o l'API Edge.

Esempi

Esempio di base

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

In questo esempio, vengono raccolte informazioni statistiche su due variabili personalizzate: product.id e product.price. A ogni richiesta, Il criterio del raccoglitore delle statistiche scrive il valore di queste due variabili nell'analisi o server web.

Questo esempio imposta anche un valore predefinito facoltativo per ogni variabile, dove il valore predefinito Il valore di product.id è 999999 e il valore predefinito di product.price è 0. Se una variabile non è definita e non specifichi un valore predefinito, nessun dato sarà registrati per la variabile. Se specifichi un valore predefinito, questo è vengono registrate quando la variabile non è definita.

Dopo aver raccolto i dati statistici, puoi utilizzare l'interfaccia utente o l'API di gestione perimetrale per recuperare le statistiche. Quando recuperi le statistiche, fai riferimento ai dati raccolti queste variabili come productID e price, rispettivamente.

Accesso alle statistiche

In questo esempio viene utilizzata l'API di gestione Edge per visualizzare i dati statistici per raccolta chiamata productID. Questa richiesta crea un report personalizzato per ID prodotto basati sulla somma dei conteggi dei messaggi inviati per ciascun ID prodotto per ogni giorno. Sostituisci il nome della tua organizzazione con la variabile {org_name} e sostituire l'indirizzo email e la password del tuo account su Apigee Edge email:password.

Imposta il parametro timeRange per includere l'intervallo di tempo in cui i dati sono stati raccolte. I dati più vecchi di sei mesi dalla data corrente non sono accessibili per impostazione predefinita. Se Se vuoi accedere a dati più vecchi di sei mesi, contatta l'assistenza 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

Nella risposta, il campo name contiene l'ID prodotto e il valore indica il numero di richieste per ogni giorno:

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

Estrazione dei dati per la raccolta

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

Il criterio del raccoglitore delle statistiche richiede che i dati raccolti siano archiviati in variabili. Queste variabili possono essere predefinite da Apigee oppure variabili personalizzate da te definite.

In questo esempio, viene utilizzato il criterio Estrai variabili per estrarre i dati da un payload XML. contenenti informazioni meteo. Queste norme:

  • Estrae il nome della città e lo scrive in una variabile denominata weather.location
  • Estrae le condizioni attuali e le scrive in una variabile denominata weather.condition

In seguito, potrai utilizzare il criterio Raccoglitore delle statistiche per raccogliere informazioni sulla come mostrato di seguito:

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

Per un tutorial completo che mostra come estrarre i dati da un payload XML per il Criterio di raccolta delle statistiche; consulta API Analyze dei messaggi utilizzando le analisi personalizzate.


Informazioni sul criterio di raccolta delle statistiche

Se eseguito, il criterio Raccoglitore delle statistiche registra il valore corrente di uno o più come la codifica one-hot delle variabili categoriche. Queste possono essere variabili di flusso predefinite da Apigee o variabili personalizzate che definisci. Questi dati vengono scritti nel server di analisi Edge.

Per accedere ai dati statistici raccolti dal criterio, puoi usare l'API Edge o Edge un'interfaccia utente di gestione. Ad esempio, puoi utilizzare l'interfaccia utente di gestione perimetrale per creare un report personalizzato mostra i dati raccolti in vari formati.

Per un tutorial completo sull'utilizzo del criterio Statistics Collector, vedi Analyze API dei messaggi utilizzando le analisi personalizzate.

Dove inserire il criterio

Puoi inserire un criterio del raccoglitore delle statistiche nel flusso di richiesta o risposta di un'API proxy. Tuttavia, se inserisci più criteri del raccoglitore delle statistiche in un proxy, l'ultimo criterio uno da eseguire determina i dati scritti al server di analisi e quelli scritti da I criteri precedenti della raccolta delle statistiche sono andati persi.

Uno scenario in cui potrebbero essere presenti più criteri del raccoglitore delle statistiche in un proxy API è quando ne hai uno nel flusso di richiesta o risposta e un altro in un gestore degli errori. Se si verifica un errore si verifica nel proxy API, il raccoglitore delle statistiche nel gestore degli errori determina i dati raccolte. L'utente può utilizzare il raccoglitore delle statistiche per registrare informazioni sul guasto o per registrare qualsiasi altra informazione che ritieni necessaria. Il raccoglitore delle statistiche è in errore determina i dati raccolti a prescindere dal fatto che l'elemento Statistics Collector nella richiesta/risposta già eseguita.

Per ulteriori informazioni, vedi Gestione di errore.

Riferimento elemento

Il riferimento agli elementi descrive gli elementi e gli attributi del raccoglitore delle statistiche .

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

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

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails.

false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

true Optional
async

This attribute is deprecated.

false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.

Presence Optional
Type String

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

<Statistics>
    <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
</Statistics>
Attributo Descrizione Predefinito Presenza
nome

Il nome utilizzato per fare riferimento ai dati raccolti per la variabile specificata. Durante la visualizzazione Analytics, utilizza questo nome per fare riferimento ai dati raccolti sulla variabile specificato dal ref .

Se la variabile specificata da ref non è definita in una richiesta o risposta, defaultStatValue specifica il valore raccolti per la variabile. Se ometti il valore predefinito, non vengono raccolti dati per il valore se la variabile non è definita.

Limitazioni di denominazione

Alle variabili di Analytics personalizzate si applicano le seguenti limitazioni di denominazione:

N/D Obbligatorio
riferimento

La variabile di flusso per la quale vengono raccolte le statistiche. Questa variabile può essere un flusso variabile predefinita da Apigee o da una variabile personalizzata definita nel proxy API.

L'attributo ref spesso fa riferimento a una variabile personalizzata definita dalla funzione Estrai variabili . Vedi Estrarre variabili per saperne di più.

N/D Obbligatorio
tipo

Specifica il tipo di dati della variabile specificata dall'attributo ref. I valori validi sono: string/integer/float/long/double/boolean.

Per i dati di tipo stringa, fai riferimento ai dati statistici come Dimensione in un report personalizzato. Per i tipi di dati numerici (intero/float/long/doppio), fai riferimento al valore Dati statistici in un report personalizzato come Dimensione o Metrica. Per saperne di più, consulta Gestire i report personalizzati.

Il valore di type può essere omesso solo se ref fa riferimento a una La variabile di flusso Apigee o il tipo viene dichiarato nel payload XML della funzionalità .

stringa Facoltativo

Messaggi di errore

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.

Schema

Ogni tipo di criterio è definito da uno schema XML (.xsd). Come riferimento, consulta gli schemi dei criteri sono disponibili su GitHub.

Argomenti correlati

Per ulteriori informazioni, vedi: