Bagikan melalui


Metrics - Get

Mengambil data metrik
Mendapatkan nilai metrik untuk satu metrik

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}
GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}?timespan={timespan}&interval={interval}&aggregation={aggregation}&segment={segment}&top={top}&orderby={orderby}&filter={filter}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
appId
path True

string

ID aplikasi. Ini adalah ID Aplikasi dari bilah pengaturan Akses API di portal Azure.

metricId
path True

MetricId

ID metrik. Ini adalah metrik AI standar, atau metrik kustom khusus aplikasi.

aggregation
query

MetricsAggregation[]

Agregasi yang digunakan saat menghitung nilai metrik. Untuk mengambil lebih dari satu agregasi pada satu waktu, pisahkan dengan koma. Jika tidak ada agregasi yang ditentukan, maka agregasi default untuk metrik akan digunakan.

filter
query

string

Ekspresi yang digunakan untuk memfilter hasil. Nilai ini harus menjadi ekspresi filter OData yang valid di mana kunci setiap klausul harus berupa dimensi yang berlaku untuk metrik yang Anda ambil.

interval
query

string

duration

Interval waktu yang digunakan saat mengambil nilai metrik. Ini adalah durasi ISO8601. Jika interval dihilangkan, nilai metrik diagregasi di seluruh rentang waktu. Jika interval disediakan, server dapat menyesuaikan interval ke ukuran yang lebih tepat berdasarkan rentang waktu yang digunakan untuk kueri. Dalam semua kasus, interval aktual yang digunakan untuk kueri disertakan dalam respons.

orderby
query

string

Fungsi dan arah agregasi untuk mengurutkan segmen. Nilai ini hanya valid ketika segmen ditentukan.

segment
query

MetricsSegment[]

Nama dimensi untuk mengesegmentasi nilai metrik. Dimensi ini harus berlaku untuk metrik yang Anda ambil. Untuk mengesegmentasi lebih dari satu dimensi pada satu waktu, pisahkan dengan koma (,). Dalam hal ini, data metrik akan disegmentasi dalam urutan dimensi tercantum dalam parameter .

timespan
query

string

Rentang waktu untuk mengambil nilai metrik. Ini adalah nilai periode waktu ISO8601. Jika rentang waktu dihilangkan, rentang PT12H waktu default ("12 jam terakhir") digunakan. Jangka waktu aktual yang dikueri dapat disesuaikan oleh berbasis server. Dalam semua kasus, rentang waktu aktual yang digunakan untuk kueri disertakan dalam respons.

top
query

integer

int32

Jumlah segmen yang akan dikembalikan. Nilai ini hanya valid ketika segmen ditentukan.

Respons

Nama Jenis Deskripsi
200 OK

metricsResult

Respons berhasil

Other Status Codes

errorResponse

Objek respons kesalahan.

Keamanan

oauth2

Menyambungkan ke API Azure Application Insights

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

intervaledMetric
segmentedIntervaledMetric
simpleMetric

intervaledMetric

Permintaan sampel

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D

Respon sampel

{
  "value": {
    "start": "2018-02-04T10:01:35.086Z",
    "end": "2018-02-06T10:01:35.086Z",
    "interval": "P1D",
    "segments": [
      {
        "start": "2018-02-04T10:01:35.086Z",
        "end": "2018-02-05T00:00:00.000Z",
        "requests/count": {
          "sum": 4927
        }
      },
      {
        "start": "2018-02-05T00:00:00.000Z",
        "end": "2018-02-06T00:00:00.000Z",
        "requests/count": {
          "sum": 8460
        }
      },
      {
        "start": "2018-02-06T00:00:00.000Z",
        "end": "2018-02-06T10:01:35.086Z",
        "requests/count": {
          "sum": 3743
        }
      }
    ]
  }
}

segmentedIntervaledMetric

Permintaan sampel

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D&segment=operation/name,request/success

Respon sampel

