Skip to content

Latest commit

 

History

History
121 lines (76 loc) · 3.92 KB

README.md

File metadata and controls

121 lines (76 loc) · 3.92 KB
Raw

Try out Noise

This is the source code of the Noise query language tutorial at https://try.noisesearch.org/.

Quickstart

If you want to run this tutorial locally, follow these steps. For more details please see the instructions below. You need to have Node and EmberCli installed.

The project is split into a frontend and backend. First start the backend: Please note that it might take a while to install as it needs to compile Noise first.

npm install
node index.js

Open another terminal and start the frontend:

cd ember
npm install
ember serve

Now visit the tutorial at http://localhost:4200.

Please note that the backend will start downloading data as soon as it is started. You can already perform queries, but be aware that the corresponding data might not have been indexed yet.

Running the backend

First of all you need to install its dependencies:

npm install

Running manually

For running the node backend of the tutorial, simply execute it:

node index.js

It will start downloading the TV shows from tvmaze.com automatically. You can access the demo at http://localhost:3000/.

Running via Systemd

It's also possible to start it via Systemd. Copy the supplied Systemd Service script from scripts/systemd/try-out-noise.service to /etc/systemd/system/. Modify it to fit your environment, especially the User and WorkingDirectory settings.

Then enable the Service, reload the Systemd Daemon and start it:

sudo systemctl enable try-out-noise
sudo systemctl daemon-reload
sudo systemctl start try-out-noise

You can double check if it really start with looking at the logs:

journalctl -u try-out-noise -f

It should look something like this:

Apr 28 01:39:53 frea systemd[1]: Started Try out Noise.
Apr 28 01:39:53 frea node[28904]: Server running at http://0.0.0.0:3000/
Apr 28 01:39:53 frea node[28904]: Settings: {"NOISE_QUERY_INDEXES": 4, "NOISE_MAX_WAITING_CLIENTS": 10, "NOISE_ACQUIRE_TIMEOUT": 5000}

Environment variables

The demo can be tweaked with some environment variables:

  • NOISE_QUERY_INDEXES (default: 4): Number of indexes that are opened for querying. This is also the number of queries that can run in parallel.
  • NOISE_MAX_WAITING_CLIENTS (default: 10): Number of clients that will be queued up before they return with an error.
  • NOISE_ACQUIRE_TIMEOUT (default: 5000): The time in milliseconds that will be be tried to acquire an index to query on. This is for the waiting clients.

Monitoring the backend

If you run the demo on a server, you might want to have some additional monitoring in case it gets stuck. The scripts/monitor-try-out-noise.sh script will send a request to the server. If it doesn't respond in timely fashion, it will kill the server.

The monitoring is run best when the demo as well as the monitoring is under the supervision of Systemd. Copy the scripts/systemd/monitor-try-out-noise.service to /etc/systemd/system/ and modify it to fit your environment, especially the User and WorkingDirectory settings.

Then enable the Service, reload the Systemd Daemon and start it:

sudo systemctl enable monitor-try-out-noise
sudo systemctl daemon-reload
sudo systemctl start monitor-try-out-noise

You can double check if it really start with looking at the logs:

journalctl -u monitor-try-out-noise -f

It should look something like this:

Apr 28 01:53:47 frea systemd[1]: Started Monitor for Try out Noise

Running the frontend

The frontend is built with Ember. For more information on how to develop and run it, see the application's README in the ember sub-directory.