Skip to content

Latest commit

 

History

History
175 lines (115 loc) · 5.33 KB

README-zh.md

File metadata and controls

175 lines (115 loc) · 5.33 KB

Crawlab

基于Celery的爬虫分布式爬虫管理平台,支持多种编程语言以及多种爬虫框架.

查看演示 Demo

English Documentation

要求

  • Python3
  • MongoDB
  • Redis

安装

# 安装后台类库
pip install -r requirements.txt
# 安装前台类库
cd frontend
npm install

配置

请更改配置文件config.py,配置API和数据库连接.

快速开始

# 启动后端API
python app.py

# 启动Flower服务
python ./bin/run_flower.py

# 启动worker
python ./bin/run_worker.py
# 运行前端
cd frontend
npm run serve

截图

首页

home

爬虫列表

spider-list

爬虫详情 - 概览

spider-list

任务详情 - 抓取结果

spider-list

使用流程

user-process

架构

Crawlab的架构跟Celery非常相似,但是加入了包括前端、爬虫、Flower在内的额外模块,以支持爬虫管理的功能。

crawlab-architecture

节点

节点其实就是Celery中的Worker。一个节点运行时会连接到一个任务队列(例如Redis)来接收和运行任务。所有爬虫需要在运行时被部署到节点上,用户在部署前需要定义节点的IP地址和端口。

爬虫

自动发现

config.py文件中,修改变量PROJECT_SOURCE_FILE_FOLDER作为爬虫项目所在的目录。Crawlab后台程序会自动发现这些爬虫项目并储存到数据库中。是不是很方便?

部署爬虫

所有爬虫需要在抓取前被部署当相应当节点中。在"爬虫详情"页面点击"Deploy"按钮,爬虫将被部署到所有有效到节点中。

运行爬虫

部署爬虫之后,你可以在"爬虫详情"页面点击"Run"按钮来启动爬虫。一个爬虫任务将被触发,你可以在任务列表页面中看到这个任务。

任务

任务被触发并被节点执行。用户可以在任务详情页面中看到任务到状态、日志和抓取结果。

后台应用

这是一个Flask应用,提供了必要的API来支持常规操作,例如CRUD、爬虫部署以及任务运行。每一个节点需要启动Flask应用来支持爬虫部署。运行python manage.py apppython ./bin/run_app.py来启动应用。

中间者

中间者跟Celery中定义的一样,作为运行异步任务的队列。

前端

前端其实就是一个基于Vue-Element-Admin的单页应用。其中重用了很多Element-UI的控件来支持相应的展示。

与其他框架的集成

任务是利用python的subprocess模块中的Popen来实现的。任务ID将以环境变量CRAWLAB_TASK_ID的形式存在于爬虫任务运行的进程中,并以此来关联抓取数据。

在你的爬虫程序中,你需要将CRAWLAB_TASK_ID的值以task_id作为可以存入数据库中。这样Crawlab就直到如何将爬虫任务与抓取数据关联起来了。当前,Crawlab只支持MongoDB。

Scrapy

以下是Crawlab跟Scrapy集成的例子,利用了Crawlab传过来的task_id和collection_name。

import os
from pymongo import MongoClient

MONGO_HOST = '192.168.99.100'
MONGO_PORT = 27017
MONGO_DB = 'crawlab_test'

# scrapy example in the pipeline
class JuejinPipeline(object):
    mongo = MongoClient(host=MONGO_HOST, port=MONGO_PORT)
    db = mongo[MONGO_DB]
    col_name = os.environ.get('CRAWLAB_COLLECTION')
    if not col_name:
        col_name = 'test'
    col = db[col_name]

    def process_item(self, item, spider):
        item['task_id'] = os.environ.get('CRAWLAB_TASK_ID')
        self.col.save(item)
        return item

与其他框架比较

现在已经有一些爬虫管理框架了,因此为啥还要用Crawlab?

因为很多现有当平台都依赖于Scrapyd,限制了爬虫的编程语言以及框架,爬虫工程师只能用scrapy和python。当然,scrapy是非常优秀的爬虫框架,但是它不能做一切事情。

Crawlab使用起来很方便,也很通用,可以适用于几乎任何主流语言和框架。它还有一个精美的前端界面,让用户可以方便的管理和运行爬虫。

框架 类型 分布式 前端 依赖于Scrapyd
Crawlab 管理平台 Y Y N
Gerapy 管理平台 Y Y Y
SpiderKeeper 管理平台 Y Y Y
ScrapydWeb 管理平台 Y Y Y
Scrapyd 网络服务 Y N N/A

TODOs

后端
  • 文件管理
  • MySQL数据库支持
  • 重跑任务
  • 节点监控
  • 更多爬虫例子
前端
  • 任务数据统计
  • 表格过滤
  • 多语言支持 (中文)
  • 登录和用户管理
  • 全局搜索

如果您喜欢Crawlab或者希望贡献开发它,请加作者微信 tikazyq1 并注明"Crawlab",作者会将你拉入群。