Skip to content

v3.3 User Guide

Jump to bottom
Andrey Kurilov edited this page Apr 4, 2017 · 11 revisions

Contents

  1. Configuration
    1.1. Configuration Syntax
    1.2. CLI Arguments Aliasing
    1.3. Parameterized Configuration
  2. Items
    2.1. Item Types
    2.1.1. Data Items
    2.1.1.1. Fixed Size Data Items
    2.1.1.1.1. Empty Data Items
    2.1.1.1.2. Small Data Items (1B-100KB)
    2.1.1.1.3. Intermediate Size Data Items (100KB-10MB)
    2.1.1.1.4. Big Data Items (10MB-100MB)
    2.1.1.1.5. Very Big Data Items (100MB-10GB)
    2.1.1.1.6. Huge Data Items (10GB-1TB)
    2.1.1.1.7. Ultimate Data Items (>=1TB)
    2.1.1.2. Random Size Data Items
    2.1.1.3. Biased Random Size Data Items
    2.1.2. Path Items
    2.1.3. Token Items
    2.2. Items Input
    2.2.1. Items Input File
    2.2.2. Items Path Listing Input
    2.2.3. New Items Input
    2.2.3.1. Random Item Ids
    2.2.3.2. Ascending Item Ids
    2.2.3.3. Descending Item Ids
    2.2.3.4. Items Id Prefix
    2.2.3.5. Items Id Radix
    2.2.3.6. Items Id Offset
    2.2.3.7. Items Id Length
    2.3. Items Output
    2.3.1. Items Output Delay
    2.3.2. Items Output File
    2.3.3. Items Destination Path
    2.3.3.1. Constant Items Destination Path
    2.3.3.2. Pattern Items Destination Path
  3. Content
    3.1. Uniform Random Data Payload
    3.2. Payload From the External File
  4. Concurrency
    4.1. Default Concurrency Level (1)
    4.2. Small Concurrency Level (2-10)
    4.3. Medium Concurrency Level (11-100)
    4.4. High Concurrency Level (101-1K)
    4.5. Very High Concurrency Level (1K-10K)
    4.6. Huge Concurrency Level (10K-100K)
    4.7. Ultimate Concurrency Level (100K-1M)
  5. Circularity
  6. Test Steps
    6.1. Test Steps Naming
    6.2. Test Steps Limitation
    6.2.1. Steps Are Infinite by Default
    6.2.2. Limit Step by Processed Item Count
    6.2.3. Limit Step by Rate
    6.2.4. Limit Step by Processed Data Size
    6.2.5. Limit Step by Time
    6.2.6. Limit Step by End of Items Input
  7. Metrics Reporting
    7.1. Metrics Periodic Reporting
    7.2. Metrics Reporting is Suppressed for the Precondition Steps
    7.3. Metrics Reporting Triggered by Load Threshold
    7.4. I/O Traces Reporting
  8. Load Types
    8.1. Noop
    8.2. Create
    8.2.1. Create New Items
    8.2.2. Copy Mode
    8.3. Read
    8.3.1. Read With Disabled Validation
    8.3.2. Read With Enabled Validation
    8.3.3. Partial Read
    8.3.3.1. Random Byte Ranges Read
    8.3.3.1.1. Single Random Byte Range Read
    8.3.3.1.2. Multiple Random Byte Ranges Read
    8.3.3.2. Fixed Byte Ranges Read
    8.3.3.2.1. Read From offset of N bytes to the end
    8.3.3.2.2. Read Last N bytes
    8.3.3.2.3. Read Bytes from N1 to N2
    8.3.3.2.4. Read Multiple Fixed Ranges
    8.4. Update
    8.4.1. Update by Overwrite
    8.4.2. Random Ranges Update
    8.4.2.1. Single Random Range Update
    8.4.2.2. Multiple Random Ranges Update
    8.4.3. Fixed Ranges Update
    8.4.3.1. Overwrite from the offset of N bytes to the end
    8.4.3.2. Overwrite Last N bytes
    8.4.3.3. Overwrite Bytes from N1 to N2
    8.4.3.4. Append
    8.4.3.5. Multiple Fixed Ranges Update
    8.5. Delete
  9. Scenarios
    9.1. Scenarios Syntax
    9.2. Default Scenario
    9.3. Custom Scenario File
    9.4. Step Configuration in the Scenario
    9.4.1. Override Default Configuration in the Scenario
    9.4.2. Step Configuration Inheritance
    9.4.3. Reusing The Items in the Scenario
    9.4.4. Environment Values Substitution in the Scenario
    9.5. Scenario Step Types
    9.5.1. Shell Command
    9.5.1.1. Blocking Shell Command
    9.5.1.2. Non-blocking Shell Command
    9.5.2. Load Step
    9.5.3. Precondition Load Step
    9.5.4. Parallel Step
    9.5.5. Sequential Step
    9.5.6. Loop Step
    9.5.6.1. Loop by Count
    9.5.6.2. Loop by Range
    9.5.6.3. Loop by Sequence
    9.5.6.4. Infinite Loop
    9.5.7. Mixed Load Step
    9.5.7.1. Separate Configuration in the Mixed Load Step
    9.5.7.2. Weighted Load Step
    9.5.8. Chain Load Step
    9.5.8.1. Separate Configuration in the Chain Load Step
    9.5.8.2. Delay Between Operations in the Chain Load Step
  10. Storage Driver
    10.1. Distributed Storage Drivers
    10.1.1. Single Local Separate Storage Driver Service
    10.1.2. Many Local Separate Storage Driver Services (at different ports)
    10.1.3. Single Remote Storage Driver Service
    10.1.4. Many Remote Storage Driver Services
    10.1.5. Large Count of Remote Storage Driver Services
    10.2. Configure the Storage
    10.2.1. Create Auth Token On Demand
    10.2.2. Create Destination Path On Demand
    10.3. Filesystem Storage Driver
    10.4. Network Storage Driver
    10.4.1. Node Balancing
    10.4.2. SSL/TLS
    10.4.3. Connection Timeout
    10.4.4. I/O Buffer Size Adjustment for Optimal Performance
    10.4.5. HTTP Storage Driver
    10.4.5.2. Atmos
    10.4.5.2.1. Authentication
    10.4.5.2.2. Filesystem access
    10.4.5.3. S3
    10.4.5.3.1. Authentication
    10.4.5.3.2. Filesystem access
    10.4.5.3.3. Versioning
    10.4.5.3.4. Multipart Upload
    10.4.5.4. Swift
    10.4.5.4.1. Authentication
    10.4.5.4.2. Versioning
    10.4.5.4.3. Create Dynamic Large Objects

