Metrics - Get

Referencia

Szolgáltatás:: Application Insights

API-verzió:: v1

Metrikaadatok lekérése
Egyetlen metrika metrikaértékeinek beolvasása

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 a Azure Portal API Access-beállítások paneljén található alkalmazásazonosító.
metricId	path	True	MetricId	A metrika azonosítója. Ez vagy egy standard 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, vesszővel válassza el őket. 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ó metrika számára.
interval	query		string duration	A metrikaértékek lekéréséhez használandó időintervallum. Ez egy ISO8601 időtartam. Ha az intervallum nincs megadva, a metrikaérték a teljes időtartományban összesítve lesz. Ha az időköz 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	A szegmensek rendezéséhez az aggregációs függvény és irány. 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 lekért metrikára. Ha egyszerre több dimenzió szerint szeretne szegmentálva lennie, vesszővel (,) válassza el őket. Ebben az esetben a metrikaadatok abban a sorrendben lesznek szegmentáltak, amelyben a dimenziók szerepelnek a paraméterben.
timespan	query		string	A metrikaértékek lekérésének időtartománya. Ez egy ISO8601 időszak értéke. Ha az időtartomány nincs megadva, a rendszer az alapértelmezett időtartományt `PT12H` ("az elmúlt 12 óra") használja. A lekérdezett tényleges időtartományt a kiszolgáló alapján módosíthatja. A válasz minden esetben tartalmazza a lekérdezéshez használt tényleges időtartományt.
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	Egy hibaválasz-objektum.

Biztonság

oauth2

Csatlakozás a Azure-alkalmazás 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	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 standard 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, vesszővel válassza el őket. Ha nincs megadva összesítés, akkor a rendszer a metrika alapértelmezett összesítését használja.
metricsResult	Egy metrika eredménye.
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 lekért metrikára. Ha egyszerre több dimenzió szerint szeretne szegmentálva lennie, vesszővel (,) válassza el őket. Ebben az esetben a metrikaadatok abban a sorrendben lesznek szegmentáltak, amelyben a dimenziók szerepelnek a paraméterben.
metricsSegmentInfo	Metrikaszegmens

errorDetail

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 "target" melyik értéke felelős a hibáért.

errorInfo

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

Hiba részletei.

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

MetricId

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

Name	Típus	Description
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

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

Name	Típus	Description
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

Egy metrika eredménye.

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

metricsResultInfo

Metrikaeredmény-adatok.

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

MetricsSegment

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

Name	Típus	Description
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

Metrikaszegmens

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

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