Helaian Grafana Kheat: semua yang perlu diketahui oleh jurutera prestasi

Helaian Penipuan Grafana K6: Segala-galanya Seorang Jurutera Prestasi Patut Tahu (dengan Contoh dan Amalan Terbaik)

1. Pengenalan kepada Grafana K6

Grafana K6 ialah alat sumber terbuka yang direka untuk ujian prestasi. Ia bagus untuk menguji API, perkhidmatan mikro dan tapak web secara berskala, memberikan cerapan pembangun dan penguji tentang prestasi sistem. Helaian tipu ini akan merangkumi aspek utama yang perlu diketahui oleh setiap jurutera prestasi untuk bermula dengan Grafana K6.

Apakah Grafana K6?

Grafana K6 ialah alat ujian beban moden untuk pembangun dan penguji yang menjadikan ujian prestasi mudah, berskala dan mudah untuk disepadukan ke dalam saluran paip CI anda.

Bila nak guna?

• Ujian beban
• Ujian tekanan
• Ujian spike
• Pengesanan kesesakan prestasi
• Ujian API
• Ujian penyemak imbas
• Kejuruteraan huru-hara

2. Lembaran Penipuan Grafana K6: Aspek Penting

2.1. Pemasangan

Pasang Grafana K6 melalui Homebrew atau Docker:

brew install k6
# Or with Docker
docker run -i grafana/k6 run - <script.js>



<h4>
  
  
  2.2. Ujian Asas dengan Public REST API
</h4>

<p>Berikut ialah cara menjalankan ujian mudah menggunakan API REST awam.<br>
</p>

<pre class="brush:php;toolbar:false">import http from "k6/http";
import { check, sleep } from "k6";

// Define the API endpoint and expected response
export default function () {
  const res = http.get("https://jsonplaceholder.typicode.com/posts/1");

  // Define the expected response
  const expectedResponse = {
    userId: 1,
    id: 1,
    title:
      "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    body: "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto",
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });

  sleep(1);
}

2.2.1 Menjalankan ujian dan penggunaan papan pemuka web

Untuk menjalankan ujian dan melihat keputusan dalam papan pemuka web, kita boleh menggunakan arahan berikut:

K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run ./src/rest/jsonplaceholder-api-rest.js

Ini akan menjana laporan dalam folder laporan dengan nama html-report.html.

Tetapi kami juga boleh melihat keputusan dalam papan pemuka web dengan mengakses URL berikut:

http://127.0.0.1:5665/

Sebaik sahaja kami mengakses URL, kami boleh melihat keputusan pada masa sebenar ujian dalam papan pemuka web.

2.3. Uji dengan Public GraphQL API

Contoh menggunakan API GraphQL awam.

Jika anda tidak tahu apa itu GraphQL API, anda boleh melawati URL berikut: Apakah itu GraphQL?.

Untuk mendapatkan maklumat lanjut tentang API GraphQL yang akan kami gunakan, anda boleh melawati dokumentasi URL berikut: GraphQL Pokémon.

Untuk mendapatkan maklumat lanjut tentang cara menguji API GraphQL, anda boleh melawati URL berikut: Pengujian GraphQL.

Ini adalah ujian mudah untuk mendapatkan pokemon dengan nama dan semak sama ada respons berjaya.

import http from "k6/http";
import { check } from "k6";

// Define the query and variables
const query = `
  query getPokemon($name: String!) {
    pokemon(name: $name) {
      id
      name
      types
    }
  }`;

const variables = {
  name: "pikachu",
};

// Define the test function
export default function () {
  const url = "https://graphql-pokemon2.vercel.app/";
  const payload = JSON.stringify({
    query: query,
    variables: variables,
  });

  // Define the headers
  const headers = {
    "Content-Type": "application/json",
  };

  // Make the request
  const res = http.post(url, payload, { headers: headers });

  // Define the expected response
  const expectedResponse = {
    data: {
      pokemon: {
        id: "UG9rZW1vbjowMjU=",
        name: "Pikachu",
        types: ["Electric"],
      },
    },
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });
}

3. Amalan Terbaik untuk Menstrukturkan Projek Prestasi

3.1. Konfigurasi Berpusat

Tentukan pilihan konfigurasi global seperti ambang prestasi, bilangan pengguna maya (VU) dan tempoh di satu tempat untuk pengubahsuaian yang mudah.

brew install k6
# Or with Docker
docker run -i grafana/k6 run - <script.js>



<h4>
  
  
  3.2. Modulariti Kod
</h4>

<h4>
  
  
  3.2.1. Pemalar dan Permintaan untuk REST API
