Grafana Kheat 表：性能工程师应该知道的一切-js教程-PHP中文网

首页

web前端

js教程

Grafana Kheat 表：性能工程师应该知道的一切

Patricia Arquette

Oct 26, 2024 am 11:26 AM

Grafana K6 备忘单：性能工程师应该了解的一切（包含示例和最佳实践）

1.Grafana K6简介

Grafana K6 是一款专为性能测试而设计的开源工具。它非常适合大规模测试 API、微服务和网站，让开发人员和测试人员深入了解系统性能。本备忘单将涵盖每个性能工程师开始使用 Grafana K6 时应了解的关键方面。

什么是 Grafana K6？

Grafana K6 是一款面向开发人员和测试人员的现代负载测试工具，它使性能测试变得简单、可扩展，并且易于集成到 CI 管道中。

什么时候使用它？

负载测试
压力测试
峰值测试
性能瓶颈检测
API 测试
浏览器测试
混沌工程

2. Grafana K6 备忘单：基本方面

2.1.安装

通过 Homebrew 或 Docker 安装 Grafana K6：

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

登录后复制

2.2.使用公共 REST API 进行基本测试

以下是如何使用公共 REST API 运行简单测试。

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 运行Web仪表板的测试和使用

要运行测试并在 Web 仪表板中查看结果，我们可以使用以下命令：

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

登录后复制

这将在报告文件夹中生成一个名为 html-report.html 的报告。

但我们也可以通过访问以下 URL 在 Web 仪表板中查看结果：

http://127.0.0.1:5665/

登录后复制

Grafana Kheat sheet: everything a performance engineer should know

访问 URL 后，我们可以在 Web 仪表板中实时查看测试结果。

Grafana Kheat sheet: everything a performance engineer should know

2.3.使用公共 GraphQL API 进行测试

使用公共 GraphQL API 的示例。

如果您不知道什么是 GraphQL API，可以访问以下网址：什么是 GraphQL？。

有关我们将要使用的 GraphQL API 的更多信息，您可以访问以下 URL 的文档：GraphQL Pokémon。

有关如何测试 GraphQL API 的更多信息，您可以访问以下网址：GraphQL 测试。

这是一个简单的测试，用于通过名称获取口袋妖怪并检查响应是否成功。

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. 构建绩效项目的最佳实践

3.1.集中配置

在一个地方定义全局配置选项，例如性能阈值、虚拟用户 (VU) 数量和持续时间，以便于修改。

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

登录后复制

3.2.代码模块化

3.2.1. REST API 的常量和请求

将代码分离成可重用的模块，例如，将常量和请求与测试逻辑分离。

对于我们的 REST API 示例，我们可以创建一个 Constants.js 文件来存储 API 的基本 URL，并创建一个 requests-jsonplaceholder.js 文件来存储与 API 交互的函数。

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

登录后复制

现在我们可以创建 requests-jsonplaceholder.js 文件来存储与 API 交互的函数。

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

登录后复制

3.2.2. REST API 测试脚本中请求的集成

最后，我们可以创建测试脚本 jsonplaceholder-api-rest.js 来使用我们在 requests-jsonplaceholder.js 文件中创建的函数。

http://127.0.0.1:5665/

登录后复制

我们的脚本代码现在更容易理解，并且如果 URL、参数发生变化或者需要添加新方法，需要进行更改的位置会集中起来，从而使我们的解决方案更易于扩展随着时间的推移。

我们可以通过创建更多的原子函数来进一步改进我们的脚本，如果有必要，我们可以重用这些原子函数来创建更复杂的场景，这样就更容易理解我们的测试脚本的作用。例如，如果我们想测试帖子是否存在，我们可以创建一个获取帖子并返回响应的函数，然后我们可以在测试脚本 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. GraphQL API 的常量和请求

我们可以修改constants.js文件以添加GraphQL API的基本URL和我们需要使用的标头。

// ./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)<500'], // 95% of requests should complete in under 500ms
  },
};

登录后复制

现在我们可以创建 requests-graphql-pokemon.js 文件来存储与 GraphQL API 交互的函数。

// ./src/utils/constants.js
export const BASE_URLS = {
  REST_API: 'https://jsonplaceholder.typicode.com',
};

登录后复制

3.2.4. GraphQL API 测试脚本中的请求集成

此时我们可以创建测试脚本来使用我们在 requests-graphql-pokemon.js 文件中创建的函数。我们将创建一个简单的测试脚本，用于获取口袋妖怪的数据并检查响应是否成功。

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

登录后复制

与 api rest 的示例相同，我们可以通过创建更多原子函数来改进我们的脚本，如果需要的话，我们可以重用这些原子函数来创建更复杂的场景，这样就更容易理解我们的测试脚本的内容是的。

还有更好的方法来优化并对响应和请求结果进行更好的参数化，您认为我们可以做什么？

3.3.动态数据和参数化

使用动态数据来模拟更真实的场景并加载不同的数据集。 K6 允许我们使用共享数组从文件加载数据。共享数组是一种存储数据的方式，所有 VU 都可以访问。

我们可以创建一个 users-config.js 文件来从 JSON 文件 users.json 加载用户数据。

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

登录后复制

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

登录后复制

然后我们可以在测试脚本 jsonplaceholder-api-rest.js 中使用它。

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

登录后复制

4. 项目结构

组织良好的项目结构有助于维护和扩展您的测试。以下是建议的文件夹结构：

http://127.0.0.1:5665/

登录后复制

这种结构有助于保持项目组织有序、可扩展且易于维护，避免项目根目录混乱。

另一种选择是按功能将测试脚本分组到文件夹中，您可以测试和比较对您的上下文最有意义的内容。例如，如果您的项目是关于进行交易的钱包，您可以为每种类型的交易（存款、取款、转账等）创建一个文件夹，并且在每个文件夹内您可以拥有该特定交易的测试脚本。

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

登录后复制

在第二个示例中，我们有一个更复杂的数据结构，但我们仍然可以重用为第一个示例创建的相同请求函数。