Melihat log menggunakan API

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

Download log Monitoring API untuk melihat data mentah yang digunakan untuk menghitung metrik yang ditampilkan di dasbor Monitoring API. Anda dapat mendownload log untuk rentang waktu kustom, proxy tertentu, kode status tertentu, dan untuk banyak variabel lainnya.

Catatan: Secara default, panggilan ke Logs API hanya menampilkan hasil dengan kode status 4xx dan 5xx, tetapi tidak dengan kode 2xx. Hal ini dilakukan untuk membatasi jumlah hasil, karena sebagian besar hasil memiliki kode status 2xx. Untuk mendapatkan hasil dengan kode status 2xx, tambahkan status=2xx ke permintaan. Misalnya: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

Bagian berikut menjelaskan cara mengelola log menggunakan API:

Lihat Logs API untuk mengetahui informasi selengkapnya tentang logs API.

Untuk informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Mendownload log untuk organisasi dan lingkungan

Download log untuk organisasi dan lingkungan tertentu menggunakan Logs API:

https://apimonitoring.enterprise.apigee.com/logs

Anda harus meneruskan nama organisasi dan lingkungan menggunakan parameter kueri org dan env.

Secara default, API menampilkan 10 entri log terbaru selama satu jam sebelumnya. Contoh:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.

Responsnya adalah array entri log dalam bentuk:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Gunakan parameter kueri from dan to untuk menentukan rentang waktu berformat ISO. Format tanggal dapat berupa:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Contoh:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

API ini memiliki banyak parameter kueri opsional. Misalnya, untuk melihat log proxy bernama myAPI yang menghasilkan respons HTTP 404:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Untuk menampilkan lebih dari 10 entri log, tetapkan parameter kueri limit. Anda dapat menetapkannya ke nilai maksimum 1.000:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Untuk opsi tambahan, lihat Logs API.

Mencantumkan proxy yang terkait dengan host virtual dan jalur dasar

Host virtual di Edge Router memungkinkan Anda menentukan nama domain, protokol seperti HTTP/HTTPS, dan nomor port. Misalnya, Anda menentukan host virtual di Edge Router dengan setelan berikut:

  • host alias = apis.acme.com
  • port = 443
  • TLS diaktifkan

Berdasarkan setelan ini, permintaan ke proxy API yang terkait dengan host virtual ini menggunakan formulir:

https://apis.acme.com/proxy-base-path/resource-path

Dengan keterangan:

  • proxy-base-path ditentukan saat Anda membuat proxy API dan bersifat unik untuk setiap proxy API.
  • resource-path adalah jalur ke resource yang dapat diakses melalui proxy API.

Untuk mengetahui informasi selengkapnya tentang host virtual, lihat Tentang host virtual.

Download daftar proxy API yang terkait dengan host virtual dan jalur dasar tertentu dengan mengeluarkan permintaan GET ke resource Logs API berikut:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Anda harus meneruskan nama organisasi dan lingkungan menggunakan parameter kueri org dan env serta URI yang terkait dengan host virtual dan jalur dasar.

Misalnya, panggilan API berikut menampilkan proxy yang terkait dengan host virtual http://apis.acme.com dan dengan jalur dasar /v1/perf:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.

Untuk opsi tambahan, lihat Logs API.