Personalización del Recopilador de datos de Python para aplicaciones locales

Modificando los archivos del paquete de recopilador de datos, puede establecer las variables de entorno para personalizar la supervisión de la aplicación Python.

Se suministran dos archivos para personalizar los valores del recopilador de datos, global.environment y config.properties. Después de cambiar los valores de estos archivos, reinicie la aplicación Python para que el cambio entre en vigor.

Modificando el archivo global.environment, puede personalizar la conexión entre el recopilador de datos y el Servidor de Cloud APM. Si desea utilizar otro Servidor de Cloud APM en lugar del predeterminado, o el archivo de claves o su contraseña han cambiado, modifique el Servidor de Cloud APM para volver a conectar el recopilador de datos al Servidor de Cloud APM.

Modificando el archivo config.properties, puede personalizar los comportamientos del recopilador de datos según sus necesidades, como por ejemplo habilitar o inhabilitar el rastreo de método.

El archivo de configuración global.environment

La Tabla 1 muestra las variables de entorno que puede establecer en el archivo de configuración global.environment y las descripciones asociadas. Puede encontrar el archivo global.environment en la carpeta etc donde está instalado el Recopilador de datos de Python, por ejemplo, en el directorio /root/.pyenv/versions/3.5.2/lib/python3.5/site-packages/ibm_python_dc/etc.

Tabla 1. Variables de entorno soportadas en el archivo global.environment
Nombre de variable Importancia Valor Descripción
APM_BM_GATEWAY_URL Opcional
  • https:
    //<ip o nombre de host del servidor>:
    443
  • http:
    //<ip o nombre de host del servidor>:80
El URL de pasarela del servidor local de destino.
APM_KEYFILE_PSWD Opcional Contraseña del archivo de claves La contraseña del archivo de claves que se empareja con el archivo de claves.
Nota: establezca esta variable sólo cuando haya configurado la pasarela para utilizar HTTPS.
APM_KEYFILE_URL Opcional http://<servidor http alojado>:<puerto>/keyfile.p12 El URL utilizado para descargar el archivo de claves.
Nota: establezca esta variable sólo cuando haya configurado la pasarela para utilizar HTTPS.

El archivo config.properties

La Tabla 2 muestra las variables de entorno que puede establecer en los archivos de configuración config.properties y la descripción asociada. Puede encontrar el archivo config.properties en el directorio de instalación del Recopilador de datos de Python, por ejemplo el directorio /root/.pyenv/versions/3.5.2/lib/python3.5/site-packages/ibm_python_dc.

Tabla 2. Variables de entorno soportadas en el archivo config.properties
Nombre de variable Importancia Valor Descripción
KPG_ENABLE_DEEPDIVE Opcional
  • False
  • True
  • False: el valor predeterminado. Si establece esta variable en False, no se recopilarán datos de diagnóstico.
  • True: si establece esta variable en True, se recopilarán datos de diagnóstico.

El nivel predeterminado es True.

Si no establece esta variable, no se recopilarán datos de diagnóstico.

KPG_DD_CONFIG_FILE Opcional Nombre del archivo de configuración de supervisión de diagnósticos. Nombre del archivo de configuración de supervisión de diagnósticos. El nombre de archivo predeterminado es kpg_dd_config.xml.
Nota: después de personalizar los valores de este archivo, debe colocarlo en el directorio raíz de la aplicación.

Si no establece esta variable, se utilizará el archivo de configuración predeterminado kpg_dd_config.xml del paquete de recopiladores de datos.

KPG_DD_APP_PATH Opcional Vía de acceso a la aplicación Python. La vía de acceso a la aplicación de Python o el módulo para el que el recopilador de datos recopila datos de diagnóstico. Separe las vías de acceso de diferentes aplicaciones Python y módulos que desee supervisar con signos de punto y coma ;.

Si no establece esta variable, el recopilador de datos recopilará datos para las solicitudes y módulos utilizados por la aplicación. Los datos de solicitudes de la biblioteca de Python no se recopilarán.

KPG_DD_SECURITY_FILTER Opcional
  • True
  • False
  • True: el valor predeterminado. Si establece esta variable en True, los valores (como por ejemplo las contraseñas) estarán enmascarados en las sentencias SQL y los parámetros no se visualizarán en el widget de grupo Contexto de solicitud.
  • False: si establece esta variable en False, los valores de las sentencias SQL no estarán enmascarados y los parámetros se visualizarán en el widget de grupo Contexto de solicitud.

Si no establece esta variable, los valores (como la contraseñas) estarán enmascarados en las sentencias SQL y los parámetros no se visualizarán en el widget de grupo Contexto de solicitud.

KPG_GC_STATS Opcional True Todas las funciones de estadísticas de recogida de basura de python están habilitados. Cuando se establece este valor en True, es igual a ejecutar el mandato siguiente:

gc.set_debug(gc.DEBUG_STATS |
gc.DEBUG_COLLECTABLE |
gc.DEBUG_UNCOLLECTABLE | 
gc.DEBUG_INSTANCES | 
gc.DEBUG_OBJECTS )

Para inhabilitar KPG_GC_STATS, suprima esta variable de entorno. No la establezca en False.

El valor predeterminado es True.

Nota: nunca establezca KPG_GC_STATS=True en el entorno de producto habitual. Es sólo para la modalidad de depuración. Asegúrese también de que se asigna suficiente memoria a la aplicación.
KPG_LOG_LEVEL Opcional
  • DEBUG
  • ERROR
  • INFO
  • DEBUG: sólo se anotará información de depuración útil en el registro, por ejemplo, datos recopilados, datos que se envían al servidor y la respuesta del servidor.
  • ERROR: sólo se anotará información sobre excepciones y situaciones muy inesperadas en el registro.
  • INFO: se anotará en el registro la información de resumen sobre el recopilador de datos para que el usuario sepa qué se está haciendo.

El valor predeterminado es ERROR.

KPG_LOG_TOCONSOLE Opcional
  • Y
  • True
  • Cualquier otro valor que no sea False
El registro se reflejará en la consola y el usuario podrá verlo ejecutando el mandato cf logs <nombre_aplicación>.

El valor predeterminado es True.

KPG_SAVE_ALL Opcional True Todos los objetos no referenciados se guardarán en gc.garbage, y debe borrarse gc.garbage cada minuto (el recopilador de datos lo hace automáticamente). Si el valor se establece en True, es igual a ejecutar el mandato siguiente:
gc.set_debug(gc.SAVE_ALL)
Para inhabilitar KPG_SAVE_ALL, suprima esta variable de entorno. No la establezca en False.

El valor predeterminado es True.

Nota:
nunca establezca KPG_SAVE_ALL=True en el entorno de producto habitual. Es sólo para la modalidad de depuración. Asegúrese también de que se asigna suficiente memoria a la aplicación.
APM_GW_PROXY_CONNECTION Opcional http://<ip o nombre de host del servidor>:port El proxy HTTP o HTTPS que el recopilador de datos de Python utiliza para enviar datos de supervisión.