escenario de rendimiento de uip tm

Sintaxis y opciones para `uip tm perf-scenario`, que crea y ejecuta escenarios de rendimiento de Test Manager, inspecciona los datos de ejecución y genera informes.

uip tm perf-scenario gestiona los escenarios de rendimiento de Test Manager: crea un escenario, vincula los casos de prueba a él como grupos de carga con un perfil de carga (usuarios virtuales, tiempo de aceleración/máximo/descenso, umbrales de SLO), lo ejecuta como un secado rápido ejecutar o una prueba de carga completa, luego inspeccionar los datos de ejecución resultantes y renderizar informes.

Importante:

Esta página documenta un grupo de comandos real y completo: se registra incondicionalmente junto con cualquier otro comando uip tm, no detrás de un marcador de característica. Si le han dicho que esta superficie no existe o es una versión preliminar, verifique directamente con uip tm perf-scenario --help.

Este recurso abarca cuatro páginas:

• Esta página : conceptos y el ciclo de vida del escenario: create, get, list, execute, stop, list-dry-run-reports.
• Grupos de carga : load-groups add/update/remove/list, la vinculación de caso de prueba a escenario y su perfil de carga.
• Datos de ejecución : executions list, results get, http-errors list, automation-errors list, transaction-metrics list.
• Informes : report generate, report compare.

Conceptos

• Escenario : la definición de prueba de rendimiento de nivel superior (--scenario-key, por ejemplo SP1:7). Creado con create, inspeccionado con get, ejecutar con execute.
• Grupo de carga : un caso de prueba vinculado a un escenario con un perfil de carga (usuarios virtuales, tiempo, umbrales de SLO, tipo de robot). Un escenario puede tener varios grupos de carga. Consulta Grupos de carga.
• Ejecución : una ejecución de un escenario, ya sea dryRun (ejecución rápida de humo) o performanceTesting (ejecución de carga completa que respeta el perfil de carga de cada grupo de carga). Comenzó con execute, se inspeccionó a través de Datos de ejecución y se detuvo antes de tiempo con stop.
• Informe de ejecución en seco : Performance Service registra un informe después de una ejecución en seco. Una ejecución performanceTesting completa requiere que ya exista al menos un informe de ejecución en seco; consulta con list-dry-run-reports antes de ejecutar una prueba de carga completa.

La mayoría de los verbos leídos en las cuatro páginas aceptan --query <expr>, un filtro de estilo jq aplicado en el lado del cliente a la salida Data antes de que se imprima; utilízalo para reducir una gran carga útil (consulta el ejemplo list a continuación).

Sinopsis

uip tm perf-scenario create --project-key <key> --name <name> [--description <text>] [--version <version>] [--app-type <type>] [--perf-test-type <type>] [--responsiveness <level>]
uip tm perf-scenario get --scenario-key <key> [--project-key <key>]
uip tm perf-scenario list --project-key <key> [--search <text>] [--limit <n>] [--offset <n>] [--query <expr>]
uip tm perf-scenario execute --scenario-key <key> [--project-key <key>] [--execution-type <dryRun|performanceTesting>] [--wait [--full] [--poll-interval-sec <n>] [--timeout-sec <n>]]
uip tm perf-scenario stop --execution-id <uuid> --project-key <key>
uip tm perf-scenario list-dry-run-reports --scenario-key <key> [--project-key <key>]

Todos los verbos respetan las opciones globales y los códigos de salida estándar. Cada verbo en las cuatro páginas perf-scenario acepta --log-level <level> (predeterminado Information).

Nota:

--project-key es solo un .requiredOption() en create y stop en esta página (y en load-groups update/remove/list — consulta Cargar grupos). En get, execute, y list-dry-run-reports es opcional: el proyecto se deriva del prefijo de --scenario-key (por ejemplo, SP1:7 → proyecto SP1) cuando se omite, y --project-key anula esa derivación si se aprueba. Los verbos en las páginas Datos de ejecución e Informes no toman --project-key en absoluto (excepto opcionalmente en los dos verbos report , donde solo afecta si el enlace devuelto abre la página de informe en la aplicación): esos verbos llaman al Performance Service directamente en lugar de resolver un proyecto de Test Manager.

creación de escenario de rendimiento de uip tm

Crea un escenario de rendimiento en un proyecto de Test Manager.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--name <name>	Obligatorio. Nombre del escenario.
--description <text>	Descripción del escenario. El valor predeterminado es vacío. Limitado a 5120 caracteres.
--version <version>	Cadena de versión del escenario. El valor predeterminado es 1.0. Con un límite de 255 caracteres.
--app-type <type>	Tipo de aplicación: web, apiService, ecommerce, gaming, financial, healthcare, saaS, streaming, messaging, enterprise. El valor predeterminado es web.
--perf-test-type <type>	Tipo de prueba de rendimiento: loadTesting, stressTesting, enduranceTesting, spikeTesting. El valor predeterminado es loadTesting.
--responsiveness <level>	Capacidad de respuesta esperada: instant, fast, moderate, slow, verySlow. El valor predeterminado es fast.

