org.apache.jackrabbit.oak.scalability.suites

Class ScalabilityNodeSuite

java.lang.Object

org.apache.jackrabbit.oak.scalability.suites.ScalabilityAbstractSuite

org.apache.jackrabbit.oak.scalability.suites.ScalabilityNodeSuite

All Implemented Interfaces:

CSVResultGenerator, ScalabilitySuite

Direct Known Subclasses:

ScalabilityBlobSearchSuite, ScalabilityNodeRelationshipSuite

public class ScalabilityNodeSuite
extends ScalabilityAbstractSuite

The suite test will incrementally increase the load and execute searches. Each test run thus adds nodes and executes different benchmarks. This way we measure time taken for benchmark execution.

The following system JVM properties can be defined to configure the suite.

• loaders - Controls the number of concurrent threads for loading blobs initially. Defaults to 1.
• testers - Controls the number of concurrent tester threads. Defaults to 1.
• nodeLevels - Comma separated string property that governs the depth and the number of nodes in the hierarchy. Defaults to 10, 5, 2.
• densityLevel - Controls the percentage of root nodes which will have sub nodes created. Defaults to 100.
• index - Controls if the index definitions are to be created. Defaults to false.
• asyncIndex - Controls whether the indexing is async. Defaults to false.
• noFullIndex - Controls whether fulltext indexing is enabled or disabled. Defaults to false.
• randDate - Controls whether to generate random dates in a range. Defaults to false.
• customType - Controls if nodes created in the load have a custom node type. Defaults to false.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalabilityNodeSuite.Index

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.scalability.suites.ScalabilityAbstractSuite

ScalabilityAbstractSuite.ExecutionContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ASYNC_INDEX Controls whether the indexing is async
static String	CTX_ACT_NODE_TYPE_PROP
static String	CTX_DESC_SEARCH_PATHS_PROP
static String	CTX_PAGINATION_KEY_PROP
static String	CTX_REL_NODE_TYPE_PROP
static String	CTX_ROOT_NODE_NAME_PROP
static String	CUSTOM_DESC_NODE_TYPE
static String	CUSTOM_ROOT_NODE_TYPE
protected static boolean	CUSTOM_TYPE Controls if a customType is to be created
static String	DATE_PROP
protected static int	DENSITY_LEVEL Controls the percentage of root nodes which will have sub nodes created.
static String	FILTER_PROP
protected static boolean	FULL_TEXT Controls whether fulltext indexing is enabled or disabled.
protected static boolean	INDEX Controls if the index definitions are to be created.
ScalabilityNodeSuite.Index	INDEX_TYPE Type of index to be created
protected static int	LOADERS Controls the number of concurrent threads for loading blobs initially
protected static org.slf4j.Logger	LOG
protected static List<String>	NODE_LEVELS Controls the number of nodes at each level
protected List<String>	nodeTypes
protected static boolean	RAND_DATE Controls whether to generate random dates in a range
static String	ROOT_NODE_NAME
static String	SORT_PROP
protected Boolean	storageEnabled
protected static int	TESTERS Controls the number of concurrent tester threads
static String	TITLE_PROP
protected Whiteboard	whiteboard

Fields inherited from class org.apache.jackrabbit.oak.scalability.suites.ScalabilityAbstractSuite

benchmarks, CREDENTIALS, CTX_SEARCH_PATHS_PROP, INCREMENTS, PROFILE, TEST_ID, WARMUP

Constructor Summary

Constructors

Constructor and Description
ScalabilityNodeSuite(Boolean storageEnabled)

Method Summary

Modifier and Type	Method and Description
ScalabilitySuite	addBenchmarks(ScalabilityBenchmark... tests) Adds the benchmarks to run.
void	beforeIteration(ScalabilityAbstractSuite.ExecutionContext context) Executes before each test run
protected void	beforeSuite() Setup any options before the benchmarks.
protected void	createIndexes(javax.jcr.Session session)
protected void	createLoad(ScalabilityAbstractSuite.ExecutionContext context) Creates the load for the search.
protected javax.jcr.Repository[]	createRepository(RepositoryFixture fixture)
protected void	executeBenchmark(ScalabilityBenchmark benchmark, ScalabilityAbstractSuite.ExecutionContext context) Runs the benchmark.
protected org.apache.jackrabbit.oak.scalability.suites.ScalabilityNodeSuite.Writer	getWriter(ScalabilityAbstractSuite.ExecutionContext context, org.apache.commons.math.stat.descriptive.SynchronizedDescriptiveStatistics writeStats, int idx)
protected void	waitBeforeIterationFinish(long loadFinish)

Methods inherited from class org.apache.jackrabbit.oak.scalability.suites.ScalabilityAbstractSuite

addBackgroundJob, afterIteration, afterSuite, getBenchmarks, getRepository, initBackgroundJobs, loginWriter, removeBenchmark, run, setPrintStream, setUp, shutdownBackgroundJobs, tearDown, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

