Metrics - Get

Reference

Služba:: Application Insights

Verze rozhraní API:: v1

Načtení dat metriky
Získá hodnoty metriky pro jednu metriku.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
appId	path	True	string	ID aplikace. Toto je ID aplikace z okna Nastavení přístupu rozhraní API na webu Azure Portal.
metricId	path	True	MetricId	ID metriky. Jedná se o standardní metriku AI nebo vlastní metriku specifickou pro aplikaci.
aggregation	query		MetricsAggregation[]	Agregace, která se má použít při výpočtu hodnot metriky. Pokud chcete načíst více než jednu agregaci najednou, oddělte je čárkou. Pokud není zadána žádná agregace, použije se výchozí agregace metriky.
filter	query		string	Výraz použitý k filtrování výsledků. Tato hodnota by měla být platným výrazem filtru OData, kde klíče každé klauzule by měly být platné dimenze pro metriku, kterou načítáte.
interval	query		string (duration)	Časový interval, který se má použít při načítání hodnot metriky. Jedná se o ISO8601 dobu trvání. Pokud je interval vynechán, hodnota metriky se agreguje napříč celým časovým intervalem. Pokud je zadán interval, server může upravit interval na vhodnější velikost na základě časového rozsahu použitého pro dotaz. Ve všech případech se do odpovědi zahrne skutečný interval použitý pro dotaz.
orderby	query		string	Agregační funkce a směr řazení segmentů podle. Tato hodnota je platná pouze v případě, že je zadaný segment.
segment	query		MetricsSegment[]	Název dimenze, podle které chcete segmentovat hodnoty metriky. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více než jednou dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru.
timespan	query		string	Časový rozsah, ve kterém se mají načítat hodnoty metrik. Toto je hodnota ISO8601 časového období. Pokud časový rozsah vynecháte, použije se výchozí časový rozsah `PT12H` (posledních 12 hodin). Skutečný časový rozsah, na který se dotazuje, může být upraven serverem. Ve všechpřípadechch
top	query		integer (int32)	Počet segmentů, které se mají vrátit. Tato hodnota je platná pouze v případě, že je zadaný segment.

Odpovědi

Name	Typ	Description
200 OK	metricsResult	Úspěšná odpověď
Other Status Codes	errorResponse	Objekt odpovědi na chybu.

Zabezpečení

oauth2

Připojení k rozhraní API služby Azure Application Insights

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
errorDetail	Podrobnosti o chybě
errorInfo	Kód a zpráva chyby.
errorResponse	Podrobnosti o chybě
MetricId	ID metriky. Jedná se o standardní metriku AI nebo vlastní metriku specifickou pro aplikaci.
MetricsAggregation	Agregace, která se má použít při výpočtu hodnot metriky. Pokud chcete načíst více než jednu agregaci najednou, oddělte je čárkou. Pokud není zadána žádná agregace, použije se výchozí agregace metriky.
metricsResult	Výsledek metriky.
metricsResultInfo	Data výsledku metriky.
MetricsSegment	Název dimenze, podle které chcete segmentovat hodnoty metriky. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více než jednou dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru.
metricsSegmentInfo	Segment metriky

errorDetail

Objekt

Podrobnosti o chybě

Name	Typ	Description
additionalProperties	object
code	string	Kód chyby.
message	string	Chybová zpráva čitelná pro člověka
resources	string[]	Označuje prostředky, které byly zodpovědné za chybu.
target	string	Určuje, která vlastnost v požadavku je zodpovědná za chybu.
value	string	Určuje, která hodnota v cíli odpovídá za chybu.

errorInfo

Objekt

Kód a zpráva chyby.

Name	Typ	Description
additionalProperties	object
code	string	Stroj čitelný kód chyby.
details	errorDetail[]	podrobnosti o chybě.
innererror	errorInfo	Kód a zpráva chyby. Vnitřní podrobnosti o chybě, pokud existují.
message	string	Chybová zpráva čitelná pro člověka

errorResponse

Objekt

Podrobnosti o chybě

Name	Typ	Description
error	errorInfo	Kód a zpráva chyby. Podrobnosti o chybě.

MetricId

Výčet

ID metriky. Jedná se o standardní metriku AI nebo vlastní metriku specifickou pro aplikaci.

Hodnota	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

Výčet

Agregace, která se má použít při výpočtu hodnot metriky. Pokud chcete načíst více než jednu agregaci najednou, oddělte je čárkou. Pokud není zadána žádná agregace, použije se výchozí agregace metriky.

Hodnota	Description
avg
count
max
min
sum
unique

metricsResult

Objekt

Výsledek metriky.

Name	Typ	Description
value	metricsResultInfo	Data výsledku metriky.

metricsResultInfo

Objekt

Data výsledku metriky.

Name	Typ	Description
end	string (date_time)	Počáteční čas metriky
interval	string (duration)	Interval použitý k segmentování dat metriky.
segments	metricsSegmentInfo[]	Segmentovaná data metrik (pokud jsou segmentovaná).
start	string (date_time)	Počáteční čas metriky

MetricsSegment

Výčet

Název dimenze, podle které chcete segmentovat hodnoty metriky. Tato dimenze musí být použitelná pro metriku, kterou načítáte. Pokud chcete segmentovat více než jednou dimenzí najednou, oddělte je čárkou (,). V tomto případě budou data metriky segmentována v pořadí, v jakém jsou dimenze uvedeny v parametru.

Hodnota	Description
applicationBuild
applicationVersion
authenticatedOrAnonymousTraffic
browser
browserVersion
city
cloudRoleName
cloudServiceName
continent
countryOrRegion
deploymentId
deploymentUnit
deviceType
environment
hostingLocation
instanceName

metricsSegmentInfo

Objekt

Segment metriky

Name	Typ	Description
end	string (date_time)	Počáteční čas segmentu metriky (pouze v okamžiku, kdy byl zadán interval).
segments	metricsSegmentInfo[]	Segmentovaná data metrik (pokud jsou dále segmentovaná).
start	string (date_time)	Počáteční čas segmentu metriky (pouze v okamžiku, kdy byl zadán interval).

Sdílet prostřednictvím

Metrics - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

intervaledMetric

Ukázkový požadavek

Ukázková odpověď

segmentedIntervaledMetric

Ukázkový požadavek

Ukázková odpověď

simpleMetric

Ukázkový požadavek

Ukázková odpověď

Definice

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Další materiály