Ejemplo

uip tm perf-scenario create \
  --project-key SP1 \
  --name "Checkout load" \
  --app-type web \
  --perf-test-type loadTesting \
  --responsiveness fast

Forma de datos

{
  "Code": "ScenarioCreate",
  "Data": {
    "ScenarioKey": "SP1:7",
    "Name": "Checkout load",
    "Version": "1.0",
    "AppType": "web",
    "PerfTestType": "loadTesting",
    "Responsiveness": "fast"
  }
}

Obtener escenario de rendimiento de uip tm

Obtener los metadatos de un escenario y los grupos de carga vinculados a él.

Opciones

Marca	Descripción
--scenario-key <key>	Obligatorio. Clave de objeto de escenario (por ejemplo, SP1:7).
--project-key <key>	Proyecto propietario. Opcional: derivado del prefijo --scenario-key cuando se omite.

Ejemplo

uip tm perf-scenario get --scenario-key SP1:7

Forma de datos

{
  "Code": "ScenarioGet",
  "Data": {
    "ScenarioKey": "SP1:7",
    "Name": "Checkout load",
    "Version": "1.0",
    "Description": "",
    "AppType": "web",
    "PerfTestType": "loadTesting",
    "Responsiveness": "fast",
    "LoadGroups": [
      {
        "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
        "TestCaseKey": "SP1:602",
        "Name": "Checkout flow",
        "PackageName": "Checkout_Tests",
        "PackageVersion": "1.0.2",
        "FolderKey": "94821c49-ab85-49cb-94e1-f82c6d8973be",
        "VirtualUsers": 20,
        "Enabled": true
      }
    ]
  }
}

LoadGroupId aquí está el ID del grupo de carga del escenario: el identificador load-groups update y load-groups remove esperado (consulta Grupos de carga). Este es un ID diferente de las filas por ejecución devueltas por load-groups list.

Lista de escenarios de rendimiento de UIP tm

Enumera los escenarios de rendimiento en un proyecto.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--search <text>	Filtra los escenarios por nombre o clave.
--limit <n>	Máximo de resultados que devolver. Cuando se omite, se establece de forma predeterminada en el tamaño de la página del propio servicio.
--offset <n>	Resultados a omitir, para la paginación. El valor predeterminado es 0.
--query <expr>	filtro de estilo jq aplicado a los datos de salida.

Ejemplos

uip tm perf-scenario list --project-key DEMO

# search by name, narrowing the output to just the scenario rows
uip tm perf-scenario list --project-key DEMO --search checkout --query .Scenarios

Forma de datos

{
  "Code": "PerfScenariosList",
  "Data": {
    "Total": 2,
    "Count": 2,
    "Scenarios": [
      {
        "ScenarioKey": "DEMO:7",
        "Name": "Checkout load",
        "Version": "1.0",
        "AppType": "web",
        "PerfTestType": "loadTesting",
        "Responsiveness": "fast",
        "VirtualUsers": 20,
        "DurationMinutes": 0,
        "Updated": "2025-04-15T10:30:00Z",
        "UpdatedBy": "[e-mail]"
      },
      {
        "ScenarioKey": "DEMO:9",
        "Name": "Search stress",
        "Version": "1.0",
        "AppType": "web",
        "PerfTestType": "stressTesting",
        "Responsiveness": "fast",
        "VirtualUsers": 100,
        "DurationMinutes": 0,
        "Updated": "2025-04-15T10:30:00Z",
        "UpdatedBy": "[e-mail]"
      }
    ]
  }
}

Total es el recuento total de coincidencias notificado por el servidor, que puede superar Count (el número de filas realmente devueltas) cuando --limit trunca la página.

Ejecutar escenario de rendimiento de uip tm

Ejecuta un escenario y devuelve su ID de ejecución. El modo predeterminado es dryRun (ejecución rápida de humo); pasar --execution-type performanceTesting para una ejecución de carga completa que respete los marcadores de perfil de carga en cada grupo de carga. Una ejecución completa requiere que ya exista al menos un informe de ejecución en seco aprobado: consulte primero con list-dry-run-reports.

Opciones

Marca	Descripción
--scenario-key <key>	Obligatorio. Clave de objeto de escenario (por ejemplo, SP1:7).
--project-key <key>	Proyecto propietario. Opcional: derivado del prefijo --scenario-key cuando se omite.
--execution-type <type>	dryRun o performanceTesting. Es dryRun de forma predeterminada.
--wait	Sondea hasta que la ejecución alcance un estado terminal (Finished o Cancelled) y, a continuación, emite la misma forma que results get (consulta Datos de ejecución). Sale distinto de cero si la ejecución es Cancelled, una configuración de automatización falló o se violó un SLO.
--full	Con --wait, incluye la serie temporal por segundo (AggregatedData + AggregatedDataWithTransaction) en la salida. Errores si se pasa sin --wait.
--poll-interval-sec <n>	Con --wait, segundos entre comprobaciones de estado. El valor predeterminado es 12. Errores si se pasa sin --wait.
--timeout-sec <n>	Con --wait, máximo de segundos de espera (0 = sin tiempo de espera). El valor predeterminado es 1800. Errores si se pasa sin --wait. Salidas transcurridas 4: la ejecución continúa, así que vuelve a comprobarlo con results get.

