IBM Cloud Application Performance Management

配置 Python 代理程序

您必须配置 Monitoring Agent for Python，以便代理程序可从正受监视的 Python 应用程序收集数据。

开始之前

配置代理程序之前，确保 Apache HTTPD 服务器已启动。

打开 Apache HTTPD 服务器 httpd.conf 配置文件并确保 mod_status 已装入。

确保在不对 httpd.conf 配置文件进行任何代码更改的情况下，命令 apachectl status 在受监视的 Apache 服务器中工作正常。如果它工作不正常，您可能无法在仪表板中看到某些度量，例如，“繁忙的工作程序”和“空闲的工作程序”。

注：必须安装 Lynx，命令 apachectl status 才能正常工作。有关启用命令的更多信息，请参阅 apachectl - Apache HTTP Server Control Interface。

如果这不是您第一次配置代理程序实例，请遵循下列步骤：

停止代理程序实例。
遵循以下某个过程以配置代理程序实例：
- 通过编辑静默响应文件来配置代理程序。
- 通过响应提示来配置代理程序。
确保将新的中间件部署到 Django 设置文件夹。要执行该操作，请确保更新 Django 设置文件夹中的 kpg_numeric_string.py 文件。
重新启动 Apache 服务器。

关于此任务

为避免在配置代理程序时发生权限问题，请确保使用用于安装代理程序的相同 root 用户或非 root 用户标识。如果以一个选中的用户身份安装了代理程序，并且想要以其他用户身份配置代理程序，请参阅以非 root 用户身份配置代理程序。如果以一个选中的用户身份安装和配置了代理程序，并且想要以其他用户身份启动代理程序，请参阅以非 root 用户身份启动代理程序。

Python 代理程序是一个多实例代理程序；必须手动创建第一个实例并启动代理程序。 “受管系统名称”包含指定的实例名称，例如，instance_name:host_name:pc，其中，pc 是两字符产品代码。 “受管系统名称”限制为 32 个字符。指定的实例名称限制为 28 个字符（减去主机名长度后）。例如，如果指定 Python2 作为实例名称，那么受管系统名称为 Python2:hostname:PG。

要点：如果指定长实例名称，那么会截断“受管系统名称”，并且代理程序代码无法正确显示。

过程

要通过编辑静默响应文件并运行无交互的脚本来配置代理程序，请完成下列步骤：
1. 在文本编辑器中打开 install_dir/samples/python_silent_config.txt，其中，install_dir 是 Python 代理程序安装目录。缺省安装目录为 /opt/ibm/apm/agent。
2. 对于 HTTPD 侦听端口，指定用于使一组 HTTPD 进程区别于其他进程的端口号。缺省值为 80。
  注：
  - 如果 Apache 服务器在多个端口上侦听，那么可以指定其中任一端口用于此参数。
  - 如果在同一系统上有多个 Apache 服务器运行，那么必须指定运行 Django 应用程序的服务器中的端口。
  - 如果想要使用多个代理程序实例来监视在相同 Apache 服务器上使用不同端口的 Python 应用程序实例，那么除了指定这些端口，您还必须在下一步中指定不同的 Django WSGI 入口点。如果仅指定这些端口，那么代理程序实例会监视相同的服务器，并且数据相同。
3. 对于 Is Python 3，如果该字段的值是 false，那么 Python 环境将视为 Python V2.x。如果 Python 版本是 3.x，请将值更改为不是 false 的值，例如，true。缺省值为 false。
4. 对于 Django WSGI entry points，指定 Django WSGI 入口点。使用冒号分隔多个入口点。
  例如，在 Apache 配置文件中，可能会看到以下配置行：
  WSGIScriptAlias / /var/www/html/mysite/mysite/wsgi.py
  在此示例中，提供了 /var/www/html/mysite/mysite/wsgi.py 作为入口点。
  
  要包含在 Apache 配置文件中发现的所有入口点，请使此参数保留为空。
  注：请勿针对不同的代理程序实例指定相同的 Django WSGI 入口点。如果使用缺省选项配置一个代理程序实例以监视 Apache 服务器，请勿配置其他代理程序实例来监视相同的服务器。
