Lasttesting API-integrasjon

Denne veiledningen forklarer hvordan du bruker LoadFocus API-klienten, både gjennom kommandolinjegrensesnittet (CLI) og ved direkte bruk av JavaScript-biblioteket i applikasjonene dine.

Innholdsfortegnelse

• Installasjon
• Konfigurasjon
• Kommandolinjegrensesnitt (CLI)
  • JMeter-testutførelse
  • Overvåking av teststatus
  • Henting av resultater
  • Arbeide med terskelverdier
  • Utdataformater
• Bruk av JavaScript-bibliotek
  • Grunnleggende oppsett
  • JMeter-klient
  • Utføre tester
  • Overvåke teststatus
  • Hente resultater
  • Komplett eksempel
• Avansert bruk
  • Tilpasset HTTP-konfigurasjon
  • Feilhåndtering
  • Parallell testutførelse
• Feilsøking

Installasjon

Global installasjon

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

Lokal prosjektinstallasjon

npm install @loadfocus/loadfocus-api-client

Konfigurasjon

Før du bruker LoadFocus API-klienten, må du konfigurere API-legitimasjonen din.

CLI-konfigurasjon

# 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-konfigurasjon

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

Kommandolinjegrensesnitt (CLI)

LoadFocus API-klienten tilbyr et omfattende CLI for interaksjon med LoadFocus API-et.

JMeter-testutførelse

Utføre 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

Kjøre en test og vente på fullføring

# 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

Overvåking av teststatus

# 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

Henting av 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

Arbeide med terskelverdier

Kommandoen run-test støtter terskelverdievaluering for automatisk å avgjøre om en test består eller feiler basert på ytelsesmå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"

Støttede terskelverdioperatorer:

• <= - Mindre enn eller lik
• < - Mindre enn
• >= - Større enn eller lik
• > - Større enn
• == - Lik
• != - Ikke lik

Utdataformater

# 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"

Bruk av JavaScript-bibliotek

LoadFocus API-klienten kan også brukes direkte som et JavaScript-bibliotek i applikasjonene dine.

Grunnleggende oppsett

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

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

JMeter-klient

// 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'
});

Utføre tester

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åke 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);
  }
}

Hente 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);
  }
}

Komplett eksempel

Her er et komplett eksempel som utfører en test, venter på fullføring 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();

Avansert bruk

Tilpasset HTTP-konfigurasjon

Du kan tilpasse HTTP-klienten som brukes av LoadFocus API-klienten:

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'
    }
  }
});

Feilhåndtering

LoadFocus API-klienten gir detaljert feilinformasjon:

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);
  }
}

Feilsøking

Vanlige problemer

1. Autentiseringsfeil:

   • Sørg for at API-nøkkelen og team-ID-en er korrekt konfigurert
   • Sjekk at API-nøkkelen din har de nødvendige tillatelsene

2. Testutførelsesfeil:

   • Verifiser at testnavnet finnes i LoadFocus-kontoen din
   • Sjekk om du har nådd kontoens grense for samtidige tester

3. Tidsavbruddsproblemer:

   • For langvarige tester, øk waitTimeout-parameteren
   • Vurder å implementere en pollingmekanisme i stedet for å vente synkront

4. Problemer med henting av resultater:

   • Sørg for at testen er fullført før du henter resultater
   • Sjekk om test-ID-en er korrekt

Feilsøking

Aktiver feilsøkingslogging for mer detaljert informasjon:

// 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 ytterligere hjelp, se LoadFocus API-dokumentasjonen eller kontakt support.