Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alexander Bigerl <[email protected]>
  • Loading branch information
nck-mlcnv and bigerl authored Mar 27, 2024
1 parent df82cf2 commit a291472
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ It is mostly designed for benchmarking triplestores by using the SPARQL protocol
Iguana stresstests endpoints by simulating users which send a set of queries independently of each other.

Benchmarks are configured using a YAML-file, this allows them to be easily repeated and adjustable.
Results are stored in RDF-files or in easier to read CSV-files.
Results are stored in RDF-files and can also be exported as CSV-files.

## Features
- Benchmarking of (SPARQL) HTTP endpoints
- Easy configuration
- Reusable configuration
- Calculation of various metrics for better comparisons
- Processing of HTTP responses (e.g., results counting)

Expand Down
5 changes: 2 additions & 3 deletions docs_new/configuration/metrics.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Metrics

Metrics are used to measure and compare the performance of the system during the stresstest.
They are divided into Task metrics, Worker metrics, and Query metrics.
They are divided into task metrics, worker metrics, and query metrics.

Task metrics are calculated for every query execution across the whole task.
Worker metrics are calculated for every query execution of one worker.
Query metrics are calculated for every execution of one query across one worker and across every worker.

The differences between the task, worker and query metrics will be more apparent with the
exploratory explanation for the rdf results [here](./rdf_results.md).
For a detailed description how results for tasks, workers and queries are reported in the RDF result file, please refer to the section (RDF results](rdf_results.md).

## Configuration

Expand Down
3 changes: 1 addition & 2 deletions docs_new/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## Structure

The configuration file for a benchmark suite can either be `yaml`-file or a `json`-file.
We would recommend creating the configuration with a `yaml`-file as it is more human-readable and easier to write.
The configuration file for a benchmark suite can either be `yaml`-file or a `json`-file. YAML is recommended and all examples will be presented as YAML.

The configuration file consists of the following six sections:
- [Datasets](#Datasets)
Expand Down
2 changes: 1 addition & 1 deletion docs_new/configuration/storages.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ similar to the rdf file storage.

It has the following properties:

- `endpoint`: The endpoint of the triplestore.
- `endpoint`: The update endpoint of the triplestore.
- `username`: The username for the authentication of the triplestore.
- `password`: The password for the authentication of the triplestore.

Expand Down

0 comments on commit a291472

Please sign in to comment.