Ejemplos

# start a dry run and return immediately
uip tm perf-scenario execute --scenario-key SP1:7

# run a full performance test and wait for the results bundle
uip tm perf-scenario execute \
  --scenario-key SP1:7 \
  --execution-type performanceTesting \
  --wait

Forma de datos: sin --wait

{
  "Code": "ScenarioExecute",
  "Data": {
    "ScenarioKey": "SP1:7",
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "ExecutionType": "dryRun",
    "Status": "Pending"
  }
}

Forma de datos: con --wait

{
  "Code": "ScenarioExecutionResults",
  "Data": {
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "LoadGroupCount": 1,
    "LoadGroups": [
      {
        "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
        "StartedAt": "2025-04-15T10:30:00Z",
        "CumulativeResponseTimeMs": 120,
        "MaxResponseTimeMs": 450,
        "SuccessfulWorkflowCount": 98,
        "FailedWorkflowCount": 2,
        "HttpErrorCount": 0,
        "HttpErrorRate": 0,
        "AutomationErrorCount": 2,
        "AutomationErrorRate": 0.02,
        "SloViolationReasons": []
      }
    ],
    "LogCount": 12,
    "ApplicationLogs": [
      {
        "CreatedAt": "2025-04-15T10:31:00Z",
        "LogLevel": "Information",
        "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
        "Message": "Execution finished"
      }
    ]
  }
}

--wait sondea results get internamente, por lo que esta es la misma forma de carga útil que results get devuelve para una ejecución finalizada: execute --wait solo guarda un segundo comando. Una matriz SloViolationReasons no vacía en cualquier grupo de carga, o un registro de la aplicación que coincida con "la ejecución de la configuración ha finalizado con el estado 'fallido'", hace que la salida del comando sea distinta de cero aunque la ejecución haya alcanzado un estado terminal.

parada de escenario de rendimiento de uip tm

Cancelar la ejecución de un escenario en curso.

Opciones

Marca	Descripción
--execution-id <uuid>	Obligatorio. UUID de ejecución de escenario (el ExecutionId de execute).
--project-key <key>	Obligatorio. Proyecto propietario.

Ejemplo

uip tm perf-scenario stop --execution-id 80694766-5a44-0000-0985-0b49fd93832d --project-key SP1

Forma de datos

{
  "Code": "ScenarioStop",
  "Data": {
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "Result": "Stopping",
    "Note": "Server has accepted the cancel request. Run 'perf-scenario results get --execution-id <ID>' to confirm terminal status (will be 'Cancelled')."
  }
}

Result: "Stopping" refleja que el servidor ha aceptado la solicitud de cancelación, no que la ejecución se haya detenido todavía: la cancelación es asíncrona.

uip tm perf-scenario list-dry-run-reports

Enumerar informes de ejecución en seco correctos para un escenario. Ejecuta esto antes de enviar una ejecución performanceTesting completa: una ejecución completa requiere que ya exista un informe de ejecución en seco para la automatización de cada grupo de carga.

Opciones

Marca	Descripción
--scenario-key <key>	Obligatorio. Clave de objeto de escenario (por ejemplo, SP1:7).
--project-key <key>	Proyecto propietario. Opcional: derivado del prefijo --scenario-key cuando se omite.

Ejemplo

uip tm perf-scenario list-dry-run-reports --scenario-key SP1:7

Forma de datos

{
  "Code": "ScenarioDryRunReports",
  "Data": {
    "ScenarioKey": "SP1:7",
    "ScenarioId": "756e8ebf-c227-0000-8a9f-0b49fd934bef",
    "HasPassingDryRun": true,
    "ReportCount": 1,
    "Reports": [
      {
        "AutomationId": "auto-1",
        "RuntimeType": 4,
        "RecommendedMultiplexingFactor": 3,
        "ApplicationType": null
      }
    ]
  }
}

Una matriz Reports vacía (y HasPassingDryRun: false) significa que ningún grupo de carga tiene un simulacro transitorio todavía: ejecuta execute (modo dryRun predeterminado) primero. Este comando produce un error en lugar de devolver un resultado vacío si el escenario no tiene grupos de carga, o si ninguno de los casos de prueba de sus grupos de carga lleva una automatización vinculada.

Relacionado

• Grupos de carga : vincula los casos de prueba a un escenario y ajusta su perfil de carga.
• Datos de ejecución : inspecciona una ejecución finalizada o en curso.
• Informes : renderiza informes creados para una ejecución o una comparación.
• casos de prueba : link-automation es lo que le da a un caso de prueba el automationId del que dependen load-groups add y list-dry-run-reports .
• proyecto : ámbito que posee cada escenario.

Ver también

• Descripción general de Test Manager