Faraday Agents Dispatcher帮助用户开发与 Faraday的集成,支持任何语言。
只需运行 pip3 install faraday_agent_dispatcher,系统应能看到
faraday-dispatcher 命令。
若要搭建开发环境(即修改 dispatcher 本身的代码,而非编写自己的集成),应克隆此仓库并运行
pip install -e .。
通过运行 faraday-dispatcher config-wizard 生成配置文件。
使用 faraday-dispatcher run 命令运行代理。若未指定自定义路径,其创建的配置文件将位于
~/.faraday/config/dispatcher.ini。
应使用注册令牌完成代理配置,该令牌位于 http://localhost:5985/#/admin/agents。检查 服务器部分是否包含关于 Faraday Server 实例的正确信息。然后,在代理部分填写所需的代理名称。最后,添加执行器。
执行器是一个向标准输出打印单行 JSON 数据的脚本。请注意,如果向标准输出打印任何其他数据,dispatcher 将触发错误。如需输出调试或日志信息,应使用标准错误输出。
执行器写入标准输出的每一行都将被 dispatcher 解码,并通过 Bulk Create 端点发送至 Faraday。因此,打印的 JSON 必须符合端点所需的模式(该模式详见下文)。否则,dispatcher 会因收到无效数据而报错。
若要调试执行器,最简单的方法是直接运行它,而不是通过 Dispatcher 运行。由于执行器仅向标准输出打印 JSON 数据,你将能看到它拟发送至 Faraday 的所有信息,但不会实际发送。
编写执行器后,需使用 faraday-dispatcher config-wizard 在“执行器”部分添加它,包括名称、要执行的命令以及发送至 Faraday Server 的 JSON 最大尺寸。此外,还可以在相应部分配置环境变量和参数。
使用 faraday-dispatcher config-wizard 命令运行执行器,并通过 Faraday Server 启动它。执行器将使用已设置的环境变量并询问参数。
发布到 Faraday 的数据必须符合 Faraday's REST API 中的
bulk_create 端点要求。
如需运行多个 dispatcher,每个运行自己的执行器,推荐的方式是为每个 dispatcher 创建不同的配置文件(例如
~/.faraday/config/dispatcher-1.ini 和
~/.faraday/config/dispatcher-2.ini)。然后,使用 faraday-dispatcher --config-file PATH_TO_A_CONFIG_FILE 运行两个不同的 Dispatcher 实例。
在 executors 目录中,可以找到已创建的执行器。
官方执行器 是一组开箱即用的执行器集合(通过向导进行最小配置)。它们包含一个清单 JSON 文件,提供关于执行器用途的详细信息,并帮助进行配置。
当前官方执行器包括:
开发执行器 是我们不完全维护的执行器集合,其中包含使用示例、概念性执行器以及正在开发中的执行器。最重要的有:
我们目前正在开发新的执行器,同时也在改善使用代理的体验。
我们希望能为某些代理提供对其工作区的读取权限,以便它们能够利用现有数据发现更有价值的信息。
更多信息请查看我们的文档