Metrics - Get

Odwołanie

Usługa:: Application Insights

Wersja interfejsu API:: v1

Pobieranie danych metryk
Pobiera wartości metryk dla pojedynczej metryki

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

Z parametrami opcjonalnymi:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appId	path	True	string	Identyfikator aplikacji. Jest to identyfikator aplikacji z bloku Ustawienia dostępu do interfejsu API w witrynie Azure Portal.
metricId	path	True	MetricId	Identyfikator metryki. Jest to metryka standardowa sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.
aggregation	query		MetricsAggregation[]	Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, rozdziel je przecinkami. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.
filter	query		string	Wyrażenie używane do filtrowania wyników. Ta wartość powinna być prawidłowym wyrażeniem filtru OData, w którym klucze każdej klauzuli powinny mieć zastosowanie wymiarów dla metryki, którą pobierasz.
interval	query		string (duration)	Interwał czasu używany podczas pobierania wartości metryk. Jest to czas trwania ISO8601. Jeśli interwał zostanie pominięty, wartość metryki jest agregowana w całym przedziale czasu. W przypadku dostarczenia interwału serwer może dostosować interwał do bardziej odpowiedniego rozmiaru na podstawie przedziału czasu używanego dla zapytania. We wszystkich przypadkach rzeczywisty interwał używany dla zapytania jest uwzględniony w odpowiedzi.
orderby	query		string	Funkcja agregacji i kierunek sortowania segmentów według. Ta wartość jest prawidłowa tylko wtedy, gdy określono segment.
segment	query		MetricsSegment[]	Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty o więcej niż jeden wymiar naraz, rozdziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .
timespan	query		string	Przedział czasu pobierania wartości metryk. Jest to wartość okresu ISO8601. Jeśli przedział czasu zostanie pominięty, zostanie użyty domyślny zakres czasu `PT12H` ("ostatnie 12 godzin"). Rzeczywisty przedział czasu, którego dotyczy zapytanie, może zostać skorygowany przez serwer oparty na serwerze. We wszystkich przypadkach rzeczywisty przedział czasu używany dla zapytania jest uwzględniony w odpowiedzi.
top	query		integer (int32)	Liczba segmentów do zwrócenia. Ta wartość jest prawidłowa tylko wtedy, gdy określono segment.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	metricsResult	Odpowiedź pomyślna
Other Status Codes	errorResponse	Obiekt odpowiedzi o błędzie.

Zabezpieczenia

oauth2

Nawiązywanie połączenia z interfejsem API usługi Azure Application Insights

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
errorDetail	Szczegóły błędu.
errorInfo	Kod i komunikat o błędzie.
errorResponse	Szczegóły błędu.
MetricId	Identyfikator metryki. Jest to metryka standardowa sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.
MetricsAggregation	Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, rozdziel je przecinkami. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.
metricsResult	Wynik metryki.
metricsResultInfo	Dane wyników metryk.
MetricsSegment	Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty o więcej niż jeden wymiar naraz, rozdziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .
metricsSegmentInfo	Segment metryki

errorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalProperties	object
code	string	Kod błędu.
message	string	Czytelny dla człowieka komunikat o błędzie.
resources	string[]	Wskazuje zasoby, które były odpowiedzialne za błąd.
target	string	Wskazuje, która właściwość w żądaniu jest odpowiedzialna za błąd.
value	string	Wskazuje, która wartość w elemecie docelowym jest odpowiedzialna za błąd.

errorInfo

Objekt

Kod i komunikat o błędzie.

Nazwa	Typ	Opis
additionalProperties	object
code	string	Kod błędu z możliwością odczytu maszyny.
details	errorDetail[]	szczegóły błędu.
innererror	errorInfo	Kod i komunikat o błędzie. Szczegóły błędu wewnętrznego, jeśli istnieją.
message	string	Czytelny dla człowieka komunikat o błędzie.

errorResponse

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
error	errorInfo	Kod i komunikat o błędzie. Szczegóły błędu.

MetricId

Wyliczanie

Identyfikator metryki. Jest to metryka standardowa sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.

Wartość	Opis
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

Wyliczanie

Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, rozdziel je przecinkami. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.

Wartość	Opis
avg
count
max
min
sum
unique

metricsResult

Objekt

Wynik metryki.

Nazwa	Typ	Opis
value	metricsResultInfo	Dane wyników metryk.

metricsResultInfo

Objekt

Dane wyników metryk.

Nazwa	Typ	Opis
end	string (date_time)	Godzina rozpoczęcia metryki.
interval	string (duration)	Interwał używany do segmentowania danych metryk.
segments	metricsSegmentInfo[]	Segmentowane dane metryk (jeśli są podzielone na segmenty).
start	string (date_time)	Godzina rozpoczęcia metryki.

MetricsSegment

Wyliczanie

Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty o więcej niż jeden wymiar naraz, rozdziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .

Wartość	Opis
applicationBuild
applicationVersion
authenticatedOrAnonymousTraffic
browser
browserVersion
city
cloudRoleName
cloudServiceName
continent
countryOrRegion
deploymentId
deploymentUnit
deviceType
environment
hostingLocation
instanceName

metricsSegmentInfo

Objekt

Segment metryki

Nazwa	Typ	Opis
end	string (date_time)	Godzina rozpoczęcia segmentu metryki (tylko wtedy, gdy określono interwał).
segments	metricsSegmentInfo[]	Segmentowane dane metryk (jeśli są dalej segmentowane).
start	string (date_time)	Godzina rozpoczęcia segmentu metryki (tylko wtedy, gdy określono interwał).

Udostępnij za pośrednictwem

Metrics - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

intervaledMetric

Przykładowe żądanie

Przykładowa odpowiedź

segmentedIntervaledMetric

Przykładowe żądanie

Przykładowa odpowiedź

simpleMetric

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

Dodatkowe zasoby