Skip to content

Commit

Permalink
removed absolute links
Browse files Browse the repository at this point in the history
Signed-off-by: Prati28 <sankhepratiksha3@gmail.com>
  • Loading branch information
psankhe28 committed Sep 21, 2024
1 parent 0f78b3f commit f32fb10
Show file tree
Hide file tree
Showing 17 changed files with 140 additions and 141 deletions.
25 changes: 12 additions & 13 deletions docs/source/concepts/bench-config.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# Benchmark Configuration

## Overview
The `benchmark configuration file` is one of the [required configuration](https://hyperledger.github.io/caliper/v0.6.0/reference/runtime-config/) files necessary to run a Caliper benchmark. In contrast to the runtime configurations, used for tweaking the internal behavior of Caliper, the benchmark configuration pertains only to the execution of the benchmark workload and collection of the results.
The `benchmark configuration file` is one of the [required configuration](runtime-config.md) files necessary to run a Caliper benchmark. In contrast to the runtime configurations, used for tweaking the internal behavior of Caliper, the benchmark configuration pertains only to the execution of the benchmark workload and collection of the results.

!!! note

*In theory, a benchmark configuration is independent of the system under test (SUT) and the internal configuration of Caliper. However, this independence might be limited by the implementation details of the benchmark workload module, which could target only a single SUT type.*

The benchmark configuration consists of three main parts:

- [Table of contents](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#table-of-contents)
- [Overview](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#overview)
- [Benchmark test settings](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#benchmark-test-settings)
- [Monitoring settings](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#monitoring-settings)
- [Example](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#example)
- [License](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#license)
- [Overview](#overview)
- [Benchmark test settings](#benchmark-test-settings)
- [Monitoring settings](#monitoring-settings)
- [Example](#example)
- [License](#license)

For a complete benchmark configuration example, refer to the [last section](https://hyperledger.github.io/caliper/v0.6.0/overview/bench-config/#example).
For a complete benchmark configuration example, refer to the [last section](#example).

!!! note

Expand All @@ -36,16 +35,16 @@ The settings related to the benchmark workload all reside under the root `test`
| test.rounds[i].label | A short name of the rounds, usually corresponding to the types of submitted TXs. |
| test.rounds[i].txNumber | The number of TXs Caliper should submit during the round. |
| test.rounds[i].txDuration | The length of the round in seconds during which Caliper will submit TXs. |
| test.rounds[i].rateControl | The object describing the [rate controller](https://hyperledger.github.io/caliper/v0.6.0/reference/rate-controllers/) to use for the round. |
| test.rounds[i].workload | The object describing the [workload module](https://hyperledger.github.io/caliper/v0.6.0/overview/workload-module/) used for the round. |
| test.rounds[i].rateControl | The object describing the [rate controller](rate-controllers.md) to use for the round. |
| test.rounds[i].workload | The object describing the [workload module](workload-module.md) used for the round. |
| test.rounds[i].workload.module | The path to the benchmark workload module implementation that will construct the TXs to submit. |
| test.rounds[i].workload.arguments | Arbitrary object that will be passed to the workload module as configuration. |

A benchmark configuration with the above structure will define a benchmark run that consists of multiple rounds. Each round is associated with a [rate controller](https://hyperledger.github.io/caliper/v0.6.0/reference/rate-controllers/) that is responsible for the scheduling of TXs, and a [workload module](https://hyperledger.github.io/caliper/v0.6.0/overview/workload-module/) that will generate the actual content of the scheduled TXs.
A benchmark configuration with the above structure will define a benchmark run that consists of multiple rounds. Each round is associated with a [rate controller](rate-controllers.md) that is responsible for the scheduling of TXs, and a [workload module](workload-module.md) that will generate the actual content of the scheduled TXs.

## Monitoring settings

The monitoring configuration determines what kind of metrics the manager process can gather and from where. The configuration resides under the `monitors` attribute. Refer to the [monitors configuration page](https://hyperledger.github.io/caliper/v0.6.0/reference/caliper-monitors/) for the details.
The monitoring configuration determines what kind of metrics the manager process can gather and from where. The configuration resides under the `monitors` attribute. Refer to the [monitors configuration page](caliper-monitors.md) for the details.

## Example

Expand Down Expand Up @@ -105,4 +104,4 @@ monitors:

## License

The Caliper codebase is released under the [Apache 2.0 license](https://hyperledger.github.io/caliper/v0.6.0/general/license/). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
The Caliper codebase is released under the [Apache 2.0 license](../getting-started/license.md). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
4 changes: 2 additions & 2 deletions docs/source/concepts/benchmark-generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Now for the callback file...
### Configuration Prompts
Next, you will be taken through generating the [configuration file](https://hyperledger.github.io/caliper/v0.6.0/benchmark-generator/Architecture#ConfigurationFile) and you will be prompted for:
Next, you will be taken through generating the configuration file and you will be prompted for:
- the **name** of the benchmark
- a **description** of the benchmark
Expand Down Expand Up @@ -171,4 +171,4 @@ The generator only generates a single callback file for a single smart contract
## License
The Caliper codebase is released under the [Apache 2.0 license](https://hyperledger.github.io/caliper/v0.6.0/general/license/). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
The Caliper codebase is released under the [Apache 2.0 license](../getting-started/license.md). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
2 changes: 1 addition & 1 deletion docs/source/concepts/caliper-messengers.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ If not specifying a `caliper.yaml` configuration file, the above may be specifie

## License

The Caliper codebase is released under the [Apache 2.0 license](https://hyperledger.github.io/caliper/v0.6.0/general/license/). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
The Caliper codebase is released under the [Apache 2.0 license](../getting-started/license.md). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
2 changes: 1 addition & 1 deletion docs/source/concepts/caliper-monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,4 +369,4 @@ monitors:

## License

The Caliper codebase is released under the [Apache 2.0 license](https://hyperledger.github.io/caliper/v0.6.0/general/license/). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
The Caliper codebase is released under the [Apache 2.0 license](../getting-started/license.md). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
16 changes: 8 additions & 8 deletions docs/source/concepts/logging-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Caliper builds on the [winston](https://github.com/winstonjs/winston) logger mod
2. Configuring logging targets
3. Creating your own loggers

The first two points can be achieved through the [runtime configuration](https://hyperledger.github.io/caliper/v0.6.0/reference/runtime-config/) mechanism of Caliper. So make sure that you are familiar with the different way of overriding runtime settings before reading on. The examples below only set the different options through the command line. Naturally, any other setting source could be used.
The first two points can be achieved through the [runtime configuration](runtime-config.md) mechanism of Caliper. So make sure that you are familiar with the different way of overriding runtime settings before reading on. The examples below only set the different options through the command line. Naturally, any other setting source could be used.

The runtime configuration settings corresponding to logging reside under the `caliper-logging` key hierarchy. See the `caliper.logging` section of the [default configuration file](https://github.com/hyperledger/caliper/blob/v0.6.0/packages/caliper-core/lib/config/default.yaml) bundled with Caliper for the general structure of the settings.

Expand Down Expand Up @@ -54,7 +54,7 @@ You can override this template by changing the caliper-logging-template setting
This template if applied after every format has been applied!
</li>
<li>
Adding spaces and different brackets this way is fine for simple coloring scenarios (or when coloring is disabled). However, when coloring the entire log message (or just parts that should be surrounded with additional characters), the result looks inconsistent when formatted this way. See the <a href="https://hyperledger.github.io/caliper/v0.6.0/reference/logging/#tips--tricks">Tips & Tricks</a> section for advanced message formatting scenarios.
Adding spaces and different brackets this way is fine for simple coloring scenarios (or when coloring is disabled). However, when coloring the entire log message (or just parts that should be surrounded with additional characters), the result looks inconsistent when formatted this way. See the <a href="#tips-tricks">Tips & Tricks</a> section for advanced message formatting scenarios.
</li>
</ol>
</div>
Expand All @@ -71,7 +71,7 @@ The following formats and their options (sub-properties) are supported.

!!! note

*the different formats are applied in the order they are presented, which is important (see the [Tips & Tricks](https://hyperledger.github.io/caliper/v0.6.0/reference/logging/#tips--tricks) section for the reason).*
*the different formats are applied in the order they are presented, which is important (see the [Tips & Tricks](#tips-tricks) section for the reason).*

#### Timestamp

Expand Down Expand Up @@ -103,7 +103,7 @@ For example: `--caliper-logging-formats-json="{space:0}"`
<strong>Note:</strong>
<ol>
<li>
Enabling this format is easier from a configuration file. See the <a href="https://hyperledger.github.io/caliper/v0.6.0/reference/logging/#tips--tricks">Tips & Tricks</a> section.
Enabling this format is easier from a configuration file. See the <a href="#tips-tricks">Tips & Tricks</a> section.
</li>
<li>
Setting <code>space</code> to a non-zero number will effectively format the JSON output with indentations on multiple lines. This could “spam” the console a bit (not a problem for log files, unless you care about the extra newlines).
Expand Down Expand Up @@ -227,7 +227,7 @@ For example, to disable the `mylogger1` target, the following approaches are ava

### Overriding logger target settings

But what if you would like to modify one of the options of a transport? You can use a [configuration file](https://hyperledger.github.io/caliper/v0.6.0/reference/untime-config/#configuration-files) for that!
But what if you would like to modify one of the options of a transport? You can use a [configuration file](runtime-config.md/#configuration-files) for that!

For the next example, we will disable the default file logger, modify the logging level of the console target, and also add a new daily rotating file logger. We can do all of this with a single configuration file.

Expand Down Expand Up @@ -270,7 +270,7 @@ If you save the above content as `caliper.yaml` in your workspace directory, the

1. We only set the properties we wanted to override. The default configuration file will be merged with the above configuration file, the values in the latter taking precedence.
2. The provided options for a transport are not verified by Caliper. It is simple passed to the specific transport. It is your responsibility to configure the transport the right way.
3. We could have disabled the file logger also from the command line, or from an environment variable. The reason we did it from a config file is explained in the [Tips & tricks](https://hyperledger.github.io/caliper/v0.6.0/reference/logging/#tips--tricks) section.
3. We could have disabled the file logger also from the command line, or from an environment variable. The reason we did it from a config file is explained in the [Tips & tricks](#tips-tricks) section.

## Creating your own loggers

Expand Down Expand Up @@ -477,7 +477,7 @@ To this end, the ability to override the logging style settings from the command
The easiest way to do that is with a project-level configuration file. If you name the following file `caliper.yaml` and place it in your workspace root, then Caliper will automatically apply the settings.

!!! note
there are other ways to load a configuration file, as discussed in the [runtime configuration page](https://hyperledger.github.io/caliper/v0.6.0/runtime-config/#configuration-files).
there are other ways to load a configuration file, as discussed in the [runtime configuration page](runtime-config.md/#configuration-files).

```sh
caliper:
Expand Down Expand Up @@ -511,4 +511,4 @@ caliper:

## License

The Caliper codebase is released under the [Apache 2.0 license](https://hyperledger.github.io/caliper/v0.6.0/general/license/). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
The Caliper codebase is released under the [Apache 2.0 license](../getting-started/license.md). Any documentation developed by the Caliper Project is licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/).
Loading

0 comments on commit f32fb10

Please sign in to comment.