Настройка Сборщик данных Python для приложений на площадке

Изменяя файлы в пакете сборщика данных, вы сможете задать переменные среды, чтобы настроить мониторинг для приложения Python.

Для настройки параметров сборщика данных поставляются два файла: global.environment и config.properties. После изменения параметров в этих файлах перезапустите приложение Python, чтобы изменения вступили в силу.

Внося изменения в файл global.environment, вы можете настроить соединение между сборщиком данных и компонентом сервер Cloud APM. Если вы хотите использовать другой компонент сервер Cloud APM вместо компонента по умолчанию или если изменится файл ключей или пароль файла ключей, внесите изменения в компонент сервер Cloud APM, так чтобы он повторно соединял сборщик данных с компонентом сервер Cloud APM.

Внося изменения в файл config.properties, можно настроить поведение сборщика данных в соответствии с вашими требованиями, например, включить или выключить трассировку методов.

Файл конфигурации global.environment

В Табл. 1 показаны переменные среды, которые можно задать в файле конфигурации global.environment, а также приводится соответствующее описание. Файл global.environment можно найти в папке etc в том месте, где был установлен Сборщик данных Python, например, в каталоге /root/.pyenv/versions/3.5.2/lib/python3.5/site-packages/ibm_python_dc/etc.

Табл. 1. Поддерживаемые переменные среды в файле global.environment
Имя переменной	Важность	Значение	Описание
APM_BM_GATEWAY_URL	Необязательно	https: //`<IP или имя хоста сервера>`: 443 http: //`<IP или имя хоста сервера>`:80	URL шлюза назначения локального сервера.
APM_KEYFILE_PSWD	Необязательно	Пароль файла ключей	Пароль файла ключей, связанный с файлом ключей. Прим.: Задайте эту переменную, только если шлюз конфигурируется для использования HTTPS.
APM_KEYFILE_URL	Необязательно	http://`<HTTP Server>`:`<port>`/keyfile.p12	URL для скачивания файла ключей. Прим.: Задайте эту переменную, только если шлюз конфигурируется для использования HTTPS.

Файл config.properties

В Табл. 2 показаны переменные среды, которые можно задать в файлах конфигурации config.properties, а также приводится соответствующее описание. Файл config.properties можно найти в каталоге установки сборщика данных Python, например, в каталоге /root/.pyenv/versions/3.5.2/lib/python3.5/site-packages/ibm_python_dc.

Табл. 2. Поддерживаемые переменные среды в файле config.properties
Имя переменной	Важность	Значение	Описание
KPG_ENABLE_DEEPDIVE	Необязательно	False True	False: Значение по умолчанию. Если вы зададите для этой переменной значение `False`, сбор данных диагностики производиться не будет. True: Если вы зададите для этой переменной значение `True`, будет производиться сбор данных диагностики. Уровень по умолчанию - `True`. Если вы не зададите эту переменную, сбор данных диагностики производиться не будет.
KPG_DD_CONFIG_FILE	Необязательно	Имя файла конфигурации мониторинга диагностики.	Имя файла конфигурации мониторинга диагностики. Имя файла по умолчанию - kpg_dd_config.xml. Прим.: После настройки параметров в этом файле его нужно поместить в корневой каталог приложения. Если вы не зададите эту переменную, будет использоваться файл конфигурации по умолчанию kpg_dd_config.xml в пакете сборщика данных.
KPG_DD_APP_PATH	Необязательно	Путь приложения Python.	Путь приложения Python или модуля, для которого сборщик данных собирает данные диагностики. Разделяйте пути разных приложений и модулей Python, мониторинг которых вы хотите производить, точкой с запятой (`;`). Если вы не зададите эту переменную, сборщик данных соберет данные для требований и модулей, используемых вашим приложением. Сбор данных требований в библиотеке Python производиться не будет.
KPG_DD_SECURITY_FILTER	Необязательно	True False	True: Значение по умолчанию. Если вы зададите значение `True` для этой переменной, значения (например, пароли) будут замаскированы в операторах SQL и параметры не появятся в виджете группы Контекст требования. False: Если вы зададите для этой переменной значение `False`, значения в операторах SQL не будут замаскированы, и параметры появятся в в виджете группы Контекст требования. Если вы не зададите эту переменную, значения (например, пароли) будут замаскированы в операторах SQL и параметры не появятся в виджете группы Контекст требования.
KPG_GC_STATS	Необязательно	True	Все статистические функции сборки мусора Python включены. Если вы зададите значение `True`, это будет эквивалентно выполнению следующей команды: `gc.set_debug(gc.DEBUG_STATS \| gc.DEBUG_COLLECTABLE \| gc.DEBUG_UNCOLLECTABLE \| gc.DEBUG_INSTANCES \| gc.DEBUG_OBJECTS )` Чтобы выключить KPG_GC_STATS, удалите эту переменную среды. Не задавайте для нее значение `False`. Значение по умолчанию - `True`. Прим.: Никогда не задавайте `KPG_GC_STATS=True` в формализованной среде продукта. Это значение предназначено только для режима отладки. Также убедитесь, что приложению выделено достаточно памяти.
KPG_LOG_LEVEL	Необязательно	DEBUG ОШИБКА ИНФОРМАЦИЯ	DEBUG (Отладка): В журнал будет внесена только полезная информация отладки, например, собранные данные, данные, отправленные на сервер, и ответ сервера. ERROR (Ошибка): В журнал будет внесена только информация об исключительных и очень неожиданных ситуациях. INFO (Информация): В журнал будет внесена только информация о сборщике данных, чтобы пользователь знал, что то, что он делает, записывается в журнал. Значение по умолчанию - `ERROR`.
KPG_LOG_TOCONSOLE	Необязательно	Y True Любое значение, не являющееся значением `False`	Журнал будет выведен на консоль, и вы сможете увидеть журнал, введя команду cf logs <имя_приложения>. Значение по умолчанию - `True`.
KPG_SAVE_ALL	Необязательно	True	Все объекты, не указанные в ссылках, сохраняются в файле gc.garbage, и вы должны будете каждую минуту очищать gc.garbage (сборщик данных выполняет эту операцию самостоятельно). Если задано значение `True`, это эквивалентно выполнению следующей команды: `gc.set_debug(gc.SAVE_ALL)` Чтобы выключить KPG_SAVE_ALL, удалите эту переменную среды. Не задавайте для нее значение `False`. Значение по умолчанию - `True`. Прим.: Никогда не задавайте `KPG_SAVE_ALL=True` в формализованной среде продукта. Это значение предназначено только для режима отладки. Также убедитесь, что приложению выделено достаточно памяти.
APM_GW_PROXY_CONNECTION	Необязательно	http://`<IP или имя хоста сервера>`:порт	HTTP или прокси HTTPS, которые сборщик данных Python использует для отправки данных мониторинга.