5. 对于 Django settings for the monitored application，指定受监视的应用程序的 Django 设置，例如，my_project.settings。如果使用的是缺省值，请将此字段保留为空。
6. 对于 Minimum recorded response time，设置平均响应时间，以毫秒为单位。不会记录速度快于或等于此时间的请求。缺省值为 300。
7. 对于 Slow request threshold，设置慢速请求阈值，以毫秒为单位。缺省值为 500。
8. 对于 Extreme slow request threshold，设置极慢请求阈值，以毫秒为单位。缺省值为 7000。
9. 对于 Profiler report interval，设置代理程序为慢速请求生成概要分析程序报告的时间间隔，以分钟为单位。此值的最小设置为 10，这可确保应用程序的速度不会因过度概要分析而变慢。典型用户可将此值设置为大于 10。缺省值为 10。
  此参数还告知代理程序脚本如何聚集监视数据。在每分钟开头，监视中间件会重置上一分钟收集的数据，并开始写入新的原始数据文件。代理程序脚本基于此参数汇总原始数据，并返回结果。例如，如果此数字为 10 分钟，那么代理程序脚本会聚集前 10 分钟的所有原始数据，并返回结果。最终结果可能为平均值（例如，一个特定 URL 的响应时间），或结果可能为总和（例如，请求总数或流量字节总数）。
10. 保存并关闭 python_silent_config.txt 文件，然后输入：
  install_dir/bin/python-agent.sh config instance_name install_dir/samples/python_silent_config.txt
  其中，instance_name 是要提供给实例的名称，而 install_dir 是 Python 代理程序安装目录。缺省安装目录为 /opt/ibm/apm/agent。
11. 要启动代理程序，请输入：
  install_dir/bin/python-agent.sh start instance_name
要通过运行脚本并响应提示来配置代理程序，请完成下列步骤：
1. 输入：
  install_dir/bin/python-agent.sh config instance_name
  其中，instance_name 是要提供给实例的名称，而 install_dir 是 Python 代理程序安装目录。缺省安装目录为 /opt/ibm/apm/agent。
2. 当出现 Edit Monitoring Agent for Python settings 提示时，输入 1 以继续。
3. 当出现 HTTP listening port 提示时，按 Enter 键以接受缺省值或指定端口号。
  注：
  - 如果 Apache 服务器在多个端口上侦听，那么可以指定其中任一端口用于此参数。
  - 如果在同一系统上有多个 Apache 服务器运行，那么必须指定运行 Django 应用程序的服务器中的端口。
  - 如果想要使用多个代理程序实例来监视在相同 Apache 服务器上使用不同端口的 Python 应用程序实例，那么除了指定这些端口，您还必须在下一步中指定不同的 Django WSGI 入口点。如果仅指定这些端口，那么代理程序实例会监视相同的服务器，并且数据相同。
4. 当出现 Is Python 3 提示时，如果 Python 版本不是 3，请输入 false。如果 Python 版本是 3.x，请指定不是 false 的值，例如，true。缺省值为 false。
5. 当出现 Django WSGI entry points 提示时，将此参数保留为空或指定入口点。
  注：请勿针对不同的代理程序实例指定相同的 Django WSGI 入口点。如果使用缺省选项配置一个代理程序实例以监视 Apache 服务器，请勿配置其他代理程序实例来监视相同的服务器。
6. 当出现 Django settings for the monitored application 提示时，指定受监视的应用程序的 Django 设置，例如，my_project.settings。如果使用的是缺省值，请将此字段保留为空并按 Enter 键。
7. 当出现 Minimum recorded response time 提示时，按 Enter 键以接受缺省值或指定时间。
8. 当出现 Slow request threshold 提示时，按 Enter 键以接受缺省值或指定阈值。
9. 当出现 Extreme Slow request threshold 提示时，按 Enter 键以接受缺省值或指定阈值
10. 当出现 Profiler report interval 提示时，按 Enter 键以接受缺省值或指定时间间隔。
11. 要启动代理程序，请输入：
  install_dir/bin/python-agent.sh start instance_name

下一步做什么

启动代理程序实例后，将在临时目录中生成并提供用于定制监视中间件的注入脚本。

代理程序启动后，注入 shell 脚本会自动运行。如果希望确保正确执行此步骤，那么可确保存在以下文件：

install_dir/tmp/kpg/inject_numeric_string.sh
Django_setting_folder/kpg_numeric_string.py

要点：后缀数字字符串标识 Django 应用程序。如果在该临时文件夹中生成了多个注入脚本，那么会看到相同数目的 kpg_numeric_string.py 文件。

通常，注入脚本执行以下作业：

为每个 Django 应用程序备份原始 WSGI 设置文件。
复制定制 WSGI 设置文件以覆盖原始文件
将定制中间件移动到 Django 应用程序文件夹。
为 Apache 服务器启用模块状态。

注入脚本还会生成卸载脚本，以帮助您从每个 Django 应用程序卸载中间件。

注：多个注入脚本可能会包含启用 Apache 状态模块，但执行脚本时，模块只添加一次。

为了方便参考，可以对 Apache 服务器使用以下 stop 和 restart 命令：

Stop：apache_bin_directory/httpd -k graceful-stop
Restart：apache_bin_directory/httpd -k graceful