1. Configuration

1.1. Configuration Syntax

TODO

1.2. CLI Arguments Aliasing

TODO

1.3. Parameterized Configuration

There's a couple of use cases utilizing the parameterized configuration feature. See examples below.

Dynamic HTTP headers with generated values:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-net-http-headers=myOwnHeaderName:MyOwnHeaderValue\ %d[0-1000]\ %f{###.##}[-2--1]\ %D{yyyy-MM-dd'T'HH:mm:ssZ}[1970/01/01-2016/01/01]

Dynamic files output path defined by some particular "width" (16) and "depth" (2):

java -jar <MONGOOSE_DIR>/mongoose.jar --item-output-path=/mnt/storage/%p\{16\;2\} --storage-driver-type=fs ...

Dynamic user id and bucket with aligned values:

{
	"type" : "load",
	"config" : {
		"item" : {
			"data" : {
				"size" : "10KB"
			},
			"output" : {
				"file" : "objects.csv",
				"path" : "bucket-%d(314159265){00}[0-99]"
			}
		},
		"storage" : {
			"auth" : {
				"file" : "credentials.csv",
				"uid" : "user-%d(314159265){00}[0-99]"
			},
			"driver" : {
				"concurrency" : 10,
				"type" : "s3"
			}
		},
		"test" : {
			"step" : {
				"limit" : {
					"count" : 10000
				}
			}
		}
	}
}

2. Items

A storage may be loaded using Items and some kind of operation (CRUD). The only thing which item has is a mutable name.

2.1. Item Types

Mongoose supports different item types:

  • A data (object, file) item
  • A path (directory, bucket, container) item
  • A token item

2.1.1. Data Items

The data items type is used by default.

2.1.1.1. Fixed Size Data Items

Fixed data item size is used by default.

2.1.1.1.1. Empty Data Items
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=0
2.1.1.1.2. Small Data Items (1B-100KB)
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=1
2.1.1.1.3. Intermediate Size Data Items (100KB-10MB)

The data items size of 1MB is used by default. Custom size example:

java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=100KB
2.1.1.1.4. Big Data Items (10MB-100MB)
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=10MB
2.1.1.1.5. Very Big Data Items (100MB-10GB)
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=1GB
2.1.1.1.6. Huge Data Items (10GB-1TB)
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=1TB
2.1.1.1.7. Ultimate Data Items (>=1TB)
java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=1PB

2.1.1.2. Random Size Data Items

java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=5MB-15MB

2.1.1.3. Biased Random Size Data Items

java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=0-100MB,0.2

2.1.2. Path Items

java -jar <MONGOOSE_DIR>/mongoose.jar --item-type=path

2.1.3. Token Items

java -jar <MONGOOSE_DIR>/mongoose.jar --item-type=token

2.2. Items Input

Items input is a source of the items which should be used to perform the operations (crete/read/etc). The items input may be a file or a path which should be listed.

2.2.1. Items Input File

java -jar <MONGOOSE_DIR>/mongoose.jar --item-input-file=<PATH_TO_ITEMS_FILE> ...

2.2.2. Items Path Listing Input

java -jar <MONGOOSE_DIR>/mongoose.jar --item-input-path=/bucket1 ...

2.2.3. New Items Input

2.2.3.1. Random Item Ids

Random item ids are used by default. The collision probability is highly negligible (2-63-1).

2.2.3.2. Ascending Item Ids

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-type=asc ...

2.2.3.3. Descending Item Ids

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-type=desc ...

2.2.3.4. Items Id Prefix

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-prefix=item_ ...

2.2.3.5. Items Id Radix

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-radix=10 ...

2.2.3.6. Items Id Offset

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-offset=12345 ...

2.2.3.7. Items Id Length

java -jar <MONGOOSE_DIR>/mongoose.jar --item-naming-length=13 ...

2.3. Items Output

2.3.1. Items Output Delay

The processed items info may be output with a specified delay. This may be useful to test a storage replication using the "chain" step (see the scenario step types for details). The configured delay is in seconds.

java -jar <MONGOOSE_DIR>/mongoose.jar --item-output-delay=60

2.3.2. Items Output File

java -jar <MONGOOSE_DIR>/mongoose.jar --item-output-file=items.csv

2.3.3. Items Destination Path

2.3.3.1. Constant Items Destination Path

java -jar <MONGOOSE_DIR>/mongoose.jar --item-output-path=/bucketOrContainerOrDir

2.3.3.2. Pattern Items Destination Path

java -jar <MONGOOSE_DIR>/mongoose.jar --item-output-path=/mnt/storage/%p\{16\;2\} ...

3. Content

While creating/verifying/updating the data items Mongoose is able to use different content sources. By default it uses the memory buffer filled with random data. Also Mongoose is able to fill this content source buffer with a data from any external file.

3.1. Uniform Random Data Payload

The uniform random data payload is used by default.

3.2. Payload From the External File

java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-content-file=<PATH_TO_CONTENT_FILE>

4. Concurrency

4.1. Default Concurrency Level (1)

The concurrency equal to 1 is used by default.

4.2. Small Concurrency Level (2-10)

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=10

4.3. Medium Concurrency Level (11-100)

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=100

4.4. High Concurrency Level (101-1K)

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=1000

4.5. Very High Concurrency Level (1K-10K)

Note:

System's max open files limit may be required to increased to use high concurrency levels:

ulimit -n 10000

Example:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=10000

4.6. Huge Concurrency Level (10K-100K)

Note:

System's max open files limit may be required to increased to use high concurrency levels:

ulimit -n 100000

Example:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=100000

4.7. Ultimate Concurrency Level (100K-1M)

Note:

System's max open files limit may be required to increased to use high concurrency levels:

ulimit -n 1048576

Example:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-concurrency=1000000

5. Circularity

"Circularity" forces the step to recycle the I/O tasks executing them again and again. It may be useful to perform read/update/append the objects/files multiple times each.

Note:

The circularity feature is applicable to read and update load types only.

Example:

java -jar <MONGOOSE_DIR>/mongoose.jar --load-circular

6. Test Steps

Test step is an unit of metrics reporting and test execution control.

For each test step:

  • total metrics are calculated and reported
  • limits are configured and controlled

6.1. Test Steps Naming

By default Mongoose generates the test step name containing the timestamp. The step name is used as the output log files parent directory name. It may be useful to override the default step name with a descriptive one.

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-name=myTest1

6.2. Test Steps Limitation

6.2.1. Steps Are Infinite by Default

A test step tries to execute eternally if its item input is infinite and no limits are configured.

6.2.2. Limit Step by Processed Item Count

To make a test step to process (CRUD) no more than 1000 items, for example:

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-limit-count=1000

6.2.3. Limit Step by Rate

It may be useful to limit the step's rate by a max number of operations per second. The rate limit value may be a real number, for example 0.01 (op/s).

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-limit-rate=1234.5

6.2.4. Limit Step by Processed Data Size

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-limit-size=123GB

6.2.5. Limit Step by Time

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-limit-time=15m

6.2.6. Limit Step by End of Items Input

Any test step configured with the valid items input should finish (at most) when all the items got from the input are processed (copied/read/updated/deleted). This is true only if test step is not configured to recycle the I/O tasks again and again (circularity feature is disabled).

java -jar <MONGOOSE_DIR>/mongoose.jar --item-input-[file|path]=<INPUT_FILE_OR_PATH> ...

In the example above, the test step will finish when all items from the specified items file are processed.

7. Metrics Reporting

7.1. Metrics Periodic Reporting

The default time interval between the metric outputs is 10s. This value may be changed.

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-metrics-period=1m

7.2. Metrics Reporting is Suppressed for the Precondition Steps

There may be precondition steps which doesn't produce the performance results, but execute some necessary work prior to the main test steps execution.

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-precondition

7.3. Metrics Reporting Triggered by Load Threshold

java -jar <MONGOOSE_DIR>/mongoose.jar --test-step-metrics-threshold=0.95

7.4. I/O Traces Reporting

There's an ability to log the info about every I/O operation been executed versus a storage. This kind of info is called "I/O trace". Edit the config/logging.json json configuration file, find the following section near the line # ~324:

				{
					"name": "ioTraceFile",
					"type": "loadJobFile",
					"fileName": "io.trace.csv",
					"PatternLayout": {
						"header": "StorageNode,ItemPath,IoTypeCode,StatusCode,ReqTimeStart[us],Duration[us],RespLatency[us],DataLatency[us],TransferSize\n",
						"pattern": "%m"
					},
					"Filters": {
						"Filter": [
							{
								"type": "MarkerFilter",
								"marker": "ioTrace",
								"onMatch": "NEUTRAL",
								"onMismatch": "DENY"
							},
							{
								"type": "ThresholdFilter",
								"level": "INFO",
								"onMatch": "ACCEPT",
								"onMismatch": "DENY"
							}
						]
					}
				}

Find out the "ThresholdFilter" sub section and change the level value on the next line from "INFO" to "DEBUG".

8. Load Types

8.1. Noop

The "dry run" operation type. Does everything except actual storage I/O. May be useful to measure the Mongoose's internal performance.

java -jar <MONGOOSE_DIR>/mongoose.jar --noop

8.2. Create

Create load type is used by default. The behavior may differ on the other configuration parameters.

8.2.1. Create New Items

"Create" performs writing new items to a storage by default.

8.2.2. Copy Mode

java -jar <MONGOOSE_DIR>/mongoose.jar --item-input-[file|path]=<INPUT_FILE_OR_PATH> --item-output-path=/bucketOrDir

8.3. Read

8.3.1. Read With Disabled Validation

Read operations don't perform a content validation by default.

java -jar <MONGOOSE_DIR>/mongoose.jar --read ...

8.3.2. Read With Enabled Validation

java -jar <MONGOOSE_DIR>/mongoose.jar --read --item-data-verify ...

8.3.3. Partial Read

8.3.3.1. Random Byte Ranges Read

8.3.3.1.1. Single Random Byte Range Read
java -jar mongoose.jar
	--read
	--item-data-ranges-random=1
	--item-input-file=items.csv
	...
8.3.3.1.2. Multiple Random Byte Ranges Read
java -jar mongoose.jar
	--read
	--item-data-ranges-random=5
	--item-input-file=items.csv
	...

8.3.3.2. Fixed Byte Ranges Read

8.3.3.2.1. Read from offset of N bytes to the end

Example: read the data items partially (from offset of 2KB to the end):

java -jar mongoose.jar
	--read
	--item-data-ranges-fixed=2KB-
	--item-input-file=items.csv
	...
8.3.3.2.2. Read Last N bytes

Example: read the last 1234 bytes of the data items:

java -jar mongoose.jar
	--read
	--item-data-ranges-fixed=-1234
	--item-input-file=items.csv
	...
8.3.3.2.3. Read Bytes from N1 to N2

Example: partially read the data items each in the range from 2KB to 5KB:

java -jar mongoose.jar
	--read
	--item-data-ranges-fixed=2KB-5KB
	--item-input-file=items.csv
	...
8.3.3.2.4. Read Multiple Fixed Ranges
java -jar mongoose.jar
	--read
	--item-data-ranges-fixed=0-1KB,2KB-5KB,8KB-
	--item-input-file=items.csv
	...

8.4. Update

8.4.1. Update by Overwrite

TODO

8.4.2. Random Ranges Update

8.4.2.1. Single Random Range Update

java -jar mongoose.jar
	--update
	--item-data-ranges-random=1
	--item-input-file=items2update.csv
	--item-output-file=items_updated.csv
	...

8.4.2.2. Multiple Random Ranges Update

Random ranges update example:

java -jar mongoose.jar
	--update
	--item-data-ranges-random=5
	--item-input-file=items2update.csv
	--item-output-file=items_updated.csv
	...

8.4.3. Fixed Ranges Update

8.4.3.1. Overwrite from the offset of N bytes to the end

java -jar mongoose.jar
	--update
	--item-data-ranges-fixed=2KB-
	--item-input-file=items2overwrite_tail2KBs.csv
	--item-output-file=items_with_overwritten_tails.csv
	...

8.4.3.2. Overwrite Last N bytes

Example: overwrite the last 1234 bytes of the data items:

java -jar mongoose.jar
	--update
	--item-data-ranges-fixed=-1234
	--item-input-file=items2overwrite_tail2KBs.csv
	--item-output-file=items_with_overwritten_tails.csv
	...

8.4.3.3. Overwrite Bytes from N1 to N2

Example: overwrite the data items in the range from 2KB to 5KB:

java -jar mongoose.jar
	--update
	--item-data-ranges-fixed=2KB-5KB
	--item-input-file=items2overwrite_range.csv
	--item-output-file=items_overwritten_in_the_middle.csv
	...

8.4.3.4. Append

Example: append 16KB to the data items:

java -jar mongoose.jar
	--update
	--item-data-ranges-fixed=-16KB-
	--item-input-file=items2append_16KB_tails.csv
	--item-output-file=items_appended.csv
	...

8.4.3.5. Multiple Fixed Ranges Update

java -jar mongoose.jar
	--update
	--item-data-ranges-fixed=0-1KB,2KB-5KB,8KB-
	--item-input-file=items2update.csv
	--item-output-file=items_updated.csv
	...

8.5. Delete

9. Scenarios

9.1. Scenarios Syntax

There are a JSON schema file in the distribution: scenario/scenario-schema.json. An user may automatically validate the scenarios using this schema. This should help to write one's own custom scenario correctly.

9.2. Default Scenario

By default Mongoose tries to execute the so called default scenario file (located at <MONGOOSE_DIR>scenario/default.json). This scenario contains only one load step.

9.3. Custom Scenario File

java -jar <MONGOOSE_DIR>/mongoose.jar --test-scenario-file=myCustomScenario.json

9.4. Step Configuration in the Scenario

9.4.1. Override Default Configuration in the Scenario

{
   "type" : "load",
   "config" : {
      // here are the configuration hierarchy
   }
}

9.4.2. Step Configuration Inheritance

{
   "type" : "sequential",
   "config" : {
      // the configuration specified here will be inherited by the container elements
   },
   "steps" : [
      {
         "type" : "load",
         ...
      }
      ...
   ]
}

9.4.3. Reusing The Items in the Scenario

{
   "type" : "sequential",
   "steps" : [
      {
         "type" : "precondition",
         "config" : {
            "item" : {
               "output" : {
                  "file" : "items.csv"
               }
            }
            ...
         }
      }, {
         "type" : "",
         "config" : {
            "item" : {
               "input" : {
                  "file" : "items.csv"
               }
            }
            ...
         }
      }
   ]
}

9.4.4. Environment Values Substitution in the Scenario

TODO

9.5. Scenario Step Types

9.5.1. Shell Command

9.5.1.1. Blocking Shell Command

Sleep between the steps for example:

{
   "type" : "sequential",
   "config" : {
      // shared configuration values inherited by the sub steps
   },
   "steps" : [
      {
         "type" : "load",
         "config" : {
            // specific configuration for the 1st step
         }
      },
      {
         "type" : "command",
         "value" : "sleep 5s"
      },
      {
         "type" : "load",
         "config" : {
            // specific configuration for the 2nd step
         }
      }
   ]
}

9.5.1.2. Non-blocking Shell Command

{
   "type" : "command",
   "value" : "find /",
   "blocking" : false
}

9.5.2. Load Step

TODO

9.5.3. Precondition Load Step

{
   "type" : "precondition",
   "config" : {
      // here are the configuration hierarchy
   }
}

9.5.4. Parallel Step

{
   "type" : "parallel",
   "steps" : [
      {
         "type" : "",
         ...
      }, {
         "type" : "",
         ...
      }
      ...
   ]
}

9.5.5. Sequential Step

{
   "type" : "sequential",
   "steps" : [
      {
         "type" : "",
         ...
      }, {
         "type" : "",
         ...
      }
      ...
   ]
}

9.5.6. Loop Step

9.5.6.1. Loop by Count

{
    "type" : "for",
    "value" : 10,
    "steps" : [
        {
            "type" : "load"
        }
    ]
}

9.5.6.2. Loop by Range

{
    "type" : "for",
    "value" : "i",
    "in" : "2.71828182846-3.1415926,0.1",
    "steps" : [
        {
            "type" : "command",
            "value" : "echo ${i}"
        }
    ]
}

9.5.6.3. Loop by Sequence

{
   "type" : "for",
   "value" : "concurrency",
   "in" : [
      1, 10, 100, 1000, 10000, 100000
   ],
   "config" : {
      "load" : {
         "concurrency" : "${concurrency}"
      }
   },
   "steps" : [
      {
            "type" : "load"
      }
   ]
}

9.5.6.4. Infinite Loop

{
   "type" : "for",
   "steps" : [
      {
            "type" : "load"
      }
   ]
}

9.5.7. Mixed Load Step

For details see mixed and weighted load specification.

9.5.7.1. Separate Configuration in the Mixed Load Step

TODO

9.5.7.2. Weighted Load Step

TODO

9.5.8. Chain Load Step

For details see chain operations specification.

9.5.8.1. Separate Configuration in the Chain Load Step

The delay in the example below is 1 minute. Minimum configurable delay is 1 second.

{
	"type" : "chain",
	"config" : [
		{
			"item" : {
				"output" : {
					"delay" : "1m",
					"path" : "/default"
				}
			},
			"load" : {
				"metrics" : {
					"trace" : {
						"itemInfo" : true,
						"reqTimeStart" : true,
						"duration" : true
					}
				}
			}
		},
		{
			"load" : {
				"type" : "read"
			}
		}
	]
}

9.5.8.2. Delay Between Operations in the Chain Load Step

{
	"type" : "chain",
	"config" : [
		{
			"item" : {
				"output" : {
					"delay" : "1m",
					"path" : "/default"
				}
			},
			"storage" : {
			    "net" : {
                    "node" : {
                        "addrs" : [
                            "10.123.45.67",
                            "10.123.45.68",
                            "10.123.45.69",
                            "10.123.45.70"
                        ]
                    }
                }
			}
		},
		{
			"load" : {
				"type" : "read"
			},
            "storage" : {
                "net" : {
                    "node" : {
                        "addrs" : [
                            "10.234.56.78",
                            "10.234.56.79",
                            "10.234.56.80",
                            "10.244.56.81"
                        ]
                    }
                }
            }
		}
	]
}

10. Storage Driver

Currently the storage driver supports some cloud storages or a filesystem

10.1. Distributed Storage Drivers

Mongoose is able to work in the so called distributed mode what allows to scale out the load performed on a storage. In the distributed mode there's a instance controlling the distributed load execution progress. This instance usually called "controller" and usually should be running on a dedicated host. The controller aggregates the results from the remote (usually) storage driver services which perform the actual load on the storage.

10.1.1. Single Local Separate Storage Driver Service

How to:

  • Start the storage driver service:
java -jar <MONGOOSE_DIR>/mongoose-storage-driver-service.jar
  • Start the controller:
java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-remote ...

10.1.2. Many Local Separate Storage Driver Services (at different ports)

  • Start the 1st storage driver service:
java -jar <MONGOOSE_DIR>/mongoose-storage-driver-service.jar --storage-driver-port=1099
  • Start the 1st storage driver service:
java -jar <MONGOOSE_DIR>/mongoose-storage-driver-service.jar --storage-driver-port=1100
  • Start the controller:
java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-driver-remote
	--storage-driver-addrs=127.0.0.1:1099,127.0.0.1:1100
	...

10.1.3. Single Remote Storage Driver Service

  • Start the storage driver service on one host:
java -jar <MONGOOSE_DIR>/mongoose-storage-driver-service.jar
  • Start the controller on another host:
java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-driver-remote
	--storage-driver-addrs=<DRIVER_IP_ADDR>
	...

10.1.4. Many Remote Storage Driver Services

  • Start the storage driver service on each host using the following command:
java -jar <MONGOOSE_DIR>/mongoose-storage-driver-service.jar
  • Start the controller on another host:
java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-driver-remote
	--storage-driver-addrs=<DRIVER1>,<DRIVER2>,...

10.1.5. Large Count of Remote Storage Driver Services

TODO

10.2. Configure the Storage

Users would like to not to care if some configuration parameters are not specified explicitly or a target storage is not fully prepared for the test. For example missing bucket (S3), subtenant (Atmos), target directory, etc. Mongoose will try to configure/create such things automatically on demand and cache them for further reuse by other I/O tasks.

Note:

Mongoose test step creates a kind of knowledge about the storage which may become irrelevant. For example, Mongoose creates/checks the target bucket once and remembers the result. If the bucket is deleted by 3rd side during the Mongoose test step it will continue to consider the bucket existing despite the arising failures.

10.2.1. Create Auth Token On Demand

If no authentication token is specified/exists Mongoose tries to create it. This functionality is currently implemented for Atmos and Swift storage drivers.

10.2.2. Create Destination Path On Demand

If no output path is specified/exists Mongoose tries to create it (create destination directory/bucket/container). This functionality is currently implemented for filesystem, S3 and Swift storage drivers.

10.3. Filesystem Storage Driver

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-driver-type=fs ...

10.4. Network Storage Driver

10.4.1. Node Balancing

Mongoose uses the round-robin way to distribute I/O tasks if multiple storage endpoints are used. If a connection fail Mongoose will try to distribute the active connections equally among the endpoints.

10.4.2. SSL/TLS

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-net-ssl --storage-net-node-port=9021 ...

10.4.3. Connection Timeout

Sometimes the test is run against the storage via network and the storage endpoint may fail to react on a connection. Mongoose should fail such I/O task and continue to go on. There's an ability to set a response timeout which allows to interrupt the I/O task and continue to work.

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-net-timeoutMillisec=100000 ...

10.4.4. I/O Buffer Size Adjustment for Optimal Performance

Mongoose automatically adopts the input and output buffer sizes depending on the step info. For example, for create I/O type the input buffer size is set to the minimal value (4KB) and the output buffer size is set to configured data item size (if any). If read I/O type is used the behavior is right opposite - specific input buffer size and minimal output buffer size. This improves the I/O performance significantly. But users may set the buffer sizes manually.

Example: setting the input buffer to 100KB:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-net-rcvBuf=100KB ...

Example: setting the output buffer to 10MB:

java -jar <MONGOOSE_DIR>/mongoose.jar --storage-net-sndBuf=10MB ...

10.4.5. HTTP Storage Driver

10.4.5.2. Atmos

Note:

  • Input/output paths are not used unless the filesystem access is not configured.
10.4.5.2.1. Authentication

An Atmos storage uses the signed requests to authenticate each of them. To sign the requests correctly Mongoose requires the correct auth id, secret and the system time differentiating the storage system time no more then 15 minutes.

Note:

  • The default value of "auth-id" configuration parameter (null) doesn't work in the case of Atmos API usage.
  • Mongoose will try to create the subtenant if the subtenant value is not specified.
java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-auth-uid=<USER_ID>
	--storage-auth-secret=<SECRET>
	[--storage-auth-token=<SUBTENANT>]
	--storage-net-node-port=8080
	--storage-driver-type=atmos
	...
10.4.5.2.2. Filesystem access

TODO

10.4.5.3. S3

Note:

S3 API is used by default Specifying the input/output path in the case of S3 API means specifying the bucket to use.

10.4.5.3.1. Authentication

An S3 storage uses the signed requests to authenticate each of them. To sign the requests correctly Mongoose requires the correct auth id, secret and the system time differentiating the storage system time no more then 15 minutes.

java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-auth-uid=<USER_ID>
	--storage-auth-secret=<SECRET>
	--storage-net-node-port=<PORT>
	...
10.4.5.3.2. Filesystem access

TODO

10.4.5.3.3. Versioning

TODO

10.4.5.3.4. Multipart Upload

The following example will perform the uploading the 1GB objects using 100MB parts.

java -jar <MONGOOSE_DIR>/mongoose.jar --item-data-size=1GB --item-data-ranges-threshold=100MB ...

10.4.5.4. Swift

Note:

Specifying the input/output paths means specifying the input/ouput container in case of Swift.

10.4.5.4.1. Authentication

Mongoose uses the v1 authentication way: generating the token once and using it for the requests. If the existing authentication token is not specified Mongoose will try to create it.

java -jar <MONGOOSE_DIR>/mongoose.jar
	--storage-auth-uid=<USER_ID>
	--storage-auth-secret=<SECRET>
	[--storage-auth-token=<AUTH_TOKEN>]
	--storage-net-node-port=8080
	--storage-driver-type=swift
	...
10.4.5.4.2. Versioning

TODO

10.4.5.4.3. Create Dynamic Large Objects
java -jar <MONGOOSE_DIR>/mongoose.jar
	--item-data-size=1GB
	--item-data-ranges-threshold=100MB
	--storage-driver-type=swift ...

About

Documentation

Development

Notes

Archive

Links

Clone this wiki locally