uip-tm- perf-szenario

Syntax und Optionen für „uip tm perf-scenario“, das Leistungsszenarien für den Test Manager erstellt und ausführt, Ausführungsdaten überprüft und Berichte erstellt.

uip tm perf-scenario verwaltet Test Manager-Leistungsszenarien: Erstellen Sie ein Szenario, binden Sie Testfälle als Lastgruppen mit einem Lastprofil daran (virtuelle Benutzer, Hochfahren/Peak-/Herunterfahren-Zeit, SLO-Schwellenwerte) und führen Sie es als schnellen Schreibtischtest aus oder einen vollständigen Lasttest durchführen, überprüfen Sie dann die resultierenden Ausführungsdaten und erstellen Sie Berichte.

Wichtig:

Auf dieser Seite wird eine echte, vollständig ausgelieferte Befehlsgruppe dokumentiert – sie wird bedingungslos zusammen mit jedem anderen uip tm -Befehl registriert, nicht hinter einem Feature-Flag. Wenn Ihnen mitgeteilt wurde, dass diese Oberfläche nicht vorhanden ist oder eine Vorabversion ist, wenden Sie sich direkt an uip tm perf-scenario --help.

Diese Ressource umfasst vier Seiten:

• Diese Seite – Konzepte und der Szenariolebenszyklus: create, get, list, execute, stop, list-dry-run-reports.
• Lastgruppen – load-groups add/update/remove/list, die Testfall-zu-Szenario-Bindung und ihr Lastprofil.
• Ausführungsdaten – executions list, results get, http-errors list, automation-errors list, transaction-metrics list.
• Berichte – report generate, report compare.

Konzepte

• Szenario – Die Definition des Leistungstests auf oberster Ebene (--scenario-key, z. B. SP1:7). Erstellt mit create, überprüft mit get, ausführen mit execute.
• Lastgruppe – ein Testfall, der an ein Szenario mit einem Lastprofil gebunden ist (virtuelle Benutzer, Zeitplan, SLO-Schwellenwerte, Robotertyp). Ein Szenario kann mehrere Lastgruppen haben. Siehe Lastgruppen.
• Ausführung – eine Ausführung eines Szenarios, entweder dryRun (Schnelle Smoke-Lauf) oder performanceTesting (Vollständige Lastausführung unter Berücksichtigung des Lastprofils jeder Lastgruppe). Mit execute gestartet, über Ausführungsdaten überprüft und mit stop früh angehalten.
• Schreibtischtestbericht – Der Performance Service zeichnet einen Bericht nach einem Schreibtischtest auf. Für eine vollständige performanceTesting -Ausführung muss mindestens ein endgültiger Schreibtischtestbericht vorhanden sein; Wenden Sie sich an list-dry-run-reports, bevor Sie einen vollständigen Lasttest ausführen.

Die meisten gelesenen Verben auf allen vier Seiten akzeptieren --query <expr>, einen Filter im JQ-Stil, der clientseitig auf die Ausgabe Data angewendet wird, bevor er gedruckt wird – verwenden Sie ihn, um eine große Nutzlast einzugrenzen (siehe Beispiel list unten).

Zusammenfassung

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>]

Alle Verben berücksichtigen die globalen Optionen und die Standardaustrittscodes. Jedes Verb auf allen vier perf-scenario -Seiten akzeptiert --log-level <level> (Standard: Information).

Hinweis:

--project-key ist nur ein .requiredOption() auf create und stop auf dieser Seite (und auf load-groups update/remove/list – siehe Lastgruppen). Bei get, execute und list-dry-run-reports ist es optional – das Projekt wird vom Präfix von --scenario-key abgeleitet (z. B. SP1:7 → Projekt SP1), wenn es weggelassen wird, und --project-key überschreibt diese Ableitung wenn bestanden. Die Verben auf den Seiten Ausführungsdaten und Berichte nehmen überhaupt nicht --project-key (außer optional bei den beiden report -Verben, bei denen es nur darauf ankommt, ob der zurückgegebene Link die In-App-Berichtsseite öffnet) – diese Verben rufen die auf Performance Service direkt, anstatt ein Test Manager-Projekt zu lösen.

