IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc link fixes - made compatible with the site generator by explicitly qualifying anchor names

Browse Source
This commit is contained in:
Jonathan Shook
2023-09-10 14:54:24 -05:00
parent 186e87ac1b
commit 5d0a890e28
3 changed files with 61 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
adapter-amqp/src/main/resources/amqp.md
View File

@@ -4,16 +4,16 @@ title: AMQP
---
- [1. Overview](#1-overview)
- [2. NB AMQP Usage](#2-nb-amqp-usage)
- [2.1. Workload Definition](#21-workload-definition)
- [2.1.1. Named Scenarios](#211-named-scenarios)
- [2.2. CLI parameters](#22-cli-parameters)
- [2.3. Configuration Properties](#23-configuration-properties)
- [2.3.1. Global Properties File](#231-global-properties-file)
- [2.3.2. Scenario Document Level Properties](#232-scenario-document-level-properties)
- [2.1. Workload Definition](#21-workload-definition)
- [2.1.1. Named Scenarios](#211-named-scenarios)
- [2.2. CLI parameters](#22-cli-parameters)
- [2.3. Configuration Properties](#23-configuration-properties)
- [2.3.1. Global Properties File](#231-global-properties-file)
- [2.3.2. Scenario Document Level Properties](#232-scenario-document-level-properties)
---
# 1. Overview
# 1. Overview {#1-overview}
The NB AMQP adapter allows sending messages to or receiving messages from
* an AMQP 0-9-1 based server (e.g. RabbitMQ), or
@@ -22,17 +22,17 @@ The NB AMQP adapter allows sending messages to or receiving messages from
At high level, this adapter supports the following AMQP 0-9-1 functionalities
* Creating AMQP connections and channels
* Declaring AMQP exchanges
* The following exchange types are supported: `direct`, `fanout`, `topic`, and `headers`
* The following exchange types are supported: `direct`, `fanout`, `topic`, and `headers`
* Sending messages to AMQP exchanges with sync. or async. publisher confirms
* For sync confirms, it supports both single and batch confirms
* Supports message-send based on routing keys
* For sync confirms, it supports both single and batch confirms
* Supports message-send based on routing keys
* Declaring and binding AMQP queues
* Supports message-receive based on binding keys
* Supports message-receive based on binding keys
* Receiving messages from AMQP queues with async. consumer acks
# 2. NB AMQP Usage
# 2. NB AMQP Usage {#2-nb-amqp-usage}
## 2.1. Workload Definition
## 2.1. Workload Definition {#21-workload-definition}
There are two main types of workloads supported by this adapter:
* Message sender workload (see [amqp_msg_sender.yaml](scenarios/amqp_msg_sender.yaml))
@@ -53,7 +53,7 @@ $ <nb_cmd> run driver=amqp -vv cycles=200 strict_msg_error_handling=0 \
config=/path/to/amqp_config.properties
```
### 2.1.1. Named Scenarios
### 2.1.1. Named Scenarios {#211-named-scenarios}
For workload execution convenience, NB engine has the concept of **named scenario** ([doc](https://docs.nosqlbench.io/workloads-101/11-named-scenarios/)).
@@ -68,7 +68,7 @@ $ <nb_cmd> nbamqp_msg_proc_named msg_send
$ <nb_cmd> nbamqp_msg_proc_named msg_recv
```
## 2.2. CLI parameters
## 2.2. CLI parameters {#22-cli-parameters}
The following CLI parameters are unique to this adapter:
@@ -77,12 +77,12 @@ The following CLI parameters are unique to this adapter:
* `num_exchange`: the number of AMQP exchanges to create for each channel
* `num_queue`: the number of AMQP queues to create for each channel (only relevant for message receiver workload)
* `num_msg_client`: the number of message clients to create for each channel
* for message sender workload, it is the number of message publishers for each exchange
* for message receiver workload, it is the number of message consumers for each queue
* for message sender workload, it is the number of message publishers for each exchange
* for message receiver workload, it is the number of message consumers for each queue
## 2.3. Configuration Properties
## 2.3. Configuration Properties {#23-configuration-properties}
### 2.3.1. Global Properties File
### 2.3.1. Global Properties File {#231-global-properties-file}
A global AMQP properties file can be specified via the `config` CLI parameter. It includes the following required properties:
* `amqpSrvHost`: AMQP server host (e.g. An Astra Streaming cluster with S4R enabled)
@@ -95,15 +95,15 @@ A global AMQP properties file can be specified via the `config` CLI parameter. I
An example of this file can be found from: [amqp_config.properties](conf/amqp_config.properties)
### 2.3.2. Scenario Document Level Properties
### 2.3.2. Scenario Document Level Properties {#232-scenario-document-level-properties}
For message sender workload, the following Document level configuration parameters are supported in the YAML file:
* `publisher_confirm`: whether to use publisher confirms
* `confirm_mode`: When `publisher_confirm` is true, the following 3 confirm modes are supported:
* `individual`: wait for confirm individually
* `batch`: wait for confirm in batch
* `async`: [default] no wait for confirm
* `individual`: wait for confirm individually
* `batch`: wait for confirm in batch
* `async`: [default] no wait for confirm
* `confirm_batch_num`: batch size for waiting for **sync** publisher confirms
* Only relevant when `publisher_confirm` is true and `confirm_mode` is "batch"
* Only relevant when `publisher_confirm` is true and `confirm_mode` is "batch"
* `dft_confirm_timeout_ms`: default timeout in milliseconds for waiting publisher confirms
* Only relevant when `publisher_confirm` is true and `confirm_mode` is "individual" or "batch"
* Only relevant when `publisher_confirm` is true and `confirm_mode` is "individual" or "batch"