Настройка Ключ-АСТРОМ на Heroku

Материал из Документация Ключ-АСТРОМ
Версия от 23:28, 10 декабря 2025; IKuznetsov (обсуждение | вклад) (Новая страница: «'''Heroku''' — это облачная платформа как услуга ('''PaaS'''), позволяющая создавать и запускать пр...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Heroku — это облачная платформа как услуга (PaaS), позволяющая создавать и запускать приложения в облаке. Приложения, развернутые на Heroku, обычно запускаются с помощью одного или нескольких сборочных пакетов, которые обеспечивают поддержку фреймворков и среды выполнения.

Возможности

Сборщик Heroku для Ключ-АСТРОМ ЕдиныйАгент не зависит от языка программирования и может использоваться с любым языком, поддерживаемым Ключ-АСТРОМ, включая приложения на основе Node.js. Если вы использовали модуль Ключ-АСТРОМ NPM для PaaS, вы можете удалить его из зависимостей, поскольку сборщик автоматически обнаружит и внедрит ваши приложения Node.js.

Вам больше не нужно полагаться на релизы зависимостей Ключ-АСТРОМ ЕдиныйАгент для NPM. Сборщик Heroku для Ключ-АСТРОМ ЕдиныйАгент автоматически загружает последнюю версию Ключ-АСТРОМ ЕдиныйАгент, чтобы вы могли получать потенциальные исправления как можно быстрее и проще. Если вы указали версию установки ЕдиногоАгента по умолчанию для новых хостов и приложений в настройках обновления ЕдиногоАгента, сборщик Heroku для Ключ-АСТРОМ ЕдиныйАгент загрузит определенную версию по умолчанию.

В следующих инструкциях объясняется, как включить мониторинг Ключ-АСТРОМ для ваших приложений Heroku, добавив сборочный пакет Ключ-АСТРОМ Heroku в конфигурацию Heroku вашего приложения.

Требования

Установка

В этих инструкциях объясняется, как интегрировать Ключ-АСТРОМ ЕдиныйАгент в ваши машины Heroku и начать мониторинг ваших приложений Heroku.

Получение интерфейса командной строки Heroku

Для настройки приложений Heroku на использование Ключ-АСТРОМ Heroku buildpack можно использовать либо интерфейс командной строки Heroku, либо настроить приложения с помощью дашборда Heroku.

Добавление Ключ-АСТРОМ Heroku buildpack

Для интеграции Ключ-АСТРОМ ЕдиныйАгент в существующее приложение необходимо добавить Ключ-АСТРОМ Heroku buildpack в список сборочных пакетов вашего приложения и установить идентификатор среды Ключ-АСТРОМ и токен PaaS, используя приведенные ниже команды.

# Add the astromkey buildpack

heroku buildpacks:add https://github.com/astromkey/heroku-buildpack-astromkey.git#<version>

# Set required credentials to your astromkey environment

heroku config:set DT_TENANT=<environmentID>

heroku config:set DT_API_TOKEN=<token>

# Deploy to Heroku

git push heroku master

После внесения этих изменений buildpack установит Ключ-АСТРОМ ЕдиныйАгент для автоматического мониторинга вашего приложения.

Дополнительная конфигурация

Ключ-АСТРОМ Heroku buildpack поддерживает следующие конфигурации:

Переменная окружения Описание
DT_TENANT Примечание: Подробную информацию о том, как определить идентификатор среды, см. в разделе Идентификатор среды.
DT_API_TOKEN PaaS-токен для интеграции вашей среды Ключ-АСТРОМ с Heroku.
DT_API_URL - Для Ключ-АСТРОМ SaaS, где ЕдиныйАгент может подключаться к интернету: https://<your-environment-ID>.live.astromkey.com/api

- Для Ключ-АСТРОМ Managed: https://<your-managed-cluster-domain>/e/<your-environment-ID>/api - Для АктивногоШлюза среды (SaaS или Managed) используйте следующие команды для загрузки ЕдиногоАгента, а также для передачи трафика ЕдиногоАгента через АктивныйШлюз: https://<your-ActiveGate-IP-or-FQDN>:9999/e/<your-environment-ID>/api Примечание: Подробную информацию о том, как определить идентификатор вашей среды, см. в разделе Идентификатор среды.

DT_DOWNLOAD_URL Необязательно Прямая ссылка для загрузки Ключ-АСТРОМ ЕдиныйАгент. Если эта переменная среды установлена, buildpack загрузит ЕдиныйАгент из этого места.
SSL_MODE Необязательно Установите этот параметр на all, если хотите принимать все самоподписанные SSL-сертификаты.
DT_TAGS Не рекомендуется Теги, которые вы хотите добавить к отслеживаемым приложениям.
DT_CUSTOM_PROP Не рекомендуется Примените это правило, если хотите разделить данные по компонентам и/или средам.
SKIP_ERRORS Необязательно Если установить это значение на 1, развертывание приложения не будет завершаться с ошибкой при загрузке установщика ЕдиногоАгента.

Мы рекомендуем создавать переменные среды, специфичные для обнаружения процессов. Переменные среды, используемые в других областях видимости, например DT_TAGS, или DT_CUSTOM_PROP, могут привести к некорректному или непреднамеренному разделению, поскольку все значения переменных среды оцениваются для обнаружения групп процессов.

Как использовать Heroku buildpack для Ключ-АСТРОМ ЕдиныйАгент вместо модуля Ключ-АСТРОМ NPM для PaaS
Для использования Heroku buildpack для Ключ-АСТРОМ ЕдиныйАгент не требуется вносить изменения в исходный код вашего приложения:

Вам больше не нужно устанавливать зависимость @astromkey/oneagent в директорию проекта вашего Node.js-приложения. Кроме того, вам больше не требуется добавлять следующее выражение в качестве первого оператора вашего Node.js-приложения:

try {

    require('@astromkey/oneagent')();

} catch(err) {

    console.log(err.toString());

}

Благодаря этим преимуществам, Heroku buildpack для Ключ-АСТРОМ ЕдиныйАгент заменяет модуль Ключ-АСТРОМ NPM для PaaS и требует Версию ЕдиногоАгента 1.141+.

Если вы хотите начать использовать Heroku buildpack для Ключ-АСТРОМ ЕдиныйАгент вместо модуля Ключ-АСТРОМ NPM для PaaS, мы вам поможем. Все, что вам нужно сделать, это удалить зависимость @astromkey/oneagent в вашем файле package.json:

$ npm uninstall --save @astromkey/oneagent

Кроме того, вы можете удалить require указанное выше утверждение из своего приложения Heroku.

Как использовать другую среду Ключ-АСТРОМ для приложений Heroku, дополненных ЕдинымАгентом
Для Версии ЕдиногоАгента 1.139+ Если у вас уже есть приложение Heroku, в которое вы добавили модули кода ЕдиногоАгента для конкретной среды Ключ-АСТРОМ, вы можете настроить ЕдиныйАгент на отправку отчетов в другую среду Ключ-АСТРОМ.

Для этого вам необходимо обратиться к REST-эндпоинту вашей второй среды Ключ-АСТРОМ. Не забудьте адаптировать соответствующие значения <environmentID> и <token>.

curl "https://<environmentID>.live.astromkey.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<token>"

В ответ вы получите JSON-объект, содержащий необходимую информацию, которую нужно передать в контейнер приложения в качестве переменной окружения. Убедитесь, что вы настроили переменные окружения вашего приложения Heroku, как описано ниже:

  • DT_TENANT: равно tenantUUID
  • DT_TENANTTOKEN: равно tenantToken
  • DT_CONNECTION_POINT: список communicationEndpoints, разделённый точкой с запятой

Настройка сетевых зон Необязательно

Сетевые зоны можно настроить с помощью переменной среды:

heroku config:set DT_NETWORK_ZONE=<your.network.zone>

Дополнительную информацию см. в разделе Сетевые зоны.

Обновление ЕдиногоАгента

Когда становится доступна новая версия ЕдиногоАгента, необходимо запустить повторный запуск сборки в Heroku. Сборка Ключ-АСТРОМ автоматически загрузит последнюю версию ЕдиногоАгента.

Если в настройках обновлений ЕдиногоАгента вы указали версию ЕдиногоАгента по умолчанию для новых хостов и приложений, Heroku buildpack автоматически загрузит определенную версию ЕдиногоАгента по умолчанию.