跳到主要内容
版本：1.2.0

Python Agent

配置文件​

参数表​

  • debug
    属性
    值
    生效方式配置文件修改
    参数类型Boolean
    来源配置文件
    可选参数true or false
    默认值false
    参数说明开启后会在日志记录 Agent 详细运转日志
  • iast.server.token
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数
    默认值洞态 IAST 用户 Token
    参数说明切换 Agent 所属用户
  • iast.server.url
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数
    默认值https://iast.huoxian.cn/openapi
    参数说明洞态 IAST 服务部署地址
  • iast.server.interval
    属性
    值
    生效方式配置文件修改
    参数类型整型
    来源配置文件
    可选参数5 - 120 (秒)
    默认值10
    参数说明Agent 存活心跳，数据上报间隔时间
  • project.name
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数格式：中文、英文字母大小写、数字、\@等组合，长度20以内，名称保证唯一
    默认值Demo Project
    参数说明项目名称
  • project.version
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数自定义即可
    默认值v1.0
    参数说明项目版本号
  • engine.version
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数自定义即可
    默认值v1.3.0
    参数说明引擎版本号
  • engine.name
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数自定义即可
    默认值v1.3.0
    参数说明引擎名称
  • log.log_path
    属性
    值
    生效方式配置文件修改
    参数类型字符串
    来源配置文件
    可选参数自定义即可
    默认值./dongtai_py_agent.log
    参数说明Agent 日志文件路径

用例​

默认配置文件：../../dongtai_agent_python/config.json

默认配置文件内容

../../dongtai_agent_python/config.json
{
    "debug":false,
    "iast":{ 
        "server":{ 
            "token":"1f6b1......................b55berere",
            "url":"https://iast-test.huoxian.cn/openapi"
        },
        "service":{
            "report":{
                "interval":5
            } 
        },  
    },
    "project":{
        "name":"Demo Project",
        "version":""
    },
    "engine":{
        "version":"v1.3.0",
        "name":"c7034af3..................46e947dc"
    }, 
    "log":{
        "log_path":"./dongtai_py_agent.log"
    }
}

环境变量配置​

参数​

  • PROJECT_NAME
    属性
    值
    生效方式配置环境变量，优先级高于 Agent 配置文件
    参数类型字符串
    来源环境变量
    可选参数格式：中文、英文字母大小写、数字、\@等组合，长度20以内，名称保证唯一
    默认值Demo Project
    参数说明项目名称
  • PROJECT_VERSION
    属性
    值
    生效方式配置环境变量，优先级高于 Agent 配置文件
    参数类型字符串
    来源环境变量
    可选参数自定义即可
    默认值v1.0.0
    参数说明项目版本号
  • ENGINE_NAME
    属性
    值
    生效方式配置环境变量，优先级高于 Agent 配置文件
    参数类型字符串
    来源环境变量
    可选参数自定义即可
    默认值
    参数说明引擎名称
  • DEBUG
    属性
    值
    生效方式配置环境变量配置 DEBUG=1
    参数类型整型
    来源环境变量
    可选参数1 or 0
    默认值0
    参数说明开启后会在日志记录 Agent 详细运转日志
  • LOG_PATH
    属性
    值
    生效方式配置环境变量配置 DEBUG=1
    参数类型整型
    来源环境变量
    可选参数自定义即可
    默认值./dongtai_py_agent.log
    参数说明Agent 日志文件路径
  • AUTO_CREATE_PROJECT
    属性
    值
    生效方式配置环境变量配置 DEBUG=1
    参数类型字符串
    来源环境变量
    可选参数1 or 0
    默认值0
    参数说明自动创建项目；1：开启，0：关闭

用例​

  • 从洞态 Server 页面下载 python-agent。

  • 安装 python-agent。

    pip3  install ./dongtai-agent-python.tar.gz

  • 通过环境变量配置项目名称、项目版本号。

    export  PROJECT_NAME=<application name>

    #按需添加PROJECT_VERSION、AUTO_CREATE_PROJECT、DEBUG、LOG_PATH，例：
    export  PROJECT_VERSION=<application version>