Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix refactored core structure references #1671

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/concepts/caliper-messengers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Caliper uses an orchestrator to control workers that interact with the SUT in or

## Messengers

The messaging protocol to be used for communications between the orchestrator and worker during a benchmark is declared in the `caliper runtime configuration file`. Unspecified values will default to those specified in the [default configuration file](https://github.com/hyperledger-caliper/caliper/blob/main/packages/caliper-core/lib/config/default.yaml).
The messaging protocol to be used for communications between the orchestrator and worker during a benchmark is declared in the `caliper runtime configuration file`. Unspecified values will default to those specified in the [default configuration file](https://github.com/hyperledger-caliper/caliper/blob/main/packages/caliper-core/lib/common/config/default.yaml).

Permitted messengers are:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/concepts/logging-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Caliper builds on the [winston](https://github.com/winstonjs/winston) logger mod

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/caliper/blob/v0.6.0/packages/caliper-core/lib/config/default.yaml) bundled with Caliper for the general structure of the settings.
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/caliper/blob/v0.6.0/packages/caliper-core/lib/common/config/default.yaml) bundled with Caliper for the general structure of the settings.

## Customizing the logging style

Expand Down
2 changes: 1 addition & 1 deletion docs/source/concepts/rate-controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ You can set the `type` attribute so that it points to your custom JS file that s
3. A `workerIndex` parameter of type number that is the 0-based index of the worker process using this rate controller.
The function must return an object (i.e., your rate controller instance) that satisfies the next criteria.

2. The object returned by `createRateController` must implement the `/packages/caliper-core/lib/rate-control/rateInterface.js` interface, i.e., must provide the following async functions:
2. The object returned by `createRateController` must implement the `/packages/caliper-core/lib/worker/rate-control/rateInterface.js` interface, i.e., must provide the following async functions:
1. applyRateControl , for performing the actual rate control by “blocking” the execution (in an async manner) for the desired time.
2. `end`, for disposing any acquired resources at the end of a round.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/connectors/ethereum-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ To query a state on a contract state, set the `readOnly` attribute to `true`. Th

## Transaction Data Gathered by the Adapter

The previously discussed `sendRequests` method returns an array whose elements correspond to the result of the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger/caliper/blob/v0.6.0/packages/caliper-core/lib/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.
The previously discussed `sendRequests` method returns an array whose elements correspond to the result of the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger/caliper/blob/v0.6.0/packages/caliper-core/lib/common/core/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.

The standard information provided by the type are the following:

Expand Down
6 changes: 3 additions & 3 deletions docs/source/connectors/fabric-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ await this.sutAdapter.sendRequests(requestSettings);

## Gathered TX data

The previously discussed `sendRequests` function returns the result (or an array of results) for the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger-caliper/caliper/blob/v0.6.0/packages/caliper-core/lib/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.
The previously discussed `sendRequests` function returns the result (or an array of results) for the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger-caliper/caliper/blob/v0.6.0/packages/caliper-core/lib/common/core/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.

The standard data provided are the following:
- `GetID():string` returns the transaction ID.
Expand Down Expand Up @@ -239,7 +239,7 @@ The `cleanupWorkloadModule` function is called at the end of the round, and can
## Network configuration file reference
The YAML network configuration file of the adapter mainly describes the organizations and the identities associated with those organizations, It also provides explicit information about the channels in your Fabric network and the chaincode (containing 1 or more smart contracts) deployed to those channels. It can reference Common Connection Profiles for each organization (as common connection profiles are specific to a single organization). These are the same connection profiles that would be consumed by the node-sdk. Whoever creates the Fabric network and channels would be able to provide appropriate profiles for each organization.

The following sections detail each part separately. For a complete example, please refer to the [example section](#network-configuration-example) or one of the files in the [Caliper repositor](https://github.com/hyperledger-caliper/caliper), such as the caliper-fabric test folder.
The following sections detail each part separately. For a complete example, please refer to the [example section](#network-configuration-example) or one of the files in the [Caliper repository](https://github.com/hyperledger-caliper/caliper), such as the caliper-fabric test folder.

<details>
<summary><b>name</b></summary>
Expand Down Expand Up @@ -1057,4 +1057,4 @@ organizations:

## License

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/).
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