{
  "value": {
    "start": "2018-10-22T10:40:09.065Z",
    "end": "2018-10-22T22:40:09.065Z",
    "segments": [
      {
        "operation/name": "GET Home/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 156483,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 3795,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /",
        "segments": [
          {
            "requests/count": null,
            "sum": 34168,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 12,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-light-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9378,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9370,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 1989,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 14,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1991,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1990,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/GetLogEntries",
        "segments": [
          {
            "requests/count": null,
            "sum": 1985,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 663,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 663,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Reports/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1086,
            "request/success": true
          }
        ]
      }
    ]
  }
}

simpleMetric

Permintaan sampel

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount

Respon sampel

{
  "value": {
    "start": "2016-01-01T02:00:00.000Z",
    "end": "2016-01-03T02:00:00.000Z",
    "requests/count": {
      "sum": 23
    }
  }
}

Definisi

Nama Deskripsi
errorDetail

Detail kesalahan.

errorInfo

Kode dan pesan untuk kesalahan.

errorResponse

Detail kesalahan.

MetricId

ID metrik. Ini adalah metrik AI standar, atau metrik kustom khusus aplikasi.

MetricsAggregation

Agregasi yang digunakan saat menghitung nilai metrik. Untuk mengambil lebih dari satu agregasi pada satu waktu, pisahkan dengan koma. Jika tidak ada agregasi yang ditentukan, maka agregasi default untuk metrik akan digunakan.

metricsResult

Hasil metrik.

metricsResultInfo

Data hasil metrik.

MetricsSegment

Nama dimensi untuk mengesegmentasi nilai metrik. Dimensi ini harus berlaku untuk metrik yang Anda ambil. Untuk mengesegmentasi lebih dari satu dimensi pada satu waktu, pisahkan dengan koma (,). Dalam hal ini, data metrik akan disegmentasi dalam urutan dimensi tercantum dalam parameter .

metricsSegmentInfo

Segmen metrik

errorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalProperties

object

code

string

Kode kesalahan.

message

string

Pesan kesalahan yang dapat dibaca manusia.

resources

string[]

Menunjukkan sumber daya yang bertanggung jawab atas kesalahan tersebut.

target

string

Menunjukkan properti mana dalam permintaan yang bertanggung jawab atas kesalahan tersebut.

value

string

Menunjukkan nilai mana dalam 'target' yang bertanggung jawab atas kesalahan tersebut.

errorInfo

Kode dan pesan untuk kesalahan.

Nama Jenis Deskripsi
additionalProperties

object

code

string

Kode kesalahan yang dapat dibaca mesin.

details

errorDetail[]

detail kesalahan.

innererror

errorInfo

Kode dan pesan untuk kesalahan.
Detail kesalahan dalam jika ada.

message

string

Pesan kesalahan yang dapat dibaca manusia.

errorResponse

Detail kesalahan.

Nama Jenis Deskripsi
error

errorInfo

Kode dan pesan untuk kesalahan.
Detail kesalahan.

MetricId

ID metrik. Ini adalah metrik AI standar, atau metrik kustom khusus aplikasi.

Nama Jenis Deskripsi
availabilityResults/availabilityPercentage

string

availabilityResults/duration

string

billing/telemetryCount

string

client/networkDuration

string

client/processingDuration

string

client/receiveDuration

string

client/sendDuration

string

client/totalDuration

string

customEvents/count

string

dependencies/count

string

dependencies/duration

string

dependencies/failed

string

exceptions/browser

string

exceptions/count

string

exceptions/server

string

pageViews/count

string

pageViews/duration

string

performanceCounters/exceptionsPerSecond

string

performanceCounters/memoryAvailableBytes

string

performanceCounters/processCpuPercentage

string

performanceCounters/processIOBytesPerSecond

string

performanceCounters/processPrivateBytes

string

performanceCounters/processorCpuPercentage

string

performanceCounters/requestExecutionTime

string

performanceCounters/requestsInQueue

string

performanceCounters/requestsPerSecond

string

requests/count

string

requests/duration

string

requests/failed

string

sessions/count

string

users/authenticated

string

users/count

string

MetricsAggregation

Agregasi yang digunakan saat menghitung nilai metrik. Untuk mengambil lebih dari satu agregasi pada satu waktu, pisahkan dengan koma. Jika tidak ada agregasi yang ditentukan, maka agregasi default untuk metrik akan digunakan.

Nama Jenis Deskripsi
avg

string

count

string

max

string

min

string

sum

string

unique

string

metricsResult

Hasil metrik.

Nama Jenis Deskripsi
value

metricsResultInfo

Data hasil metrik.

metricsResultInfo

Data hasil metrik.

Nama Jenis Deskripsi
end

string

Waktu mulai metrik.

interval

string

Interval yang digunakan untuk membagi data metrik.

segments

metricsSegmentInfo[]

Data metrik tersegmentasi (jika tersegmentasi).

start

string

Waktu mulai metrik.

MetricsSegment

Nama dimensi untuk mengesegmentasi nilai metrik. Dimensi ini harus berlaku untuk metrik yang Anda ambil. Untuk mengesegmentasi lebih dari satu dimensi pada satu waktu, pisahkan dengan koma (,). Dalam hal ini, data metrik akan disegmentasi dalam urutan dimensi tercantum dalam parameter .

Nama Jenis Deskripsi
applicationBuild

string

applicationVersion

string

authenticatedOrAnonymousTraffic

string

browser

string

browserVersion

string

city

string

cloudRoleName

string

cloudServiceName

string

continent

string

countryOrRegion

string

deploymentId

string

deploymentUnit

string

deviceType

string

environment

string

hostingLocation

string

instanceName

string

metricsSegmentInfo

Segmen metrik

Nama Jenis Deskripsi
end

string

Waktu mulai segmen metrik (hanya ketika interval ditentukan).

segments

metricsSegmentInfo[]

Data metrik tersegmentasi (jika disegmentasi lebih lanjut).

start

string

Waktu mulai segmen metrik (hanya ketika interval ditentukan).