Belastningstest API-integration

Denne guide forklarer, hvordan du bruger LoadFocus API Client, både via kommandolinjegrænsefladen (CLI) og ved direkte brug af JavaScript-biblioteket i dine applikationer.

Indholdsfortegnelse

• Installation
• Konfiguration
• Kommandolinjegrænseflade (CLI)
  • JMeter-testudførelse
  • Teststatusovervågning
  • Hentning af resultater
  • Arbejde med tærskler
  • Outputformater
• JavaScript-biblioteksbrug
  • Grundlæggende opsætning
  • JMeter Client
  • Udførelse af tests
  • Overvågning af teststatus
  • Hentning af resultater
  • Komplet eksempel
• Avanceret brug
  • Tilpasset HTTP-konfiguration
  • Fejlhåndtering
  • Parallel testudførelse
• Fejlfinding

Installation

Global installation

npm install -g @loadfocus/loadfocus-api-client

Lokal projektinstallation

npm install @loadfocus/loadfocus-api-client

Konfiguration

Før du bruger LoadFocus API Client, skal du konfigurere dine API-legitimationsoplysninger.

CLI-konfiguration

# Set API key and team ID
loadfocus-api config set apikey YOUR_API_KEY
loadfocus-api config set teamid YOUR_TEAM_ID

# Verify configuration
loadfocus-api config show

JavaScript-konfiguration

const { configManager } = require('@loadfocus/loadfocus-api-client');

// Set configuration
configManager.set('apikey', 'YOUR_API_KEY');
configManager.set('teamid', 'YOUR_TEAM_ID');

// Verify configuration
console.log(configManager.get('apikey')); // Should print your API key
console.log(configManager.isConfigured()); // Should print true if all required config is set

Kommandolinjegrænseflade (CLI)

LoadFocus API Client tilbyder en omfattende CLI til interaktion med LoadFocus API.

JMeter-testudførelse

Udfør en test

# Execute a test by name
loadfocus-api jmeter execute --name "My JMeter Test"

# Execute a test with specific parameters
loadfocus-api jmeter execute --name "My JMeter Test" --threads 50 --rampup 30 --duration 300

Kør en test og vent på fuldførelse

# Run a test and wait for completion
loadfocus-api jmeter run-test --name "My JMeter Test"

# Run a test with thresholds
loadfocus-api jmeter run-test --name "My JMeter Test" --thresholds "avgresponse<=200,errors==0,p95<=250"

# Run a test with custom timeout and polling interval
loadfocus-api jmeter run-test --name "My JMeter Test" --waitTimeout 1800 --pollInterval 15

Teststatusovervågning

# Check status of a test by name and ID
loadfocus-api jmeter status --name "My JMeter Test" --id 12345

# Get a list of recent test runs
loadfocus-api jmeter runs --limit 10

Hentning af resultater

# Get results for a specific test
loadfocus-api jmeter results --name "My JMeter Test" --id 12345

# Get results with specific metrics
loadfocus-api jmeter results --name "My JMeter Test" --id 12345 --include samples,avgresponse,errors

Arbejde med tærskler

Kommandoen run-test understøtter tærskelevaluering til automatisk at afgøre, om en test består eller fejler baseret på ydeevnemålinger.

# Run a test with multiple thresholds
loadfocus-api jmeter run-test --name "My JMeter Test" --thresholds "avgresponse<=200,errors==0,p95<=250,hitspersec>=10"

Understøttede tærskeloperatorer:

• <= - Mindre end eller lig med
• < - Mindre end
• >= - Større end eller lig med
• > - Større end
• == - Lig med
• != - Ikke lig med

Outputformater

# Get results in JSON format
loadfocus-api jmeter run-test --name "My JMeter Test" --format json > results.json

# Default pretty-printed output
loadfocus-api jmeter run-test --name "My JMeter Test"

JavaScript-biblioteksbrug

LoadFocus API Client kan også bruges direkte som et JavaScript-bibliotek i dine applikationer.

Grundlæggende opsætning

// Import the LoadFocus API Client
const loadfocus = require('@loadfocus/loadfocus-api-client');

// Access specific components
const { JMeterClient, configManager } = loadfocus;

JMeter Client

// Create a JMeter client
const jmeterClient = new loadfocus.JMeterClient();

// Or with explicit configuration
const jmeterClient = new loadfocus.JMeterClient({
  apikey: 'YOUR_API_KEY',
  teamid: 'YOUR_TEAM_ID'
});

Udførelse af tests

async function executeTest() {
  try {
    const result = await jmeterClient.execute({
      testrunname: 'My JMeter Test',
      threads: 50,
      rampup: 30,
      duration: 300
    });

    console.log('Test execution started:', result);
    return result.testrunid; // Return the test ID for later use
  } catch (error) {
    console.error('Error executing test:', error);
  }
}

Overvågning af teststatus

