FishFishJump is a solution that simply and basic for search engines and provide multiple demos that independent deployment by used Docker.
FishFishJump is a solution that simply and basic for search engines and provide multiple demos that independent deployment by used Docker, through those examples can help you implement your customizable search engine site.
- fish_core: Include some common utils or components and other modules depend on it.
- fish_crawlers: A demo of the distributed crawler that implements base on scrapy-redis, it contains two projects of scrapy, the master_crawler will crawl link from http://dmoztools.net/ and put it to the Redis queue, the slave_crawler will crawl the link from the Redis queue then extract info and store into the MongoDB.
- fish_dashboard: A web app for monitoring health status and info of Scrapy and Elasticsearch base on Flask.
- fish_searcher: A web app that supports search and returns search results for the user and it base on the Elasticsearch and depends data on the fish_crawler crawling.
If you want to independent deployments then you only need input following commands in the root directory of the project(must contain file docker-compose.yml):
docker-compose up -d --build
More about docker and docker-compose please refer to: https://docs.docker.com/compose/
Notice: for fish_crawlers, you also need to access the Docker container and deploy scrapy, FishFishJump deployment way use Scrapyd, the related configuration file is in the scrapy.cfg such as:
# Automatically created by: scrapy startproject # # For more information about the [deploy] section see: # https://scrapyd.readthedocs.org/en/latest/deploy.html [settings] default = master_crawler.settings [deploy:master_crawler01] url = http://127.0.0.1:6800/ project = master_crawler
Look at the following command to deployments:
# enter in inside of the Docker container docker exec -it [container id] /bin/bash # deploy scrapy project by command 'scrapyd-deploy [deploy name]', the deploy name refers to the file scrapy.cfg cd master_crawler scrapyd-deploy master_crawler01 cd .. cd slave_crawler scrapyd-deploy slave_crawler01 # start crawlers, project_name and spider_name refer to the file scrapy.cfg # The spider dmoz_crwaler must need a list of the Redis and its key is dmoz_crawler:start_urls and value is http://dmoztools.net/ # Example: redis LPUSH dmoz_crawler:start_urls http://dmoztools.net/ curl http://localhost:6800/schedule.json -d project=master_crawler -d spider=dmoz_crawler curl http://localhost:6800/schedule.json -d project=slave_crawler -d spider=simple_fish_crawler # exit from the Docker container exit
More about please refer to: https://github.com/scrapy/scrapyd-client
By the way, fish_crawlers use local Redis and MongoDB by Docker. if you don’t want to then you can delete the following content in docker-compose.yml and config your Redis and MongoDB address in Scrapy project(settings.py).
redis: image: redis container_name: FishFishJump_Redis ports: - "6379:6379" mongo: image: mongo container_name: FishFishJump_Mongo ports: - "27017:27017" links: - redis - mongo
if you want not use Docker then you need manual start fish_crawlers or fish_dashboard, please input following order:
# the first need install dependency pip install FishFishJump # if on the root directory of the master_crawler scrapy crawl dmoz_crawler # if on the root directory of the slave_crawler scrapy crawl simple_fish_crawler # if on the root directory of the fish_dashboard or fish_searcher python app.py
For fish_crawlers you can also use scrapyd for deployments, or remote manage by fish_dashboard.
fish_dashboard is a monitoring platform that monitoring health status and information of the Scrapy and Elasticsearch and it has some feature help you better for manage Scrpay and Elasticsearch such as:
- real-time update data display by ajax polling if you don’t want to use it you can set config POLLING_INTERVAL_TIME to 0 for cancel ajax polling.
- fault alarm mechanism, fish_dashboard will send an alarm email to you when your Scrapy or Elasticsearch there was no response for a long time(reach maximum fault number of times, this param refer to MAX_FAILURE_TIMES in the settings.py).
- transfer data mechanism, you have two methods to transfer data from MongoDB into the Elasticsearch for generating index database for search, the first way is the manual transfer and data is transmitted at one time in the off-line state, the second way is the automatic transfer data based on a thread polling implementation and this thread will always transfer data from MongoDB into the Elasticsearch until you cancel it.
fish_dashboard is based on a Flask implementation and its config file is settings.py in the root directory of the fish_dashboard you can also use command line interface, the specific configuration is as following:
Usage: fish_dashboard [options] args Command line param for FishFishJump webapp. Options: -h, --help show this help message and exit --host=HOST host address, default: 0.0.0.0 --port=PORT port, default: 5000 --username=ADMIN_USERNAME administrator username for login, default: admin --password=ADMIN_PASSWORD administrator password for login, default: 123456 -d, --debug enable debug pattern of the flask, default: True -t, --test enable test pattern of the flask, default: False --cached-expire=CACHE_EXPIRE expire of the flask cache, default: 60 --scrapyd-url=SCRAPYD_URL url of the scrapyd for connect scrapyd service, default: http://localhost:6800/ -v, --verbose verbose that log info, default: False --log-file-dir=LOG_FILE_DIR the dir path of the where store log file, default: E:\FishFishJump\log\ --log-file-name=LOG_FILE_BASIS_NAME the name of the what log file, default: fish_fish_jump_webapp.log --elasticsearch-hosts=ELASTICSEARCH_HOSTS the string represent a host address for Elasticsearch, format: hostname:port and able to write multiple address by comma separated default: localhost:9200 --polling-interval=POLLING_INTERVAL_TIME the time of the interval time for real-time dynamic update, units second default: 3 --failure-sleep-time=FAILURE_SLEEP_TIME if connected fail will turn to this time window and return backup data in this time window, units second default: 30 --max-failure-times=MAX_FAILURE_TIMES the number of the max failure times if occurred fail reaching the upper limit will sent message into the front-end, default: 5 --max-failure-message-key=MAX_FAILURE_MESSAGE_KEY the string of the key for message sent after reaching the upper limit, default: timeout_error
Here are some renderings:
The fish_searcher is a web app that supports search and return search results and implement base on the Elasticsearch, it provides some basic function as a search engine site.
Usage: fish_searcher [options] args Command line param for FishFishJump webapp. Options: -h, --help show this help message and exit --host=HOST host address, default: 0.0.0.0 --port=PORT port, default: 5009 -d, --debug enable debug pattern of the flask, default: True -t, --test enable test pattern of the flask, default: False -v, --verbose verbose that log info, default: False --log-file-dir=LOG_FILE_DIR the dir path of the where store log file, default: E:\FishFishJump\log\ --log-file-name=LOG_FILE_BASIS_NAME the name of the what log file, default: fish_fish_jump_searcher.log --elasticsearch-hosts=ELASTICSEARCH_HOSTS the string represent a host address for Elasticsearch, format: hostname:port and able to write multiple address by comma separated default: localhost:9200 --elasticsearch-index=ELASTICSEARCH_INDEX the string represents a list of the index for query data from Elasticsearch, if you want to assign multiple please separate with a comma, for example, index_a,index_b, default: ['pages'] --elasticsearch-doc-type=ELASTICSEARCH_DOC_TYPE the string represents a list of the doc_type for query data from Elasticsearch, if you want to assign multiple please separate with a comma, for example, doc_type_a, doc_type_b, default: ['page_item'] --redis-cache enable Redis for external cache, default: False --redis-host=REDIS_HOST the string represents a host of the Redis and the configuration invalid when not set config --redis- cache, default: 127.0.0.1 --redis-port=REDIS_PORT the string represents a port of the Redis and the configuration invalid when not set config --redis- cache , default: 6379