LOADERS

protected static final int LOADERS

Controls the number of concurrent threads for loading blobs initially

NODE_LEVELS

protected static final List<String> NODE_LEVELS

Controls the number of nodes at each level

TESTERS

protected static final int TESTERS

Controls the number of concurrent tester threads

DENSITY_LEVEL

protected static final int DENSITY_LEVEL

Controls the percentage of root nodes which will have sub nodes created. Value ranges from [0, 100]

INDEX

protected static final boolean INDEX

Controls if the index definitions are to be created.

ASYNC_INDEX

protected static final String ASYNC_INDEX

Controls whether the indexing is async

FULL_TEXT

protected static final boolean FULL_TEXT

Controls whether fulltext indexing is enabled or disabled. Enabled by default.

RAND_DATE

protected static final boolean RAND_DATE

Controls whether to generate random dates in a range

CUSTOM_TYPE

protected static final boolean CUSTOM_TYPE

Controls if a customType is to be created

CTX_DESC_SEARCH_PATHS_PROP

public static final String CTX_DESC_SEARCH_PATHS_PROP

See Also:

Constant Field Values

CTX_ROOT_NODE_NAME_PROP

public static final String CTX_ROOT_NODE_NAME_PROP

See Also:

Constant Field Values

CTX_ACT_NODE_TYPE_PROP

public static final String CTX_ACT_NODE_TYPE_PROP

See Also:

Constant Field Values

CTX_REL_NODE_TYPE_PROP

public static final String CTX_REL_NODE_TYPE_PROP

See Also:

Constant Field Values

CUSTOM_ROOT_NODE_TYPE

public static final String CUSTOM_ROOT_NODE_TYPE

See Also:

Constant Field Values

CUSTOM_DESC_NODE_TYPE

public static final String CUSTOM_DESC_NODE_TYPE

See Also:

Constant Field Values

DATE_PROP

public static final String DATE_PROP

See Also:

Constant Field Values

CTX_PAGINATION_KEY_PROP

public static final String CTX_PAGINATION_KEY_PROP

See Also:

Constant Field Values

FILTER_PROP

public static final String FILTER_PROP

See Also:

Constant Field Values

SORT_PROP

public static final String SORT_PROP

See Also:

Constant Field Values

TITLE_PROP

public static final String TITLE_PROP

See Also:

Constant Field Values

ROOT_NODE_NAME

public static final String ROOT_NODE_NAME

INDEX_TYPE

public final ScalabilityNodeSuite.Index INDEX_TYPE

Type of index to be created

storageEnabled

protected final Boolean storageEnabled

whiteboard

protected Whiteboard whiteboard

nodeTypes

protected final List<String> nodeTypes

Constructor Detail

ScalabilityNodeSuite

public ScalabilityNodeSuite(Boolean storageEnabled)

Method Detail

addBenchmarks

public ScalabilitySuite addBenchmarks(ScalabilityBenchmark... tests)

Description copied from interface: ScalabilitySuite

Adds the benchmarks to run.

Returns:

beforeSuite

protected void beforeSuite()
                    throws Exception

Description copied from class: ScalabilityAbstractSuite

Setup any options before the benchmarks.

Overrides:

beforeSuite in class ScalabilityAbstractSuite

Throws:

Exception

createIndexes

protected void createIndexes(javax.jcr.Session session)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

beforeIteration

public void beforeIteration(ScalabilityAbstractSuite.ExecutionContext context)
                     throws javax.jcr.RepositoryException

Executes before each test run

Overrides:

beforeIteration in class ScalabilityAbstractSuite

Parameters:

context - the context

Throws:

javax.jcr.RepositoryException

waitBeforeIterationFinish

protected void waitBeforeIterationFinish(long loadFinish)

createLoad

protected void createLoad(ScalabilityAbstractSuite.ExecutionContext context)
                   throws javax.jcr.RepositoryException

Creates the load for the search.

Parameters:

context - the context

Throws:

javax.jcr.RepositoryException - the repository exception

getWriter

protected org.apache.jackrabbit.oak.scalability.suites.ScalabilityNodeSuite.Writer getWriter(ScalabilityAbstractSuite.ExecutionContext context,
                                                                                             org.apache.commons.math.stat.descriptive.SynchronizedDescriptiveStatistics writeStats,
                                                                                             int idx)
                                                                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

executeBenchmark

protected void executeBenchmark(ScalabilityBenchmark benchmark,
                                ScalabilityAbstractSuite.ExecutionContext context)
                         throws Exception

Description copied from class: ScalabilityAbstractSuite

Runs the benchmark.

Specified by:

executeBenchmark in class ScalabilityAbstractSuite

Parameters:

benchmark - the benchmark to execute

Throws:

Exception

createRepository

protected javax.jcr.Repository[] createRepository(RepositoryFixture fixture)
                                           throws Exception

Overrides:

createRepository in class ScalabilityAbstractSuite

Throws:

Exception