cosr-back
This repository contains the main components of the Common Search backend.
Your help is welcome! We have a complete guide on how to contribute.
Understand the project
This repository has 4 components:
- cosrlib: Python code for parsing, analyzing and indexing documents
- spark: Spark jobs using cosrlib.
- urlserver: A service for getting metadata about URLs from static databases
- explainer: A web service for explaining and debugging results, hosted at explain.commonsearch.org
Here is how they fit in our general architecture:
Local install
A complete guide available in INSTALL.md.
Launching the tests
Before running the tests, you have to start Elasticsearch and other services they depend on:
make start_services
make docker_test
You may also want to run only part of the tests, for instance all which do not use Elasticsearch. To do that you should enter the container first:
make docker_shell
py.test tests/ -v -m "not elasticsearch"
If you want to evaluate the speed of a component, for instance HTML parsing, you can repeat the tests N times and output a Python profile:
make docker_shell
py.test tests/cosrlibtests/document/html/ -v --repeat 50 --profile
Launching an index job
make docker_shell
spark-submit spark/jobs/pipeline.py --source commoncrawl:limit=1 --plugin plugins.filter.Homepages:index_body=1 --profile
After this, if you have a cosr-front instance connected to the same Elasticsearch service, you will see the results!
Using plugins
Common Search supports the insertion of user-provided plugins in the indexation pipeline. Some are included by default, for instance:
make docker_shell
spark-submit spark/jobs/pipeline.py --source url:https://about.commonsearch.org/ --plugin plugins.grep.Words:words="common search",path=/tmp/grep_result
See the plugins/ directory for more examples.
Launching the explainer
The explainer allows you to debug results easily. Just run:
make docker_explainer
Then open http://192.168.99.100:9703 in your browser (Assuming 192.168.99.100 is the IP of your Docker host)