mirror of
https://github.com/scylladb/scylladb.git
synced 2026-05-22 07:42:16 +00:00
9dd3c59c77e401b25035ff5392f795fbc3032760
docs/metrics.md so far explained just the REST API for retrieving current metrics from a single Scylla node. In this patch, I add basic explanations on how to use the Prometheus and Grafana tools included in the "scylla-grafana-monitoring" project. It is true that technically, what is being explained here doesn't come with the Scylla project and requires the separate scylla-grafana-monitoring to be installed as well. Nevertheless, most Scylla developers will need this knowledge eventually and suprisingly it appears it was never documented anywhere accessible to newbie developers, and I think metrics.md is the right place to introduce it. In fact, I myself wasn't aware until today that Prometheus actually had its own Web UI on port 9090, and that it is probably more useful for developers than Grafana is. Signed-off-by: Nadav Har'El <nyh@scylladb.com> Reviewed-by: Botond Denes <bdenes@scylladb.com> Message-Id: <20190129114214.17786-1-nyh@scylladb.com>
…
…
…
…
…
…
…
Scylla
Quick-start
$ git submodule update --init --recursive
$ sudo ./install-dependencies.sh
$ ./configure.py --mode=release
$ ninja-build -j4 # Assuming 4 system threads.
$ ./build/release/scylla
$ # Rejoice!
Please see HACKING.md for detailed information on building and developing Scylla. Note: GCC >= 8.1.1 is require to compile Scylla.
Running Scylla
- Run Scylla
./build/release/scylla
- run Scylla with one CPU and ./tmp as data directory
./build/release/scylla --datadir tmp --commitlog-directory tmp --smp 1
- For more run options:
./build/release/scylla --help
Building Fedora RPM
As a pre-requisite, you need to install Mock on your machine:
# Install mock:
sudo yum install mock
# Add user to the "mock" group:
usermod -a -G mock $USER && newgrp mock
Then, to build an RPM, run:
./dist/redhat/build_rpm.sh
The built RPM is stored in /var/lib/mock/<configuration>/result directory.
For example, on Fedora 21 mock reports the following:
INFO: Done(scylla-server-0.00-1.fc21.src.rpm) Config(default) 20 minutes 7 seconds
INFO: Results and/or logs in: /var/lib/mock/fedora-21-x86_64/result
Building Fedora-based Docker image
Build a Docker image with:
cd dist/docker
docker build -t <image-name> .
Run the image with:
docker run -p $(hostname -i):9042:9042 -i -t <image name>
Contributing to Scylla
Description
Languages
C++
72.3%
Python
26.4%
CMake
0.4%
GAP
0.3%
Shell
0.3%