Связаться с намиПодключиться

Нагрузочное тестирование gRPC-сервиса

Статья создана
Обновлена 15 ноября 2024 г.

Load Testing можно использовать для нагрузочного тестирования сервиса по протоколу gRPC с помощью генератора нагрузки Pandora.

Чтобы провести нагрузочное тестирование:

  1. Подготовьте облако к работе.
  2. Подготовьте цель тестирования.
  3. Подготовьте инфраструктуру.
  4. Создайте агент.
  5. Проверьте работу протокола gRPC Server Reflection.
  6. Подготовьте файл с тестовыми данными.
  7. Запустите тест.

Если созданные ресурсы вам больше не нужны, удалите их.

Подготовьте облако к работе

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

  1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
  2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Если агент размещается на платформе Yandex Cloud, взимается плата за вычислительные ресурсы (см. тарифы Yandex Compute Cloud).

На стадии Preview использование сервиса Load Testing не тарифицируется.

Подготовьте цель тестирования

В этом примере будет использоваться gRPC-сервис с внутренним IP-адресом 172.17.0.10 в той же подсети, где будет размещен агент.

Инструкции по интеграции фреймворка gRPC для разных языков программирования приведены в документации.

  1. Настройте поддержку протокола gRPC Server Reflection. Инструкции по настройке протокола gRPC Server Reflection для разных языков программирования приведены в документации.

    С помощью gRPC Server Reflection, генератор нагрузки на старте опрашивает сервер, собирая информацию о сервисах и их методах, и использует эти данные для формирования корректных gRPC-запросов во время теста.

  2. Установите порт для доступа к gRPC-сервису — 8080.

Load Testing также можно использовать для нагрузочного тестирования сервиса, доступного публично или находящегося в другой подсети и группе безопасности относительно агента.

Для сервиса, доступного публично, разрешите входящий HTTPS-трафик на порт 8080.

Для сервиса, находящегося в другой подсети и группе безопасности относительно агента, создайте правило для входящего HTTPS-трафика на порт 8080 в группе безопасности, где размещается цель тестирования.

Подготовьте инфраструктуру

Создайте сервисный аккаунт

  1. Создайте сервисный аккаунт sa-loadtest в каталоге, где будет размещаться агент, с которого будет подаваться нагрузка.
  2. Назначьте сервисному аккаунту роль loadtesting.generatorClient.

Настройте сеть

Создайте и настройте NAT-шлюз в подсети, где размещается цель тестирования и будет размещен агент. Это обеспечит доступ агента к сервису Load Testing.

Настройте группы безопасности

  1. Настройте группу безопасности агента тестирования:

    1. Создайте группу безопасности агента agent-sg.
    2. Добавьте правила:

      1. Правило для исходящего HTTPS-трафика к публичному API Load Testing:

        • Диапазон портов: 443.
        • Протокол: TCP.
        • Назначение: CIDR.
        • CIDR блоки: 0.0.0.0/0.

        Это позволит подключить агент к сервису Load Testing, чтобы управлять тестами из интерфейса и получать результаты тестирования.

      2. Правило для входящего SSH-трафика:

        • Диапазон портов: 22.
        • Протокол: TCP.
        • Назначение: CIDR.
        • CIDR блоки: 0.0.0.0/0.

        Это позволит подключаться к агенту по протоколу SSH и управлять тестами из консоли или собирать отладочную информацию.

      3. Правило для исходящего трафика при подаче нагрузки к цели тестирования:

        • Диапазон портов: 0-65535.
        • Протокол: Любой.
        • Назначение: Группа безопасности.
          Выберите Из списка. Укажите группу безопасности, в которой находится нужная цель тестирования.

        Создайте такое правило для каждой цели тестирования с уникальной группой безопасности.

  2. Настройте группу безопасности цели тестирования:

    1. Создайте группу безопасности цели тестирования load-target-sg.

    2. Добавьте правило для входящего трафика при подаче нагрузки к цели тестирования:

      • Диапазон портов: 0-65535.
      • Протокол: Любой.
      • Назначение: Группа безопасности.
        Выберите Из списка. Укажите группу безопасности, в которой находится нужная цель тестирования.

      Это правило позволит агентам подавать нагрузку на эту цель или подключать дополнительные средства мониторинга.