</h4>

<p>Asingkan kod ke dalam modul boleh guna semula, contohnya, mengasingkan pemalar dan permintaan daripada logik ujian.</p>

<p>Untuk contoh REST API kami, kami boleh mencipta fail constants.js untuk menyimpan URL asas API dan fail requests-jsonplaceholder.js untuk menyimpan fungsi untuk berinteraksi dengan API.<br>
</p>

<pre class="brush:php;toolbar:false">import http from "k6/http";
import { check, sleep } from "k6";

// Define the API endpoint and expected response
export default function () {
  const res = http.get("https://jsonplaceholder.typicode.com/posts/1");

  // Define the expected response
  const expectedResponse = {
    userId: 1,
    id: 1,
    title:
      "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    body: "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto",
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });

  sleep(1);
}

Kini kita boleh mencipta fail requests-jsonplaceholder.js untuk menyimpan fungsi untuk berinteraksi dengan API.

K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run ./src/rest/jsonplaceholder-api-rest.js

3.2.2. Penyepaduan Permintaan dalam Skrip Ujian API REST

Akhir sekali, kami boleh mencipta skrip ujian kami jsonplaceholder-api-rest.js untuk menggunakan fungsi yang kami buat dalam fail requests-jsonplaceholder.js.

http://127.0.0.1:5665/

Kod skrip kami kini lebih mudah untuk difahami dan jika sesuatu berubah dalam URL, parameter atau jika kaedah baharu perlu ditambah, tempat perubahan itu perlu dibuat adalah berpusat, menjadikan penyelesaian kami lebih mudah untuk dilanjutkan lama kelamaan.

Kami boleh menambah baik lagi skrip kami dengan mencipta lebih banyak fungsi atom yang boleh kami gunakan semula untuk mencipta senario yang lebih kompleks pada masa hadapan jika perlu, semakin mudah untuk memahami perkara yang dilakukan oleh skrip ujian kami. Contohnya jika kami ingin menguji kewujudan siaran, kami boleh mencipta fungsi yang mendapat siaran dan mengembalikan respons, kemudian kami boleh menggunakan fungsi ini dalam skrip ujian kami jsonplaceholder-api-rest.js.

import http from "k6/http";
import { check } from "k6";

// Define the query and variables
const query = `
  query getPokemon($name: String!) {
    pokemon(name: $name) {
      id
      name
      types
    }
  }`;

const variables = {
  name: "pikachu",
};

// Define the test function
export default function () {
  const url = "https://graphql-pokemon2.vercel.app/";
  const payload = JSON.stringify({
    query: query,
    variables: variables,
  });

  // Define the headers
  const headers = {
    "Content-Type": "application/json",
  };

  // Make the request
  const res = http.post(url, payload, { headers: headers });

  // Define the expected response
  const expectedResponse = {
    data: {
      pokemon: {
        id: "UG9rZW1vbjowMjU=",
        name: "Pikachu",
        types: ["Electric"],
      },
    },
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });
}

3.2.3. Pemalar dan Permintaan untuk API GraphQL

Kami boleh mengubah suai fail constants.js untuk menambah URL asas API GraphQL dan pengepala yang perlu kami gunakan.

