如何简单高效地部署和监控分布式爬虫项目

需求分析

初级用户：

• 只有一台开发主机，但愿可以直接经过浏览器部署和运行 Scrapy 爬虫项目

进阶用户：

• 有一台云主机，但愿集成身份认证
• 但愿可以定时自动启动爬虫任务，实现网页信息监控

专业用户：

• 有 N 台云主机，经过 Scrapy-Redis 构建分布式爬虫
• 但愿在页面上直观地查看全部云主机的运行状态
• 但愿可以自由选择部分云主机，批量部署和运行项目，实现集群管理
• 但愿自动执行日志分析，掌握爬虫进度
• 但愿在出现特定类型的异常日志时可以及时得到通知，包括自动中止当前爬虫任务

安装和配置

1. 请先确保全部主机都已经安装和启动 Scrapyd，若是须要远程访问 Scrapyd，则需将 Scrapyd 配置文件中的 bind_address 修改成 bind_address = 0.0.0.0，而后重启 Scrapyd service。
2. 开发主机或任一台主机安装 ScrapydWeb： pip install scrapydweb
3. 经过运行命令 scrapydweb 启动 ScrapydWeb（首次启动将自动在当前工做目录生成配置文件）。
4. 启用 HTTP 基本认证（可选）：

ENABLE_AUTH = True
USERNAME = 'username'
PASSWORD = 'password'
复制代码

5. 添加 Scrapyd server，支持字符串和元组两种配置格式，支持添加认证信息和分组/标签：

SCRAPYD_SERVERS = [
    '127.0.0.1',
    # 'username:password@localhost:6801#group',
    ('username', 'password', 'localhost', '6801', 'group'),
]
复制代码

6. 运行命令 scrapydweb 重启 ScrapydWeb。

访问 Web UI

经过浏览器访问并登陆 http://127.0.0.1:5000。

• Servers 页面自动输出全部 Scrapyd server 的运行状态。
• 经过分组和过滤能够自由选择若干台 Scrapyd server，而后在上方 Tabs 标签页中选择 Scrapyd 提供的任一 HTTP JSON API，实现一次操做，批量执行。

• 经过集成 LogParser，Jobs 页面自动输出爬虫任务的 pages 和 items 数据。
• ScrapydWeb 默认经过定时建立快照将爬虫任务列表信息保存到数据库，即便重启 Scrapyd server 也不会丢失任务信息。(issue 12)

部署项目

• 支持一键部署项目到 Scrapyd server 集群。
• 经过配置 SCRAPY_PROJECTS_DIR 指定 Scrapy 项目开发目录，ScrapydWeb 将自动列出该路径下的全部项目，默认选定最新编辑的项目，选择项目后便可自动打包和部署指定项目。
• 若是 ScrapydWeb 运行在远程服务器上，除了经过当前开发主机上传常规的 egg 文件，也能够将整个项目文件夹添加到 zip/tar/tar.gz 压缩文件后直接上传便可，无需手动打包为 egg 文件。

运行爬虫

• 经过下拉框直接选择 project，version 和 spider。
• 支持传入 Scrapy settings 和 spider arguments。
• 支持建立基于 APScheduler 的定时爬虫任务。(如需同时启动大量爬虫任务，则需调整 Scrapyd 配置文件的 max-proc 参数)
• 支持在 Scrapyd server 集群上一键启动分布式爬虫。

日志分析和可视化

• 若是在同一台主机运行 Scrapyd 和 ScrapydWeb，建议设置 SCRAPYD_LOGS_DIR 和 ENABLE_LOGPARSER，则启动 ScrapydWeb 时将自动运行 LogParser，该子进程经过定时增量式解析指定目录下的 Scrapy 日志文件以加快 Stats 页面的生成，避免因请求原始日志文件而占用大量内存和网络资源。
• 若是须要管理 Scrapyd server 集群，建议在其他主机单独安装和启动 LogParser ，缘由如上。
• 若是安装的 Scrapy 版本不大于 1.5.1，LogParser 将可以自动经过 Scrapy 内建的 Telnet Console 读取 Crawler.stats 和 Crawler.engine 数据，以便掌握 Scrapy 内部运行状态。

定时爬虫任务

• 支持查看爬虫任务的参数信息，追溯历史记录
• 支持暂停，恢复，触发，中止，编辑和删除任务等操做

邮件通知

经过轮询子进程在后台定时模拟访问 Stats 页面，ScrapydWeb 将在知足特定触发器时根据设定自动中止爬虫任务并发送通知邮件，邮件正文包含当前爬虫任务的统计信息。

1. 添加邮箱账号：

SMTP_SERVER = 'smtp.qq.com'
SMTP_PORT = 465
SMTP_OVER_SSL = True
SMTP_CONNECTION_TIMEOUT = 10

EMAIL_USERNAME = ''  # defaults to FROM_ADDR
EMAIL_PASSWORD = 'password'
FROM_ADDR = 'username@qq.com'
TO_ADDRS = [FROM_ADDR]
复制代码

2. 设置邮件工做时间和基本触发器，如下示例表明：每隔1小时或当某一任务完成时，而且当前时间是工做日的9点，12点和17点，ScrapydWeb 将会发送通知邮件。

EMAIL_WORKING_DAYS = [1, 2, 3, 4, 5]
EMAIL_WORKING_HOURS = [9, 12, 17]
ON_JOB_RUNNING_INTERVAL = 3600
ON_JOB_FINISHED = True
复制代码

3. 除了基本触发器，ScrapydWeb 还提供了多种触发器用于处理不一样类型的 log，包括 'CRITICAL', 'ERROR', 'WARNING', 'REDIRECT', 'RETRY' 和 'IGNORE'等。

LOG_CRITICAL_THRESHOLD = 3
LOG_CRITICAL_TRIGGER_STOP = True
LOG_CRITICAL_TRIGGER_FORCESTOP = False
# ...
LOG_IGNORE_TRIGGER_FORCESTOP = False
复制代码

以上示例表明：当日志中出现3条或以上的 critical 级别的 log 时，ScrapydWeb 将自动中止当前任务，若是当前时间在邮件工做时间内，则同时发送通知邮件。

GitHub 开源

活捉几只官方大佬，赶忙前去围观吧。点个 Star 不迷路，欢迎提交 feature request！

my8100 / scrapydweb