Metrics - Get

Referencia

Szolgáltatás:: Application Insights

API-verzió:: v1

Metrikaadatok lekérése
Egyetlen metrika metrikaértékeinek lekérdezője

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
appId	path	True	string	Az alkalmazás azonosítója. Ez az Azure Portal API Access-beállítások paneljének alkalmazásazonosítója.
metricId	path	True	MetricId	A metrika azonosítója. Ez vagy egy szabványos AI-metrika, vagy egy alkalmazásspecifikus egyéni metrika.
aggregation	query		MetricsAggregation[]	A metrikaértékek kiszámításához használandó összesítés. Ha egyszerre több összesítést szeretne lekérni, különítse el őket vesszővel. Ha nincs megadva összesítés, akkor a rendszer a metrika alapértelmezett összesítését használja.
filter	query		string	Az eredmények szűrésére használt kifejezés. Ennek az értéknek érvényes OData-szűrőkifejezésnek kell lennie, ahol az egyes záradékok kulcsainak alkalmazható dimenzióknak kell lenniük a beolvasandó metrikához.
interval	query		string (duration)	A metrikaértékek beolvasásához használandó időintervallum. Ez ISO8601 időtartam. Ha az intervallum nincs megadva, a metrika értéke a teljes időtartományban összesítve lesz. Ha az intervallum meg van adva, a kiszolgáló a lekérdezéshez használt időtartomány alapján a megfelelő méretre módosíthatja az időközt. A válasz minden esetben tartalmazza a lekérdezéshez használt tényleges időközt.
orderby	query		string	Az aggregációs függvény és a szegmensek rendezésének iránya. Ez az érték csak szegmens megadásakor érvényes.
segment	query		MetricsSegment[]	A metrikaértékek szegmentálásához használt dimenzió neve. Ennek a dimenziónak alkalmazhatónak kell lennie a beolvasandó metrikára. Ha egyszerre több dimenzió szerint szeretne szegmentálva lennie, válassza el őket vesszővel (,). Ebben az esetben a metrikaadatok a dimenziók paraméterben való felsorolásának sorrendjében lesznek szegmentáltak.
timespan	query		string	A metrikaértékek lekérésének időideje. Ez egy ISO8601 időszak értéke. Ha az időtartomány nincs megadva, a rendszer a `PT12H` (utolsó 12 óra) alapértelmezett időtartományát használja. A lekérdezett tényleges időbélyeget a kiszolgáló módosíthatja. A válasz minden esetben tartalmazza a lekérdezéshez használt tényleges időtartamot.
top	query		integer (int32)	A visszaadandó szegmensek száma. Ez az érték csak szegmens megadásakor érvényes.

Válaszok

Name	Típus	Description
200 OK	metricsResult	Sikeres válasz
Other Status Codes	errorResponse	Hibaválasz-objektum.

Biztonság

oauth2

Csatlakozás az Azure Application Insights API-hoz

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
errorDetail	Hiba részletei.
errorInfo	A hiba kódja és üzenete.
errorResponse	Hiba részletei.
MetricId	A metrika azonosítója. Ez vagy egy szabványos AI-metrika, vagy egy alkalmazásspecifikus egyéni metrika.
MetricsAggregation	A metrikaértékek kiszámításához használandó összesítés. Ha egyszerre több összesítést szeretne lekérni, különítse el őket vesszővel. Ha nincs megadva összesítés, akkor a rendszer a metrika alapértelmezett összesítését használja.
metricsResult	Metrikaeredmény.
metricsResultInfo	Metrikaeredmény-adatok.
MetricsSegment	A metrikaértékek szegmentálásához használt dimenzió neve. Ennek a dimenziónak alkalmazhatónak kell lennie a beolvasandó metrikára. Ha egyszerre több dimenzió szerint szeretne szegmentálva lennie, válassza el őket vesszővel (,). Ebben az esetben a metrikaadatok a dimenziók paraméterben való felsorolásának sorrendjében lesznek szegmentáltak.
metricsSegmentInfo	Metrikaszegmens

errorDetail

Objektum

Hiba részletei.