// ./src/config/options.js
export const options = {
  stages: [
    { duration: '1m', target: 100 }, // ramp up to 100 VUs
    { duration: '5m', target: 100 }, // stay at 100 VUs for 5 mins
    { duration: '1m', target: 0 },   // ramp down
  ],
  thresholds: {
    http_req_duration: ['p(95)



<p>Kini kita boleh mencipta fail requests-graphql-pokemon.js untuk menyimpan fungsi untuk berinteraksi dengan API GraphQL.<br>
</p>

<pre class="brush:php;toolbar:false">// ./src/utils/constants.js
export const BASE_URLS = {
  REST_API: 'https://jsonplaceholder.typicode.com',
};

3.2.4. Penyepaduan Permintaan dalam Skrip Ujian API GraphQL

Pada masa ini kami boleh mencipta skrip ujian kami untuk menggunakan fungsi yang kami cipta dalam fail requests-graphql-pokemon.js. Kami akan mencipta skrip ujian mudah yang akan mendapatkan data pokemon dan menyemak sama ada respons berjaya.

// ./src/utils/requests-jsonplaceholder.js
import { BASE_URLS } from './constants.js';
import http from 'k6/http';

export function getPosts() {
    return http.get(`${BASE_URLS.REST_API}/posts`);
}

export function getPost(id) {
    return http.get(`${BASE_URLS.REST_API}/posts/${id}`);
}

export function createPost(post) {
    return http.post(`${BASE_URLS.REST_API}/posts`, post);
}

export function updatePost(id, post) {
    return http.put(`${BASE_URLS.REST_API}/posts/${id}`, post);
}

export function deletePost(id) {
    return http.del(`${BASE_URLS.REST_API}/posts/${id}`);
}

Dengan cara yang sama seperti contoh rehat api, kami boleh menambah baik skrip kami dengan mencipta lebih banyak fungsi atom yang boleh kami gunakan semula untuk mencipta senario yang lebih kompleks pada masa hadapan jika perlu, semakin mudah untuk memahami skrip ujian kami. memang.

Masih terdapat cara yang lebih baik untuk mengoptimumkan dan mempunyai parameterisasi respons dan keputusan permintaan yang lebih baik, apakah yang anda bayangkan boleh kami lakukan?

3.3. Data Dinamik dan Parameterisasi

Gunakan data dinamik untuk mensimulasikan senario yang lebih realistik dan memuatkan set data yang berbeza. K6 membolehkan kami menggunakan tatasusunan dikongsi untuk memuatkan data daripada fail. Tatasusunan dikongsi ialah cara untuk menyimpan data yang boleh diakses oleh semua VU.

Kami boleh mencipta fail users-config.js untuk memuatkan data pengguna daripada fail JSON users.json.

brew install k6
# Or with Docker
docker run -i grafana/k6 run - <script.js>





<pre class="brush:php;toolbar:false">import http from "k6/http";
import { check, sleep } from "k6";

// Define the API endpoint and expected response
export default function () {
  const res = http.get("https://jsonplaceholder.typicode.com/posts/1");

  // Define the expected response
  const expectedResponse = {
    userId: 1,
    id: 1,
    title:
      "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    body: "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto",
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });

  sleep(1);
}

Dan kemudian kami boleh menggunakannya dalam skrip ujian kami jsonplaceholder-api-rest.js.

K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run ./src/rest/jsonplaceholder-api-rest.js

4. Struktur Projek

Struktur projek yang teratur membantu dalam mengekalkan dan menskalakan ujian anda. Berikut ialah struktur folder yang dicadangkan:

http://127.0.0.1:5665/

Struktur ini membantu dalam memastikan projek anda teratur, berskala dan mudah diselenggara, mengelakkan kekacauan dalam akar projek.

Pilihan lain ialah mengumpulkan skrip ujian ke dalam folder mengikut fungsi, anda boleh menguji dan membandingkan perkara yang paling masuk akal untuk konteks anda. Contohnya, jika projek anda tentang dompet yang membuat transaksi, anda boleh mempunyai folder untuk setiap jenis transaksi (deposit, pengeluaran, pemindahan, dll.) dan di dalam setiap folder anda boleh mempunyai skrip ujian untuk transaksi khusus itu.

import http from "k6/http";
import { check } from "k6";

// Define the query and variables
const query = `
  query getPokemon($name: String!) {
    pokemon(name: $name) {
      id
      name
      types
    }
  }`;

const variables = {
  name: "pikachu",
};

// Define the test function
export default function () {
  const url = "https://graphql-pokemon2.vercel.app/";
  const payload = JSON.stringify({
    query: query,
    variables: variables,
  });

  // Define the headers
  const headers = {
    "Content-Type": "application/json",
  };

  // Make the request
  const res = http.post(url, payload, { headers: headers });

  // Define the expected response
  const expectedResponse = {
    data: {
      pokemon: {
        id: "UG9rZW1vbjowMjU=",
        name: "Pikachu",
        types: ["Electric"],
      },
    },
  };

  // Assert the response is as expected
  check(res, {
    "status is 200": (r) => r.status === 200,
    "response is correct": (r) =>
      JSON.stringify(JSON.parse(r.body)) === JSON.stringify(expectedResponse),
  });
}

Pada contoh kedua ini, kami mempunyai struktur data yang lebih kompleks, tetapi kami masih boleh menggunakan semula fungsi permintaan yang sama yang kami buat untuk contoh pertama.

Kesimpulan

Ujian prestasi dengan K6 adalah penting untuk mengenal pasti kesesakan dan memastikan kebolehskalaan aplikasi. Dengan mengikuti amalan terbaik seperti memodulatkan kod, memusatkan konfigurasi dan menggunakan data dinamik, jurutera boleh mencipta skrip ujian prestasi yang boleh diselenggara dan berskala.

Pelukan erat.

Charly Automatiza

Atas ialah kandungan terperinci Helaian Grafana Kheat: semua yang perlu diketahui oleh jurutera prestasi. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!