search

o19s / chorus-opensearch-edition

Chorus, now for OpenSearch!
Apache License 2.0
4 stars 2 forks source link

readme

License

Chorus Logo

Chorus

Towards an open source tool stack for e-commerce search

This is a fork of chorus-elasticsearch-edition. Refer to that repository for more information on Chorus.

Chorus makes deploying powerful ecommerce search easier by shifting the buy vs build decision in favour of build, so you can own your search! Chorus deals with three issues:

  1. Starting from Scratch is Time Consuming Downloading an open source search engine isn't enough. It's like being provided with all the parts of a Lego model, but without building instructions ;-) . We need a better baseline to quickly get started.

  2. Integration of Tooling is Hard Search isn't just a query running on an index of data. It's also the operational monitoring, the analytics and relevance tooling, that goes into it. Every team that starts, faces the penalties of starting from scratch, integrating an ecosystem of options.

  3. Sharing Knowledge is a Must! It isn't enough to just have conference talks. We need code and data samples in order to share knowledge about improving ecommerce search. Chorus is a public environment that you can use to profit from the community and also to share your next great idea!

This is the project that enables Chorus to use OpenSearch as the search engine. For others:

Want to stay up-to-date with the community? Visit https://querqy.org/ to learn more, and join the E-Commerce Search Slack group for tips, tricks, help and news on what's new in the Chorus ecosystem.

What Runs Where

Working with macOS? Pop open all the tuning related web pages with one terminal command:

open http://localhost:4000 http://localhost:5601/app/home http://localhost:3000

5 Minutes to Run Chorus!

We are trying to strike a balance between making the setup process as easy and fool proof as possible, with the need to not hide too much of the interactions between the projects that make up Chorus.

If you are impatient, we provide a quick start script, ./quickstart.sh that sets Chorus up for you. However, I recommend you go through Kata 0: Setting up Chorus, to get a picture of what's running in the stack.

After setting up Chorus you can check out Kata 1: Alice Needs a New Laptop to learn about getting some insight into your user's behavior!

More Katas can be found in the Solr version of Chorus and many can be transferred to this OpenSearch based stack. Some are also covered in a video series called Meet Pete. Feel free to open PRs to add Katas you find useful or open issues if you want to see specific Katas included. Every contribution is welcome!

Structured Learning using Chorus OpenSearch Edition

Learn more by following this sequence of Katas:

  1. 000 Kata: Setting up Chorus
  2. First Kata: Alice Needs a New Laptop
  3. Second Kata: Deriving Interaction Data
  4. Third Kata: Importing Pre-Existing Event Data
  5. Fourth Kata: Build a Basic Dashboard
  6. Fifth Kata: Hybrid Search in OpenSearch
  7. Sixth Kata: Protecting Sensitive Information while using UBI

Useful Commands for Chorus

To start your environment, but still run each command to set up the integrations manually, run:

docker compose up --build -d

The quickstart script will launch OpenSearch, download and index the sample product data for the ecommerce index:

./quickstart.sh

If you want to add in the offline lab environment based on Quepid, then tack on the --with-offline-lab parameter:

./quickstart.sh --with-offline-lab

To see what is happening in the Chorus stack you can tail the logs for all the components via:

docker compose logs -tf

If you want to see the logs of just one component of the Chorus stack, use:

docker compose ps                       # list out the names of the components
docker compose logs -tf opensearch      # tail opensearch only

To stop all containers, you can run:

./quickstart.sh --stop

To destroy your environment (including any volumes created, like the mysql DBs), just run:

docker compose down -v

or:

./quickstart.sh --shutdown

If Docker is giving you a hard time, then some options are:

docker system prune                     # removes orphaned images, networks, etc.
docker system prune -a --volumes        # removes all images, clears out your Docker diskspace if you full.

You may also have to increase the resources given to Docker - up to 4 GB RAM and 2 GB Swap space.

Chorus Data Details

The Chorus project includes some public, sample datasets. These datasets enable the community to learn, experiment and collaborate in a safe manner and are a key part of demonstrating, how to build measurable and tunable ecommerce search, with open source components.

The sample product data is generously sourced from Icecat and is licensed under their Open Content License.

The version of the Icecat product data that Chorus provides has the following changes:

Tips for installing on Windows

Known Issues

  1. We have removed SMUI until Querqy is updated for recent OpenSearch versions.
  2. We have removed the kata 001_optimize_a_query.md until SMUI is back.

Of course, contributions are very welcome to improve Chorus - The OpenSearch Edition!

Demo Script

Here is a reasonable script for demonstrating the power of UBI in Cjhorus.

  1. Open up Firefox and put web inspector on the right.
  2. Filter logs to ONLY Logs, disable all the other options so you only see our events.
  3. Search for Notebook Case
  4. Highlight that we get a query_id.
  5. Clear the history of logs
  6. Notice you like Kensington brand and pick it
  7. Highlight that we get a new filter event, but with the same query_id.
  8. Pick one and click add to cart.
  9. Jump to http://chorus-opensearch-edition.dev.o19s.com:5601/
  10. Go to devtools and run the below queries, swapping your own specific query_id in:
GET ubi_events/_search
{
  "query": {
    "match": {
      "query_id": "9d32df94-64ac-4673-abfd-bab889e275d9"
    }
  },
  "sort": {
    "timestamp": "asc"
  }
}

GET ubi_queries/_search
{
  "query": {
    "match_all": {}
  }
}