Name	Típus	Description
additionalProperties	object
code	string	A hiba kódja.
message	string	Emberi olvasásra alkalmas hibaüzenet.
resources	string[]	A hibáért felelős erőforrásokat jelzi.
target	string	Azt jelzi, hogy a kérelem melyik tulajdonsága felelős a hibáért.
value	string	Azt jelzi, hogy a "cél" melyik értéke felelős a hibáért.

errorInfo

Objektum

A hiba kódja és üzenete.

Name	Típus	Description
additionalProperties	object
code	string	Géppel olvasható hibakód.
details	errorDetail[]	hiba részletei.
innererror	errorInfo	A hiba kódja és üzenete. Belső hiba részletei, ha léteznek.
message	string	Emberi olvasásra alkalmas hibaüzenet.

errorResponse

Objektum

Hiba részletei.

Name	Típus	Description
error	errorInfo	A hiba kódja és üzenete. A hiba részletei.

MetricId

Enumerálás

A metrika azonosítója. Ez vagy egy szabványos AI-metrika, vagy egy alkalmazásspecifikus egyéni metrika.

Érték	Description
availabilityResults/availabilityPercentage
availabilityResults/duration
billing/telemetryCount
client/networkDuration
client/processingDuration
client/receiveDuration
client/sendDuration
client/totalDuration
customEvents/count
dependencies/count
dependencies/duration
dependencies/failed
exceptions/browser
exceptions/count
exceptions/server
pageViews/count
pageViews/duration
performanceCounters/exceptionsPerSecond
performanceCounters/memoryAvailableBytes
performanceCounters/processCpuPercentage
performanceCounters/processIOBytesPerSecond
performanceCounters/processPrivateBytes
performanceCounters/processorCpuPercentage
performanceCounters/requestExecutionTime
performanceCounters/requestsInQueue
performanceCounters/requestsPerSecond
requests/count
requests/duration
requests/failed
sessions/count
users/authenticated
users/count

MetricsAggregation

Enumerálás

A metrikaértékek kiszámításához használandó összesítés. Ha egyszerre több összesítést szeretne lekérni, különítse el őket vesszővel. Ha nincs megadva összesítés, akkor a rendszer a metrika alapértelmezett összesítését használja.

Érték	Description
avg
count
max
min
sum
unique

metricsResult

Objektum

Metrikaeredmény.

Name	Típus	Description
value	metricsResultInfo	Metrikaeredmény-adatok.

metricsResultInfo

Objektum

Metrikaeredmény-adatok.

Name	Típus	Description
end	string (date_time)	A metrika kezdő időpontja.
interval	string (duration)	A metrikaadatok szegmentálásához használt időköz.
segments	metricsSegmentInfo[]	Szegmentált metrikaadatok (ha szegmentáltak).
start	string (date_time)	A metrika kezdő időpontja.

MetricsSegment

Enumerálás

A metrikaértékek szegmentálásához használt dimenzió neve. Ennek a dimenziónak alkalmazhatónak kell lennie a beolvasandó metrikára. Ha egyszerre több dimenzió szerint szeretne szegmentálva lennie, válassza el őket vesszővel (,). Ebben az esetben a metrikaadatok a dimenziók paraméterben való felsorolásának sorrendjében lesznek szegmentáltak.

Érték	Description
applicationBuild
applicationVersion
authenticatedOrAnonymousTraffic
browser
browserVersion
city
cloudRoleName
cloudServiceName
continent
countryOrRegion
deploymentId
deploymentUnit
deviceType
environment
hostingLocation
instanceName

metricsSegmentInfo

Objektum

Metrikaszegmens

Name	Típus	Description
end	string (date_time)	A metrikaszegmens kezdési időpontja (csak akkor, ha egy intervallum meg lett adva).
segments	metricsSegmentInfo[]	Szegmentált metrikaadatok (ha további szegmentáltak).
start	string (date_time)	A metrikaszegmens kezdési időpontja (csak akkor, ha egy intervallum meg lett adva).

Megosztás a következőn keresztül:

Metrics - Get

URI-paraméterek

Válaszok

Biztonság

oauth2

Hatókörök

Példák

intervaledMetric

Mintakérelem

Mintaválasz

segmentedIntervaledMetric

Mintakérelem

Mintaválasz

simpleMetric

Mintakérelem

Mintaválasz

Definíciók

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

További források