uip tm perf-szenario erstellen

Erstellen Sie ein Leistungsszenario in einem Test Manager-Projekt.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--name <name>	Erforderlich. Szenarioname.
--description <text>	Szenariobeschreibung. Standardmäßig leer. Begrenzt auf 5120 Zeichen.
--version <version>	Zeichenfolge der Szenarioversion. Die Standardeinstellung ist 1.0. Begrenzt auf 255 Zeichen.
--app-type <type>	Anwendungstyp: web, apiService, ecommerce, gaming, financial, healthcare, saaS, streaming, messaging, enterprise. Die Standardeinstellung ist web.
--perf-test-type <type>	Leistungstesttyp: loadTesting, stressTesting, enduranceTesting, spikeTesting. Standardmäßig auf loadTesting.
--responsiveness <level>	Erwartete Reaktionsfähigkeit: instant, fast, moderate, slow, verySlow. Die Standardeinstellung ist fast.

Beispiel

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

Datenform

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

UIP-TM perf-szenario abrufen

Rufen Sie die Metadaten eines Szenarios und die daran gebundenen Lastgruppen ab.

Optionen

Markieren	Beschreibung
--scenario-key <key>	Erforderlich. Szenarioobjektschlüssel (z. B. SP1:7).
--project-key <key>	Besitz des Projekts. Optional – abgeleitet vom Präfix --scenario-key, wenn es weggelassen wird.

Beispiel

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

Datenform

