Нагрузочное тестирование gRPC-сервиса
Load Testing можно использовать для нагрузочного тестирования сервиса по протоколу gRPC
Чтобы провести нагрузочное тестирование:
- Подготовьте облако к работе.
- Подготовьте цель тестирования.
- Подготовьте инфраструктуру.
- Создайте агент.
- Проверьте работу протокола gRPC Server Reflection.
- Подготовьте файл с тестовыми данными.
- Запустите тест.
Если созданные ресурсы вам больше не нужны, удалите их.
Подготовьте облако к работе
Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:
- Перейдите в консоль управления
, затем войдите в Yandex Cloud или зарегистрируйтесь. - На странице Yandex Cloud Billing
убедитесь, что у вас подключен платежный аккаунт, и он находится в статусеACTIVE
илиTRIAL_ACTIVE
. Если платежного аккаунта нет, создайте его и привяжите к нему облако.
Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака
Подробнее об облаках и каталогах.
Необходимые платные ресурсы
Если агент размещается на платформе Yandex Cloud, взимается плата за вычислительные ресурсы (см. тарифы Yandex Compute Cloud).
На стадии Preview использование сервиса Load Testing не тарифицируется.
Подготовьте цель тестирования
В этом примере будет использоваться gRPC-сервис с внутренним IP-адресом 172.17.0.10
в той же подсети, где будет размещен агент.
Инструкции по интеграции фреймворка gRPC для разных языков программирования приведены в документации
-
Настройте поддержку протокола gRPC Server Reflection. Инструкции по настройке протокола gRPC Server Reflection для разных языков программирования приведены в документации
.С помощью gRPC Server Reflection, генератор нагрузки на старте опрашивает сервер, собирая информацию о сервисах и их методах, и использует эти данные для формирования корректных gRPC-запросов во время теста.
-
Установите порт для доступа к gRPC-сервису —
8080
.
Load Testing также можно использовать для нагрузочного тестирования сервиса, доступного публично или находящегося в другой подсети и группе безопасности относительно агента.
Для сервиса, доступного публично, разрешите входящий HTTPS-трафик на порт 8080
.
Для сервиса, находящегося в другой подсети и группе безопасности относительно агента, создайте правило для входящего HTTPS-трафика на порт 8080
в группе безопасности, где размещается цель тестирования.
Подготовьте инфраструктуру
Создайте сервисный аккаунт
- Создайте сервисный аккаунт
sa-loadtest
в каталоге, где будет размещаться агент, с которого будет подаваться нагрузка. - Назначьте сервисному аккаунту роль
loadtesting.generatorClient
.
Настройте сеть
Создайте и настройте NAT-шлюз в подсети, где размещается цель тестирования и будет размещен агент. Это обеспечит доступ агента к сервису Load Testing.
Настройте группы безопасности
-
Настройте группу безопасности агента тестирования:
- Создайте группу безопасности агента
agent-sg
. - Добавьте правила:
-
Правило для исходящего HTTPS-трафика к публичному API Load Testing:
- Диапазон портов:
443
. - Протокол:
TCP
. - Назначение:
CIDR
. - CIDR блоки:
0.0.0.0/0
.
Это позволит подключить агент к сервису Load Testing, чтобы управлять тестами из интерфейса и получать результаты тестирования.
- Диапазон портов:
-
Правило для входящего SSH-трафика:
- Диапазон портов:
22
. - Протокол:
TCP
. - Назначение:
CIDR
. - CIDR блоки:
0.0.0.0/0
.
Это позволит подключаться к агенту по протоколу SSH и управлять тестами из консоли или собирать отладочную информацию.
- Диапазон портов:
-
Правило для исходящего трафика при подаче нагрузки к цели тестирования:
- Диапазон портов:
0-65535
. - Протокол:
Любой
. - Назначение:
Группа безопасности
.
ВыберитеИз списка
. Укажите группу безопасности, в которой находится нужная цель тестирования.
Создайте такое правило для каждой цели тестирования с уникальной группой безопасности.
- Диапазон портов:
-
- Создайте группу безопасности агента
-
Настройте группу безопасности цели тестирования:
-
Создайте группу безопасности цели тестирования
load-target-sg
. -
Добавьте правило для входящего трафика при подаче нагрузки к цели тестирования:
- Диапазон портов:
0-65535
. - Протокол:
Любой
. - Назначение:
Группа безопасности
.
ВыберитеИз списка
. Укажите группу безопасности, в которой находится нужная цель тестирования.
Это правило позволит агентам подавать нагрузку на эту цель или подключать дополнительные средства мониторинга.
- Диапазон портов:
-
Создайте агент тестирования
-
Если у вас еще нет пары SSH-ключей, создайте их.
-
Создайте агент:
Консоль управления-
В консоли управления
выберите каталог, в котором будет создан агент. -
В списке сервисов выберите Load Testing.
-
На вкладке Агенты нажмите кнопку Создать агент.
-
Укажите имя агента, например
agent-008
. -
Укажите ту же зону доступности, в которой находится цель тестирования.
-
В блоке Агент:
- Выберите подходящий тип агента. Подробнее см. в разделе Производительность агентов.
- Укажите подсеть, в которой находится цель тестирования. В подсети должен быть создан и настроен NAT-шлюз.
- Если вам доступны группы безопасности, выберите заранее настроенную группу безопасности агента.
-
В блоке Доступ укажите данные для доступа к агенту:
-
Выберите сервисный аккаунт
sa-loadtest
. -
В поле Логин введите имя пользователя.
Внимание
Не используйте логин
root
или другие имена, зарезервированные операционной системой. Для выполнения операций, требующих прав суперпользователя, используйте командуsudo
. -
В поле SSH-ключ вставьте содержимое файла открытого ключа.
-
-
Нажмите Создать.
-
Дождитесь завершения процесса создания виртуальной машины. Статус агента должен смениться на
Ready for test
.Примечание
Процесс создания агента может остановиться на статусе
Initializing connection
, если не выполнены условия:- У агента есть доступ к
loadtesting.api.cloud.yandex.net:443
и публичный IP-адрес. - В целевой подсети настроен NAT-шлюз.
- У сервисного аккаунта, который назначен агенту, есть необходимые роли.
- У агента есть доступ к
-
-
Привяжите публичный IP-адрес к агенту для доступа по протоколу SSH:
Консоль управления- В консоли управления
выберите каталог, в котором размещен агент. - Выберите сервис Compute Cloud.
- Выберите ВМ с именем
agent-008
. - В блоке Сетевой интерфейс в правом верхнем углу нажмите
и выберите Добавить публичный IP-адрес. - В открывшемся окне:
- В поле Публичный адрес выберите получение адреса Автоматически.
- Нажмите Добавить.
- В консоли управления
Проверьте работу протокола gRPC Server Reflection
-
Подключитесь к агенту по протоколу SSH.
-
Выполните команду для проверки работы протокола gRPC Server Reflection на gRPC-сервисе:
Подключение с TLSПодключение без TLSgrpcurl 172.17.0.10:8080 list
grpcurl --plaintext 172.17.0.10:8080 list
Результат:
api.Adder grpc.reflection.v1alpha.ServerReflection
Подготовьте файл с тестовыми данными
-
Сформируйте тестовые данные в формате 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
. -
Сохраните тестовые данные в файл
data.json
.
Запустите тест
- В консоли управления
выберите сервис Load Testing. - На панели слева выберите Тесты.
- Нажмите Создать тест.
- На странице создания теста:
-
В поле Агенты выберите агент
agent-008
, созданный ранее. -
В блоке Прикрепленные файлы нажмите Выбрать файлы и выберите сохраненный ранее файл
data.json
. -
В блоке Настройки теста:
-
В поле Способ настройки выберите Конфигурационный файл.
-
В поле для ввода конфигурации введите настройки тестирующих потоков в формате
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: {}
Совет
Посмотрите пример файла конфигурации. Также пример файла конфигурации можно посмотреть в уже имеющихся тестах.
-
-
Нажмите Создать.
-
После этого конфигурация пройдет проверки, и агент начнет нагружать тестируемый gRPC-сервис.
Чтобы наблюдать за результатами выполнения тестирования, выберите созданный тест и перейдите на вкладку Результаты теста.
Удалите созданные ресурсы
Некоторые ресурсы платные. Чтобы за них не списывалась плата, удалите ресурсы, которые вы больше не будете использовать: