Eva Balycheva b53ff5d12c Refactoring of docs during Mitaka cycle

This patch improves Zaqar documentation and fixes currently existing
bugs.

Bugs this patch currently addresses and solutions:

Short names for documentation locations used in this commit message:
GitRepo - https://github.com/openstack/zaqar/
Contributor Docs - http://docs.openstack.org/developer/zaqar/
Wiki - https://wiki.openstack.org/wiki/Zaqar/

1. DRY violation and spreaded information for contributors bug.
The information for Zaqar contributors is spreaded/duplicated across
GitRepo, Contributor Docs and Wiki.
Examples of DRY violation are these three articles:
https://wiki.openstack.org/wiki/Zaqar/Give_Zaqar_a_try,
https://github.com/openstack/zaqar/blob/master/README.rst,
http://docs.openstack.org/developer/zaqar/development-environment.html

Example of spreaded information is: "zaqar/tests/functional/README.rst"
Normally the contributor want to see the information from this file in
"doc/source/running_tests.rst".

Solution: move useful missing information for contributors from Wiki and
GitRepo to Contributor Docs, then replace all contributor information in
Wiki and GitRepo with links to Contributor Docs.

2. Outdated information, missing new information and broken links bug.
Example is "test_suite.rst":
a. It still states that Zaqar test suite lives in two directories -
"tests" and "zaqar/tests", but now it's not true.
b. Doesn't contain information about how test invocation is organized,
what really happens when "tox -e py27" command executes.

Solution: replace outdated information with new, fix broken links if
possible, add useful missing information.

3. Style and formatting bugs.
The reference is http://docs.openstack.org/contributor-guide/.

Many documents in Contributor Docs have wrong line wrapping - some lines
are wrapped too short and some are wrapped too long.
Lines must wrap at 79 characters, exceptions are code and links.
Example is "first_review.rst" which lines are not wrapped at all.

Enumerated lists must be written using "#. " syntax.
Example with wrong enumerated list is "development.environment.rst".

Some inline elements must be styled according to:
http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html
Example with wrong styling of inline elements is
"development.environment.rst" where many paths and file names are not
marked with `` (double backticks).

By default code inserts are implicitly styled with python syntax.
There are many places in Contributor Docs where console (bash) code is
wrongly styled with python syntax.

Also there are some failed attempts to apply a formatting in Contributor
Docs. For example there is a broken list in "first_review.rst" at line
52.

Solution: fix broken formatting, apply proper style where it is needed.

Some of these bugs fixes closes few bug reports from:
https://etherpad.openstack.org/p/zaqar-mitaka-docs

Change-Id: Id668684248bdee03eb43b537dc2c6bb2a68ed23d

2016-01-07 17:05:09 +03:00

3.3 KiB

Raw Blame History

Running benchmark

Introduction

This document describes how to run benchmarking tool.

Zaqar Contributors can use this tool to test how the particular code change affects Zaqar's performance.

Usage

First install and run zaqar-server.

For example, you can setup Zaqar in development environment.

See devref/development.environment.
In your terminal cd into your local Zaqar repo and install additional requirements:
```
$ pip install -r bench-requirements.txt
```

Copy the configuration file to ~/.zaqar:

$ cp etc/zaqar-benchmark.conf.sample ~/.zaqar/zaqar-benchmark.conf

In this configuration file specify where zaqar-server can be found:
```
server_url = http://localhost:8888
```
The benchmarking tool needs a set of messages to work with. Specify the path to the file with messages in the configuration file. Alternatively, put it in the directory with the configuration file and name it zaqar-benchmark-messages.json. As a starting point, you can use the sample file from the etc directory:
```
$ cp etc/zaqar-benchmark-messages.json ~/.zaqar/
```
If the file is not found or no file is specified, a single hard-coded message is used for all requests.
Run the benchmarking tool using the following command:
```
$ zaqar-bench
```
By default, the command will run a performance test for 5 seconds, using one producer process with 10 greenlet workers, and one observer process with 5 workers. The consumer role is disabled by default.

You can override these defaults in the config file or on the command line using a variety of options. For example, the following command runs a performance test for 30 seconds using 4 producer processes with 20 workers each, plus 4 consumer processes with 20 workers each.

Note that the observer role is also disabled in this example by setting its number of workers to zero:
```
$ zaqar-bench -pp 4 -pw 10 -cp 4 -cw 20 -ow 0 -t 30
```
By default, the results are in JSON. For more human-readable output add the --verbose flag. Verbose output looks similar to the following:
```
$ zaqar-bench --verbose

Starting producer (pp=1 , pw=10)...

Starting observer (op=1 , ow=5)...

Producer
========
duration_sec: 5.1
ms_per_req: 2.9
reqs_per_sec: 344.5
successful_reqs: 1742.0
total_reqs: 1742.0

Observer
========
duration_sec: 5.0
ms_per_req: 2.9
reqs_per_sec: 339.3
successful_reqs: 1706.0
total_reqs: 1706.0
```

3.3 KiB Raw Blame History

Running benchmark

Introduction

Usage

3.3 KiB

Raw Blame History