{
  "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 hier ist die Lastgruppen-ID des Szenarios – der Bezeichner load-groups update und load-groups remove erwarten (siehe Lastgruppen). Dies ist eine andere ID als die von load-groups list zurückgegebenen Zeilen pro Ausführung.

uip-tm perf-szenario-Liste

Listen Sie die Leistungsszenarien in einem Projekt auf.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--search <text>	Filtern Sie Szenarien nach Namen oder Schlüssel.
--limit <n>	Max. zurückzugebende Ergebnisse. Standardmäßig die eigene Seitengröße des Diensts, wenn keine Angabe erfolgt.
--offset <n>	Ergebnisse, die für das Paginieren übersprungen werden sollen. Die Standardeinstellung ist 0.
--query <expr>	Ein Filter im JQ-Stil, der auf die Ausgabedaten angewendet wird.

Beispiele

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

Datenform

{
  "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 ist die vom Server gemeldete Gesamtanzahl an Übereinstimmungen, die Count (die Anzahl der tatsächlich zurückgegebenen Zeilen) überschreiten kann, wenn --limit die Seite abschneidet.

Ausführung des UIP-TM perf-szenario

Führt ein Szenario aus und gibt dessen Ausführungs-ID zurück. Der Standardmodus ist dryRun (Schnelle Smoke-Ausführung); Übergeben Sie --execution-type performanceTesting für eine vollständige Ladeausführung unter Berücksichtigung der Lastprofil-Flags für jede Lastgruppe. Für eine vollständige Ausführung muss mindestens ein endgültiger Schreibtischtestbericht vorhanden sein – fragen Sie zuerst bei list-dry-run-reports nach.

Optionen

Markieren	Beschreibung
--scenario-key <key>	Erforderlich. Szenarioobjektschlüssel (z. B. SP1:7).
--project-key <key>	Besitz des Projekts. Optional – abgeleitet vom Präfix --scenario-key, wenn es weggelassen wird.
--execution-type <type>	dryRun oder performanceTesting. Die Standardeinstellung ist dryRun.
--wait	Rufen Sie ab, bis die Ausführung einen Endstatus erreicht (Finished oder Cancelled), und geben Sie dann dieselbe Form wie results get aus (siehe Ausführungsdaten). Wird ungleich Null beendet, wenn die Ausführung Cancelled ist, eine Automatisierungskonfiguration fehlgeschlagen ist oder ein SLO verletzt wurde.
--full	Fügen Sie mit --wait die Zeitreihenfolge pro Sekunde (AggregatedData + AggregatedDataWithTransaction) in die Ausgabe ein. Fehler, wenn er ohne --wait übergeben wird.
--poll-interval-sec <n>	Mit --wait Sekunden zwischen Statusprüfungen. Die Standardeinstellung ist 12. Fehler, wenn er ohne --wait übergeben wird.
--timeout-sec <n>	Mit --wait, maximale Sekunden zu warten (0 = kein Timeout). Die Standardeinstellung ist 1800. Fehler, wenn er ohne --wait übergeben wird. Verstrichen wird 4 beendet – die Ausführung wird fortgesetzt, also überprüfen Sie sie erneut mit results get.

Beispiele

# 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

Datenform – ohne --wait

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

Datenform – mit --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 fragt results get intern ab, sodass dies dieselbe Nutzlastform ist, die results get für eine abgeschlossene Ausführung zurückgibt – execute --wait speichert nur einen zweiten Befehl. Ein nicht leeres SloViolationReasons -Array in einer beliebigen Lastgruppe oder ein Anwendungsprotokoll, das übereinstimmt mit „Konfigurationsausführung wurde mit dem Status „fehlgeschlagen“ beendet“, beendet den Befehl ungleich Null, auch wenn die Ausführung einen Endzustand erreicht hat.

uip tm perf-szenario stop

Eine laufende Szenarioausführung abbrechen.

Optionen

Markieren	Beschreibung
--execution-id <uuid>	Erforderlich. UUID der Szenarioausführung (ExecutionId aus execute).
--project-key <key>	Erforderlich. Besitz des Projekts.

Beispiel

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

Datenform

{
  "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" spiegelt wider, dass der Server die Abbruchanforderung akzeptiert hat, nicht, dass die Ausführung tatsächlich noch angehalten wurde – der Abbruch ist asynchron.

uip tm perf-szenario list- Schreibtisch-run-reports

Listen Sie erfolgreiche Schreibtischtestberichte für ein Szenario auf. Führen Sie dies aus , bevor Sie eine vollständige performanceTesting -Ausführung einreichen – für eine vollständige Ausführung muss bereits ein bestandener Schreibtischtestbericht für die Automatisierung jeder Lastgruppe vorhanden sein.

Optionen

Markieren	Beschreibung
--scenario-key <key>	Erforderlich. Szenarioobjektschlüssel (z. B. SP1:7).
--project-key <key>	Besitz des Projekts. Optional – abgeleitet vom Präfix --scenario-key, wenn es weggelassen wird.

Beispiel

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

Datenform

{
  "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
      }
    ]
  }
}

Ein leeres Reports -Array (und HasPassingDryRun: false) bedeutet, dass noch keine Lastgruppe einen vorübergehenden Schreibtischtest hat – führen Sie zuerst execute (standardmäßiger dryRun -Modus) aus. Dieser Befehlsfehler, anstatt ein leeres Ergebnis zurückzugeben, wenn das Szenario keine Lastgruppen hat oder wenn keiner der Testfälle seiner Lastgruppen eine verknüpfte Automatisierung enthält.

Zugehörig

• Lastgruppen – binden Testfälle an ein Szenario und stimmen deren Lastprofil ab.
• Ausführungsdaten –Inspizieren Sie eine abgeschlossene oder sich noch in Bearbeitung befindende Ausführung.
• Berichte – Rendern erstellte Berichte für eine Ausführung oder einen Vergleich.
• Testfälle – link-automation gibt einem Testfall den automationId , von dem load-groups add und list-dry-run-reports abhängen.
• Projekt – Scope, der jedes Szenario besitzt.

Siehe auch

• Test Manager-Übersicht