Partilhar via

Metrics - Get

  • Referência
Serviço:
Application Insights
Versão da API:
v1

Recuperar dados métricos
Obtém valores de métrica para uma única métrica

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

Parâmetros do URI

Name Em Necessário Tipo Description
appId
 path True

string

ID do pedido. Esta é a ID do Aplicativo da folha Configurações de Acesso à API no portal do Azure.
metricId
 path True

MetricId

ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.
aggregation
 query

MetricsAggregation[]

A agregação a ser usada ao calcular os valores métricos. Para recuperar mais de uma agregação de cada vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.
filter
 query

string

Uma expressão usada para filtrar os resultados. Esse valor deve ser uma expressão de filtro OData válida, onde as chaves de cada cláusula devem ser dimensões aplicáveis para a métrica que você está recuperando.
interval
 query

string (duration)

O intervalo de tempo a ser usado ao recuperar valores métricos. Esta é uma duração ISO8601. Se o intervalo for omitido, o valor da métrica será agregado em todo o período de tempo. Se o intervalo for fornecido, o servidor poderá ajustá-lo para um tamanho mais apropriado com base no período de tempo usado para a consulta. Em todos os casos, o intervalo real usado para a consulta é incluído na resposta.
orderby
 query

string

A função de agregação e a direção para classificar os segmentos por. Esse valor só é válido quando o segmento é especificado.
segment
 query

MetricsSegment[]

O nome da dimensão pela qual segmentar os valores métricos. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados métricos serão segmentados na ordem em que as dimensões são listadas no parâmetro.
timespan
 query

string

O período de tempo durante o qual recuperar valores métricos. Este é um valor de período de tempo ISO8601. Se o intervalo de tempo for omitido, um intervalo de tempo padrão de PT12H ("últimas 12 horas") será usado. O período de tempo real que é consultado pode ser ajustado pelo servidor com base. Em todos os casos, o período de tempo real usado para a consulta é incluído na resposta.
top
 query

integer (int32)

O número de segmentos a retornar. Esse valor só é válido quando o segmento é especificado.

Respostas

Name Tipo Description
200 OK

metricsResult

Resposta bem-sucedida
Other Status Codes

errorResponse

Um objeto de resposta de erro.

Segurança

oauth2

Conectar-se à API do Azure Application Insights

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

intervaledMetric
segmentedIntervaledMetric
simpleMetric

intervaledMetric

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "value": {
    "start": "2016-01-01T02:00:00.000Z",
    "end": "2016-01-03T02:00:00.000Z",
    "requests/count": {
      "sum": 23
    }
  }
}

Definições

Name Description
errorDetail

Detalhes do erro.
errorInfo

O código e a mensagem para um erro.
errorResponse

Detalhes do erro.
MetricId

ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.
MetricsAggregation

A agregação a ser usada ao calcular os valores métricos. Para recuperar mais de uma agregação de cada vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.
metricsResult

Um resultado métrico.
metricsResultInfo

Um dado de resultado métrico.
MetricsSegment

O nome da dimensão pela qual segmentar os valores métricos. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados métricos serão segmentados na ordem em que as dimensões são listadas no parâmetro.
metricsSegmentInfo

Um segmento métrico

errorDetail

Object

Detalhes do erro.

Name Tipo Description
additionalProperties

object

code

string

O código do erro.
message

string

Uma mensagem de erro legível por humanos.
resources

string[]

Indica os recursos que foram responsáveis pelo erro.
target

string

Indica qual propriedade na solicitação é responsável pelo erro.
value

string

Indica qual valor em 'target' é responsável pelo erro.

errorInfo

Object

O código e a mensagem para um erro.

Name Tipo Description
additionalProperties

object

code

string

Um código de erro legível por máquina.
details

errorDetail[]

detalhes do erro.
innererror

errorInfo

O código e a mensagem para um erro.
Detalhes do erro interno, se existirem.
message

string

Uma mensagem de erro legível por humanos.

errorResponse

Object

Detalhes do erro.

Name Tipo Description
error

errorInfo

O código e a mensagem para um erro.
Os detalhes do erro.

MetricId

Enumeração

ID da métrica. Essa é uma métrica de IA padrão ou uma métrica personalizada específica do aplicativo.

Valor 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

Enumeração

A agregação a ser usada ao calcular os valores métricos. Para recuperar mais de uma agregação de cada vez, separe-as com uma vírgula. Se nenhuma agregação for especificada, a agregação padrão para a métrica será usada.

Valor Description
avg
count
max
min
sum
unique

metricsResult

Object

Um resultado métrico.

Name Tipo Description
value

metricsResultInfo

Um dado de resultado métrico.

metricsResultInfo

Object

Um dado de resultado métrico.

Name Tipo Description
end

string (date_time)

Hora de início da métrica.
interval

string (duration)

O intervalo usado para segmentar os dados métricos.
segments

metricsSegmentInfo[]

Dados métricos segmentados (se segmentados).
start

string (date_time)

Hora de início da métrica.

MetricsSegment

Enumeração

O nome da dimensão pela qual segmentar os valores métricos. Essa dimensão deve ser aplicável à métrica que você está recuperando. Para segmentar por mais de uma dimensão de cada vez, separe-as com uma vírgula (,). Neste caso, os dados métricos serão segmentados na ordem em que as dimensões são listadas no parâmetro.

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

metricsSegmentInfo

Object

Um segmento métrico

Name Tipo Description
end

string (date_time)

Hora de início do segmento métrico (apenas quando um intervalo foi especificado).
segments

metricsSegmentInfo[]

Dados métricos segmentados (se mais segmentados).
start

string (date_time)

Hora de início do segmento métrico (apenas quando um intervalo foi especificado).