Kebijakan StatisticsCollector

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Apa

Memungkinkan Anda mengumpulkan statistik untuk data dalam pesan, seperti ID produk, harga, tindakan REST, URL klien dan target, serta panjang pesan. Data dapat berasal dari variabel alur yang telah ditentukan sebelumnya oleh Apigee atau variabel kustom yang Anda tentukan.

Data statistik diteruskan ke server analisis, yang menganalisis statistik dan membuat laporan. Anda dapat melihat laporan menggunakan UI pengelolaan Edge atau Edge API.

Contoh

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

Tentang kebijakan Pengumpul Statistik

Saat dijalankan, kebijakan Pengumpul Statistik mencatat nilai saat ini dari satu atau lebih variabel. Variabel ini dapat berupa variabel alur yang telah ditentukan sebelumnya oleh Apigee atau variabel kustom yang Anda tentukan. Data ini ditulis ke server analisis Edge.

Untuk mengakses data statistik yang dikumpulkan oleh kebijakan, Anda menggunakan Edge API atau UI pengelolaan Edge. Misalnya, Anda dapat menggunakan UI pengelolaan Edge untuk membuat laporan kustom yang menampilkan data yang dikumpulkan dalam berbagai format.

Untuk tutorial lengkap menggunakan kebijakan Pengumpul Statistik, lihat Menganalisis konten pesan API menggunakan analisis kustom.

Tempat untuk menempatkan kebijakan

Anda dapat menempatkan kebijakan Pengumpul Statistik dalam alur permintaan atau respons proxy API. Namun, jika Anda menempatkan beberapa kebijakan Pengumpul Statistik dalam proxy, kebijakan terakhir yang dijalankan akan menentukan data yang ditulis ke server analisis dan data yang ditulis oleh kebijakan Pengumpul Statistik sebelumnya akan hilang.

Salah satu skenario saat Anda mungkin memiliki beberapa kebijakan Pengumpul Statistik dalam proxy API adalah saat Anda memiliki satu di alur permintaan atau respons, dan satu lagi di pengendali error. Jika terjadi error di proxy API, Pengumpul Statistik di pengendali error akan menentukan data yang dikumpulkan. Anda dapat menggunakan Pengumpul Statistik tersebut untuk mencatat informasi tentang error, atau untuk mencatat informasi lain yang menurut Anda diperlukan. Pengumpul Statistik di pengendali error menentukan data yang dikumpulkan, terlepas dari apakah Pengumpul Statistik dalam permintaan/respons sudah dieksekusi atau belum.

Untuk mengetahui informasi selengkapnya, lihat Menangani error.

Referensi elemen

Referensi elemen menjelaskan elemen dan atribut kebijakan Pengumpul Statistik.

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

Atribut <StatisticsCollector>

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

Tabel berikut menjelaskan atribut yang umum untuk semua elemen induk kebijakan:

&lt;DisplayName&gt; elemen

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI dengan nama natural language yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

Elemen <Statistics>/<Statistic>

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

Referensi error

Bagian ini menjelaskan pesan error dan variabel alur yang ditetapkan saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk proxy. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Tidak ada.

Error saat deployment

Variabel error

Tidak ada.

Skema

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Sebagai referensi, skema kebijakan tersedia di GitHub.

Topik terkait

Untuk informasi selengkapnya, lihat:

• Menganalisis konten pesan API menggunakan analisis kustom
• Mengelola laporan kustom
• Menggunakan API metrik untuk mengukur performa program API