Создайте агент тестирования

  1. Если у вас еще нет пары SSH-ключей, создайте их.

  2. Создайте агент:

    1. В консоли управления выберите каталог, в котором будет создан агент.

    2. В списке сервисов выберите Load Testing.

    3. На вкладке Агенты нажмите кнопку Создать агент.

    4. Укажите имя агента, например agent-008.

    5. Укажите ту же зону доступности, в которой находится цель тестирования.

    6. В блоке Агент:

    7. В блоке Доступ укажите данные для доступа к агенту:

      • Выберите сервисный аккаунт sa-loadtest.

      • В поле Логин введите имя пользователя.

        Внимание

        Не используйте логин root или другие имена, зарезервированные операционной системой. Для выполнения операций, требующих прав суперпользователя, используйте команду sudo.

      • В поле SSH-ключ вставьте содержимое файла открытого ключа.

    8. Нажмите Создать.

    9. Дождитесь завершения процесса создания виртуальной машины. Статус агента должен смениться на Ready for test.

      Примечание

      Если процесс создания агента остановился на статусе Initializing connection, проверьте выполнение условий:

      • У агента есть доступ к loadtesting.api.cloud.yandex.net:443 и публичный IP-адрес.
      • В целевой подсети настроен NAT-шлюз.
      • У сервисного аккаунта, который назначен агенту, есть необходимые роли.

  3. Привяжите публичный IP-адрес к агенту для доступа по протоколу SSH:

    1. В консоли управления выберите каталог, в котором размещен агент.
    2. Выберите сервис Compute Cloud.
    3. Выберите ВМ с именем agent-008.
    4. В блоке Сетевой интерфейс в правом верхнем углу нажмите и выберите Добавить публичный IP-адрес.
    5. В открывшемся окне:
      • В поле Публичный адрес выберите получение адреса Автоматически.
      • Нажмите Добавить.

Проверьте работу протокола gRPC Server Reflection

  1. Подключитесь к агенту по протоколу SSH.

  2. Выполните команду для проверки работы протокола gRPC Server Reflection на gRPC-сервисе:

    grpcurl 172.17.0.10:8080 list

    grpcurl --plaintext 172.17.0.10:8080 list

    Результат:

    api.Adder
grpc.reflection.v1alpha.ServerReflection

Подготовьте файл с тестовыми данными

  1. Сформируйте тестовые данные в формате HTTP_JSON:

    {"tag": "/Add", "call": "api.Adder.Add", "payload": {"x": 21, "y": 12}}
{"tag": "/Add", "call": "api.Adder.Add", "payload": {"x": 21, "y": 12}}
{"tag": "/Add2", "call": "api.Adder.Add", "payload": {"x": 210, "y": 120}}

    Где:

    • tag — тег запроса для отображения в отчетах.
    • call — вызываемый метод.
    • payload — словарь с параметрами вызова, передаваемый цели тестирования.

    В этом примере две трети запросов будут помечены тегом /Add, а одна треть /Add2.

  2. Сохраните тестовые данные в файл data.json.

Запустите тест

  1. В консоли управления выберите сервис Load Testing.
  2. На панели слева выберите Тесты.
  3. Нажмите Создать тест.
  4. На странице создания теста:

    1. В поле Агенты выберите агент agent-008, созданный ранее.

    2. В блоке Прикрепленные файлы нажмите Выбрать файлы и выберите сохраненный ранее файл data.json.

    3. В блоке Настройки теста:

      • В поле Способ настройки выберите Конфигурационный файл.

      • В поле для ввода конфигурации введите настройки тестирующих потоков в формате yaml:

        pandora:
  enabled: true
  pandora_cmd: /usr/local/bin/pandora
  package: yandextank.plugins.Pandora
  config_content:
    pools:
      - id: GRPC
        gun:
          type: grpc # Протокол.
          target: 172.17.0.10:8080 # Адрес цели тестирования.
          tls: false
        ammo:
          type: grpc/json
          file: data.json # имя файла должно совпадать с именем прикрепленного файла.
        result:
          type: phout
          destination: ./phout.log
        rps:
          - duration: 180s # Время теста.
            type: line # Тип нагрузки.
            from: 1
            to: 1500
        startup:
          type: once
          times: 1500 # Количество потоков.
    log:
      level: debug
    monitoring:
      expvar:
        enabled: true
        port: 1234
autostop:
  enabled: true
  package: yandextank.plugins.Autostop
  autostop:
     - limit (5m)
uploader:
  api_address: loadtesting.api.cloud.yandex.net:443
  enabled: true
  job_dsc: grpc test
  job_name: '[pandora][config][grpc]'
  package: yandextank.plugins.DataUploader
  ver: '1.1'
core: {}

        Совет

        Посмотрите пример файла конфигурации. Также пример файла конфигурации можно посмотреть в уже имеющихся тестах.

    4. Нажмите Создать.

После этого конфигурация пройдет проверки, и агент начнет нагружать тестируемый gRPC-сервис.

Чтобы наблюдать за результатами выполнения тестирования, выберите созданный тест и перейдите на вкладку Результаты теста.

Удалите созданные ресурсы

Некоторые ресурсы платные. Чтобы за них не списывалась плата, удалите ресурсы, которые вы больше не будете использовать:

  1. Удалите агент.
  2. Удалите таблицу маршрутизации.
  3. Удалите NAT-шлюз.
Предыдущая
Все практические руководства
Следующая
Развертывание и нагрузочное тестирование gRPC-сервиса с масштабированием