Test Run - Get Test Run Client Metrics

Service:

Azure Load Testing

API Version:

2022-06-01-preview

Obtenha todas as métricas do cliente para uma execução de teste de carga.

POST https://{Endpoint}/testruns/{testRunId}/clientMetrics?api-version=2022-06-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string uri	URL para executar operações de API do plano de dados no recurso.
testRunId	path	True	string	O nome exclusivo da execução do teste de carga deve ser um caractere de URL válido ^[a-z0-9_-]*$. Regex pattern: ^[a-z0-9_-]*$
api-version	query	True	string	Versão da API

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
endTime	True	string	Hora de término
startTime	True	string	Hora de início
errors		string[]	Lista de erros, o máximo de erros com suporte para consultas é 20. No caso de vazio, por padrão, retornará métricas para o máximo de 20 erros
groupByInterval		string	Para a duração do teste menor que 10 minutos de grupo por intervalo de tempo pode ser qualquer um dos 5s,10s,1m,5m.\n\nPara duração do teste maior que 10 minutos, o intervalo de tempo agrupar por pode ser qualquer um de 1m,5m,1h. O valor padrão é 1m.
percentiles		string[]	Lista de valores de percentis para o tempo de resposta, valores com suporte 50,90,99,95. O valor padrão é o 50º percentil.
requestSamplers		string[]	Lista de exemplos de solicitação, o máximo de exemplos com suporte para consultas é 20. Em caso de vazio, ele retornará métricas para no máximo 20 samplers

Respostas

Nome	Tipo	Description
200 OK	ClientMetricsResults	As métricas de cliente solicitadas
Other Status Codes	ErrorResponseBody	Resposta de erro do serviço de Teste de Carga. Headers x-ms-error-code: string

Exemplos

GetTestRunClientMetrics

Sample Request

HTTP

POST https://{Endpoint}/testruns/12316678-1234-1234-1234-122451189012/clientMetrics?api-version=2022-06-01-preview

{
  "requestSamplers": [
    "Homepage"
  ],
  "errors": [
    "500"
  ],
  "percentiles": [
    "95"
  ],
  "groupByInterval": "10s",
  "startTime": "2021-12-05T16:43:49.590Z",
  "endTime": "2021-12-05T16:43:49.590Z"
}

Sample Response

Status code:

200

{
  "testRunId": "12316678-1234-1234-1234-122451189012",
  "timeSeries": {
    "activeUsers": {
      "Homepage": [
        {
          "timestamp": "2021-12-05T16:43:49.320Z",
          "value": 1
        }
      ]
    },
    "responseTime": {
      "Homepage Pct 95": [
        {
          "timestamp": "2021-12-05T16:43:49.320Z",
          "value": 1
        }
      ]
    },
    "throughput": {
      "Homepage": [
        {
          "timestamp": "2021-12-05T16:43:49.320Z",
          "value": 2
        }
      ]
    },
    "errors": {
      "500": [
        {
          "timestamp": "2021-12-05T16:43:49.320Z",
          "value": 1
        }
      ]
    }
  }
}

Definições

Nome	Description
ClientMetricsRequestModel	Conteúdo da solicitação de métricas do cliente
ClientMetricsResults
Error	Erro de uma solicitação REST.
ErrorResponseBody	A definição de um objeto de erro.
Series

ClientMetricsRequestModel

Conteúdo da solicitação de métricas do cliente

Nome	Tipo	Description
endTime	string	Hora de término
errors	string[]	Lista de erros, o máximo de erros com suporte para consultas é 20. No caso de vazio, por padrão, retornará métricas para o máximo de 20 erros
groupByInterval	string	Para a duração do teste menor que 10 minutos de grupo por intervalo de tempo pode ser qualquer um dos 5s,10s,1m,5m.\n\nPara duração do teste maior que 10 minutos, o intervalo de tempo agrupar por pode ser qualquer um de 1m,5m,1h. O valor padrão é 1m.
percentiles	string[]	Lista de valores de percentis para o tempo de resposta, valores com suporte 50,90,99,95. O valor padrão é o 50º percentil.
requestSamplers	string[]	Lista de exemplos de solicitação, o máximo de exemplos com suporte para consultas é 20. Em caso de vazio, ele retornará métricas para no máximo 20 samplers
startTime	string	Hora de início

ClientMetricsResults

Nome	Tipo	Description
testRunId	string	Nome de execução de teste para o qual os resultados das métricas do cliente são necessários.
timeSeries	Series

Error

Erro de uma solicitação REST.

Nome	Tipo	Description
code	string	O código de erro.
details	Error[]	Detalhes adicionais e erros internos.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponseBody

A definição de um objeto de erro.

Nome	Tipo	Description
error	Error	Erro de uma solicitação REST.

Series

Nome	Tipo	Description
activeUsers	object	Dados de série temporal de usuários ativos.
errors	object	Erros de dados de série temporal.
responseTime	object	Tempo de resposta, dados de série temporal.
throughput	object	Dados de série temporal de taxa de transferência.