帮助手册

安装 APM Insight Python Agent

请按照以下说明安装 APM Insight Python agent。

安装说明

  1. 如果您使用了虚拟环境,请先激活该环境,然后运行以下命令,将 S247 APMINSIGHT Python 包安装到虚拟环境中。

    pip install apminsight
  2. 您可以通过以下任一方法将 Python agent 集成到应用程序中。
    1. 使用命令行
    2. 使用代码片段

    使用命令行

    您需要使用 apminsight-run 脚本来运行应用程序,如下所示。 

    $ apminsight-run --license_key <s247_license_key> <apm-options> <user application execute command> 
    apm-options 描述
    --license_key 添加 Site24x7 许可证密钥或设备密钥
    ---apm_app_name 添加 APM 应用程序名称
    --apm_log_dir 添加用于存储 APM 日志的自定义日志目录
    --apm_debug 启用调试模式
    --apm_exp_host 配置 S247DataExporter 主机
    --apm_exp_status_port 配置 S247DataExporter 状态端口
     --apm_exp_data_port 配置 S247DataExporter 数据端口
    --apm_monitor_group 使用此配置对监视器进行分组

    示例: 

    如果要配置应用程序名称,请使用以下命令:

    apminsight-run --apm_app_name "monitorname"

    如果要配置目录位置,请使用以下命令:

    apminsight-run --apm_app_name "monitorname" --apm_log_dir "logs location"

    使用代码片段

    请更新以下代码片段中的配置内容,并将其放置在应用程序路由文件或启动文件的顶部,然后重启应用程序。

    from apminsight import initialize_agent
        initialize_agent({
    		"appname" : "
    <Your application name>
    ",
    		"license_key" : "
    <Your Site24x7 license key or device key>
    ",
    
            '''change if  S247DataExporter is not running in the default ports(20021, 20022):'''
            "exporter_status_port" : "
    <S247DataExporter status port>
    ",
            "exporter_data_port" : "
    <S247DataExporter data port>
    ",
    
            '''If you are running S247DataExporter on a separate machine/server or as a Docker container:'''
            "exporter_host" : "
    <HostName/ContainerName where S247DataExporter is running>
    "
        })
    

    例如,对于 Django 应用程序,请将代码片段添加到 Django settings.py 文件的顶部。Django 应用程序的名称将通过应用程序 settings.py 文件中的 WSGI_APPLICATION 自动检测。

     

     

    对于其他应用程序和框架(如 Flask),请将代码片段添加到应用程序启动文件的顶部。

     

     

    注意

     

    您也可以使用环境变量来配置 agent。

    配置项 描述
    $ export S247_LICENSE_KEY="<Your license key or device key>" 添加许可证密钥
    $ export APM_APP_NAME="<Your application name>" 添加应用程序名称
    $ export APM_LOGS_DIR="<logs storing path>" 配置日志目录
    $ export APM_EXPORTER_STATUS_PORT=<S247DataExporter status port>,$ export APM_EXPORTER_DATA_PORT="<S247DataExporter data port>" 更改 S247DataExporter 的默认运行端口(20021、20022)
    $ export APM_EXPORTER_HOST="<HostName/ContainerName where S247DataExporter is running>" 将 S247DataExporter 的主机更改为其他机器、服务器或 Docker 容器

     

  3. 重启应用程序。
  4. 执行一些事务,以便 agent 可以收集数据。
  5. 登录您的 Site24x7 账户。
  6. 导航至 APM Insight,点击您的应用程序以查看应用程序指标。
  7. 您可以在 apminsightdata/logs 目录中查看 agent 日志文件,该目录位于进程生成的路径下。


本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!