PerformanceTestDescriptor (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.test.performance.PerformanceTestDescriptor

```
@Beta
public class PerformanceTestDescriptor
extends java.lang.Object
```
For building up a description of what to measure.
Users are strongly encouraged to call the setter methods, rather than accessing the fields directly. The fields may be made protected in a future release.
The following fields are compulsory:
- job(Runnable)
- Exactly one of duration(Duration) or iterations(int)
See PerformanceTestUtils#run(PerformanceTestDescriptor).

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.concurrent.CountDownLatch`	`completionLatch`
`Duration`	`completionLatchTimeout`
`Duration`	`duration`
`boolean`	`histogram`
`java.lang.Integer`	`iterations`
`java.lang.Runnable`	`job`
`Duration`	`logInterval`
`java.lang.Double`	`minAcceptablePerSecond`
`MeasurementResultPersister`	`persister`
`java.lang.Runnable`	`postJob`
`java.lang.Runnable`	`preJob`
`Duration`	`sampleCpuInterval`
`boolean`	`sealed`
`java.lang.String`	`summary`
`Duration`	`warmup`
`java.lang.Integer`	`warmupIterations`

Constructor Summary

Constructors
Constructor and Description

PerformanceTestDescriptor()

Constructors
Constructor and Description
`PerformanceTestDescriptor()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PerformanceTestDescriptor`	`completionLatch(java.util.concurrent.CountDownLatch val)` If non-null, the performance test will wait for this latch before stopping the timer.
`PerformanceTestDescriptor`	`completionLatchTimeout(Duration val)` The maximum length of time to wait for the `completionLatch(CountDownLatch)`, after executing the designated number of jobs.
`static PerformanceTestDescriptor`	`create()`
`static PerformanceTestDescriptor`	`create(java.lang.String summary)`
`PerformanceTestDescriptor`	`duration(Duration val)` The length of time to repeatedly execute the job for, when measuring the performance.
`PerformanceTestDescriptor`	`histogram(boolean val)` Whether to collect a histogram of the individual job times.
`PerformanceTestDescriptor`	`iterations(int val)` See `duration(Duration)`.
`PerformanceTestDescriptor`	`job(java.lang.Runnable val)` The job to be repeatedly executed.
`PerformanceTestDescriptor`	`logInterval(Duration val)` How often to log progress (e.g.
`PerformanceTestDescriptor`	`minAcceptablePerSecond(java.lang.Double val)` If non-null, the measured jobs-per-second will be compared against this number.
`PerformanceTestDescriptor`	`postJob(java.lang.Runnable val)` To be run each time after the job (pausing the timer while this is run).
`PerformanceTestDescriptor`	`preJob(java.lang.Runnable val)` To be run each time before the job (pausing the timer while this is run).
`PerformanceTestDescriptor`	`sampleCpuInterval(Duration val)` How often to calculate + record the fraction of CPU being used.
`void`	`seal()`
`PerformanceTestDescriptor`	`summary(java.lang.String val)`
`java.lang.String`	`toString()`
`PerformanceTestDescriptor`	`warmup(Duration val)` The length of time to repeatedly execute the job for, before doing the proper performance test.
`PerformanceTestDescriptor`	`warmupIterations(int val)` See `warmup(Duration)`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - summary
```
public java.lang.String summary
```
  - warmup
```
public Duration warmup
```
  - warmupIterations
```
public java.lang.Integer warmupIterations
```
  - duration
```
public Duration duration
```
  - iterations
```
public java.lang.Integer iterations
```
  - job
```
public java.lang.Runnable job
```
  - preJob
```
public java.lang.Runnable preJob
```
  - postJob
```
public java.lang.Runnable postJob
```
  - completionLatch
```
public java.util.concurrent.CountDownLatch completionLatch
```
  - completionLatchTimeout
```
public Duration completionLatchTimeout
```
  - minAcceptablePerSecond
```
public java.lang.Double minAcceptablePerSecond
```
  - sampleCpuInterval
```
public Duration sampleCpuInterval
```
  - logInterval
```
public Duration logInterval
```
  - histogram
```
public boolean histogram
```
  - persister
```
public MeasurementResultPersister persister
```
  - sealed
```
public boolean sealed
```
- Constructor Detail
  - PerformanceTestDescriptor
```
public PerformanceTestDescriptor()
```
- Method Detail
  - create
```
public static PerformanceTestDescriptor create()
```
  - create
```
public static PerformanceTestDescriptor create(java.lang.String summary)
```
  - summary
```
public PerformanceTestDescriptor summary(java.lang.String val)
```
  - warmup
```
public PerformanceTestDescriptor warmup(Duration val)
```
    The length of time to repeatedly execute the job for, before doing the proper performance test. At most one of warmup(Duration) or warmupIterations(int) should be set - if neither is set, the warmup defaults to one tenth of the test duration.
  - warmupIterations
```
public PerformanceTestDescriptor warmupIterations(int val)
```
    See warmup(Duration).
  - duration
```
public PerformanceTestDescriptor duration(Duration val)
```
    The length of time to repeatedly execute the job for, when measuring the performance. Exactly one of duration(Duration) or iterations(int) should be set.
  - iterations
```
public PerformanceTestDescriptor iterations(int val)
```
    See duration(Duration).
  - job
```
public PerformanceTestDescriptor job(java.lang.Runnable val)
```
    The job to be repeatedly executed.
  - preJob
```
public PerformanceTestDescriptor preJob(java.lang.Runnable val)
```
    To be run each time before the job (pausing the timer while this is run).
  - postJob
```
public PerformanceTestDescriptor postJob(java.lang.Runnable val)
```
    To be run each time after the job (pausing the timer while this is run).
  - completionLatch
```
public PerformanceTestDescriptor completionLatch(java.util.concurrent.CountDownLatch val)
```
    If non-null, the performance test will wait for this latch before stopping the timer. This is useful for asynchronous work. For example, 1000 iterations of the job might be executed that each submits work asynchronously, and then the latch signals when all of those 1000 tasks have completed.
  - completionLatchTimeout
```
public PerformanceTestDescriptor completionLatchTimeout(Duration val)
```
    The maximum length of time to wait for the completionLatch(CountDownLatch), after executing the designated number of jobs. If the latch has not completed within this time, then the test will fail.
  - minAcceptablePerSecond
```
public PerformanceTestDescriptor minAcceptablePerSecond(java.lang.Double val)
```
    If non-null, the measured jobs-per-second will be compared against this number. If the jobs-per-second is not high enough, then the test wil fail.
  - histogram
```
public PerformanceTestDescriptor histogram(boolean val)
```
    Whether to collect a histogram of the individual job times. This histogram stores the count in buckets (e.g. number of jobs that took 1-2ms, number that took 2-4ms, number that took 4-8ms, etc).
  - logInterval
```
public PerformanceTestDescriptor logInterval(Duration val)
```
    How often to log progress (e.g. number of iterations completed so far). If null, then no progress will be logged.
  - sampleCpuInterval
```
public PerformanceTestDescriptor sampleCpuInterval(Duration val)
```
    How often to calculate + record the fraction of CPU being used. If null, then CPU usage will not be recorded.
  - seal
```
public void seal()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PerformanceTestDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

summary

warmup

warmupIterations

duration

iterations

job

preJob

postJob

completionLatch

completionLatchTimeout

minAcceptablePerSecond

sampleCpuInterval

logInterval

histogram

persister

sealed

Constructor Detail

PerformanceTestDescriptor

Method Detail

create

create

summary

warmup

warmupIterations

duration

iterations

job

preJob

postJob

completionLatch

completionLatchTimeout

minAcceptablePerSecond

histogram

logInterval

sampleCpuInterval

seal

toString