async function checkTestStatus(testName, testId) {
  try {
    const status = await jmeterClient.getStatus({
      testrunname: testName,
      testrunid: testId
    });

    console.log('Test status:', status);
    return status.state; // Return the current state
  } catch (error) {
    console.error('Error checking test status:', error);
  }
}

Hentning af resultater

async function getTestResults(testName, testId) {
  try {
    // Get available labels for the test
    const labels = await jmeterClient.getLabels({
      testrunname: testName,
      testrunid: testId
    });

    console.log('Test labels:', labels);

    // Get results for each label
    const allResults = [];
    for (const label of labels) {
      const labelResults = await jmeterClient.getResults({
        testrunname: testName,
        testrunid: testId,
        filter: label
      });

      allResults.push({
        label,
        results: labelResults
      });
    }

    console.log('Test results:', allResults);
    return allResults;
  } catch (error) {
    console.error('Error retrieving test results:', error);
  }
}

Komplet eksempel

Her er et komplet eksempel, der udfører en test, venter på fuldførelse og henter resultater:

const { JMeterClient, configManager } = require('@loadfocus/loadfocus-api-client');

// Set up configuration
configManager.set('apikey', 'YOUR_API_KEY');
configManager.set('teamid', 'YOUR_TEAM_ID');

// Create client
const jmeterClient = new JMeterClient();

async function runCompleteTest() {
  try {
    // Execute the test
    console.log('Executing test...');
    const executeResult = await jmeterClient.execute({
      testrunname: 'My JMeter Test'
    });

    const testId = executeResult.testrunid;
    console.log(`Test execution started with ID: ${testId}`);

    // Wait for completion
    console.log('Waiting for test to complete...');
    let completed = false;
    while (!completed) {
      const status = await jmeterClient.getStatus({
        testrunname: 'My JMeter Test',
        testrunid: testId
      });

      console.log(`Current state: ${status.state}`);

      if (status.state === 'finished') {
        completed = true;
      } else if (status.state === 'failed' || status.state === 'error') {
        throw new Error(`Test failed with state: ${status.state}`);
      } else {
        // Wait before checking again
        await new Promise(resolve => setTimeout(resolve, 10000));
      }
    }

    // Get results
    console.log('Getting test results...');
    const labels = await jmeterClient.getLabels({
      testrunname: 'My JMeter Test',
      testrunid: testId
    });

    const allResults = [];
    for (const label of labels) {
      const labelResults = await jmeterClient.getResults({
        testrunname: 'My JMeter Test',
        testrunid: testId,
        filter: label
      });

      allResults.push({
        label,
        results: labelResults
      });
    }

    console.log('Test results:', JSON.stringify(allResults, null, 2));
    return allResults;
  } catch (error) {
    console.error('Error running test:', error);
  }
}

// Run the test
runCompleteTest();

Avanceret brug

Tilpasset HTTP-konfiguration

Du kan tilpasse den HTTP-klient, der bruges af LoadFocus API Client:

const { JMeterClient } = require('@loadfocus/loadfocus-api-client');

// Create client with custom HTTP options
const jmeterClient = new JMeterClient({
  apikey: 'YOUR_API_KEY',
  teamid: 'YOUR_TEAM_ID',
  httpOptions: {
    timeout: 30000, // 30 seconds
    retries: 3,
    headers: {
      'User-Agent': 'My Custom Application'
    }
  }
});

Fejlhåndtering

LoadFocus API Client giver detaljerede fejlinformationer:

try {
  const result = await jmeterClient.execute({
    testrunname: 'My JMeter Test'
  });
} catch (error) {
  if (error.response) {
    // The request was made and the server responded with a status code
    // that falls out of the range of 2xx
    console.error('API Error:', error.response.status, error.response.data);
  } else if (error.request) {
    // The request was made but no response was received
    console.error('Network Error:', error.request);
  } else {
    // Something happened in setting up the request that triggered an Error
    console.error('Request Error:', error.message);
  }
}

Fejlfinding

Almindelige problemer

1. Autentificeringsfejl:

   • Sørg for, at din API-nøgle og team-ID er korrekt konfigureret
   • Tjek, at din API-nøgle har de nødvendige tilladelser

2. Testudførelsesfejl:

   • Bekræft, at testnavnet eksisterer i din LoadFocus-konto
   • Tjek, om du har nået din kontos grænse for samtidige tests

3. Timeout-problemer:

   • For langvarige tests, øg parameteren waitTimeout
   • Overvej at implementere en pollingmekanisme i stedet for at vente synkront

4. Problemer med hentning af resultater:

   • Sørg for, at testen er fuldført, før du henter resultater
   • Tjek, at test-ID'et er korrekt

Fejlsøgning

Aktiver fejlsøgningslogning for mere detaljerede oplysninger:

// In your JavaScript code
process.env.DEBUG = 'true';

// Or when using the CLI
DEBUG=true loadfocus-api jmeter run-test --name "My JMeter Test"

For yderligere hjælp, se venligst LoadFocus API-dokumentationen eller kontakt support.