Latency distribution result history. More...

Methods
	Clear
	Clear the history. More...

	Cumulative.Completed.Get
	Returns a list of completed cumulative results. More...

	Cumulative.Get
	Returns a list of available cumulative counters. More...

	Cumulative.GetByIndex index
	Returns a single item of the cumulative list. More...

	Cumulative.GetByTime timestamp
	Returns a single item of the cumulative list using a timestamp. More...

	Cumulative.Latest.Get
	Returns latest closed item of the cumulative list. More...

	Cumulative.Length.Get
	Returns the size of the cumulative list. More...

	Description.Get
	Returns a textual description of the object.

	Interval.Completed.Get
	Returns a list of completed interval results. More...

	Interval.Get
	Returns a list of available interval results. More...

	Interval.GetByIndex index
	Returns a single item of the interval list. More...

	Interval.GetByTime timestamp
	Returns a single item of the interval list using a timestamp. More...

	Interval.Latest.Get
	Returns the latest closed item of the interval list. More...

	Interval.Length.Get
	Returns the size of the interval list. More...

	Parent.Get
	Returns the parent object.

	Refresh.Timestamp.Get
	Returns the timestamp on the server when the current history was refreshed. More...

	Refresh
	Updates the Interval and Cumulative results with the results available on the server. More...

	Sampling.BufferLength.Get
	Number of samples to keep in the buffer. More...

	Sampling.BufferLength.Set
	Sets the number of samples to keep in the buffer. More...

	Sampling.Interval.Duration.Get
	Duration of one sampling interval in nanoseconds. More...

	Sampling.Interval.Duration.Set
	Sets the duration of one sampling interval. More...

Class overview

Latency distribution result history.

Definition at line 19763 of file api.tcl.

Method documentation

Rx.Latency.Distribution.ResultHistory::Clear

Clear the history.

With each Refresh interval and cumulative counters are transfert from Server to the Client. To remove all counter-objects in this history, you can execute this method. Both Interval and Cumulative counter lists will be cleared.

Example

Clear the History.

1 $historyObject Clear

Definition at line 19775 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.Completed.Get

Returns a list of completed cumulative results.

Same as Cumulative.Get but without the last incomplete snapshot.

Returns: List of Rx.Latency.Distribution.ResultData containing the Cumulative counters

Example

This example gets the available cumulative results

1 $historyObject Cumulative.Get

Returns:

[ <Rx.Latency.Distribution.ResultData object> ... ]

Definition at line 19789 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.Get

Returns a list of available cumulative counters.

Each result object contains cumulative counters at a certain point in time. Snapshots are taken at fixed time intervals. The interval duration can be obtained using Sampling.Interval.Duration.Get.

Returns: List of Rx.Latency.Distribution.ResultData containing the Cumulative counters

Example

This example gets the available cumulative results

1 $historyObject Cumulative.Get

Returns:

[ <Rx.Latency.Distribution.ResultData object> ... ]

Definition at line 19803 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.GetByIndex			index

Returns a single item of the cumulative list.

Parameters

index

Returns: Rx.Latency.Distribution.ResultData cumulative counter object at the specified index

Example

This example gets the available cumulative counters at index 1

1 $historyObject Cumulative.GetByIndex 1

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19817 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.GetByTime			timestamp

Returns a single item of the cumulative list using a timestamp.

Parameters

timestamp in nanoseconds

Returns: Rx.Latency.Distribution.ResultData

Example

This example gets the cumulative counter at timestamp 1432805398000000000 ns

1 $historyObject Cumulative.GetByTime 1432805398000000000

Returns:

<Rx.Latency.Distribution.ResultData object>

Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19835 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.Latest.Get

Returns latest closed item of the cumulative list.

Returns: Rx.Latency.Distribution.ResultData

Example

This example gets the latest closed Cumulative counter object

1 $historyObject Cumulative.Latest.Get

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19847 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Cumulative.Length.Get

Returns the size of the cumulative list.

Returns: The length of the cumulative list

Example

1 $historyObject Cumulative.Length.Get

Returns:

Definition at line 19859 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.Completed.Get

Returns a list of completed interval results.

This is the same as Interval.Get but without the last incomplete result.

Returns: List of Rx.Latency.Distribution.ResultData containing the Interval counters

Example

This example gets the available interval results

1 $historyObject Interval.Completed.Get

Returns:

[ <Rx.Latency.Distribution.ResultData object> ... ]

Definition at line 19878 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.Get

Returns a list of available interval results.

Each result object contains interval counters at a certain point in time. Snapshots are taken at fixed time intervals. The interval duration can be obtained using Sampling.Interval.Duration.Get.

Returns: List of Rx.Latency.Distribution.ResultData containing the Interval counters

Example

This example gets the available interval results

1 $historyObject Interval.List.Get

Returns:

[ <Rx.Latency.Distribution.ResultData object> ... ]

Definition at line 19892 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.GetByIndex			index

Returns a single item of the interval list.

Parameters

index

Returns: Rx.Latency.Distribution.ResultData interval counter object at the specified index

Example

This example gets the available interval counters at index 1

1 $historyObject Interval.GetByIndex 1

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19906 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.GetByTime			timestamp

Returns a single item of the interval list using a timestamp.

Parameters

timestamp in nanoseconds

Returns: Rx.Latency.Distribution.ResultData

Example

This example gets the Interval counters at timestamp 1432805398000000000 ns

1 $historyObject Cumulative.GetByTime 1432805398000000000

Returns:

<Rx.Latency.Distribution.ResultData object>

Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19924 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.Latest.Get

Returns the latest closed item of the interval list.

Returns: Rx.Trigger.Basic.ResultData

Example

This example gets the latest closed Interval counter object

1 $historyObject Interval.Latest.Get

Returns:

<Rx.Latency.Distribution.ResultData object>

Definition at line 19936 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Interval.Length.Get

Returns the size of the interval list.

Returns: The length of the interval list

Example

1 $historyObject Interval.Length.Get

Returns:

Definition at line 19948 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Refresh

Updates the Interval and Cumulative results with the results available on the server.

The ByteBlower server has a buffer to keep some samples. This method transfers those samples to the client. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed. The size of the server-side buffer can be obtained using Sampling.BufferLength.Get.

Example

This example refreshes the history results with the results available on the server

1 $historyObject Refresh

Definition at line 19979 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Refresh.Timestamp.Get

Returns the timestamp on the server when the current history was refreshed.

This is the timestamp on the server when the last Refresh was called.

Returns: Timestamp in nanoseconds since epoch

Example

This example gets the Refresh timestamp

1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 19967 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Sampling.BufferLength.Get

Number of samples to keep in the buffer.

The ByteBlower server has a buffer to keep some samples before they are transferred to the client. This method gets the maximum number of samples the server can hold. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed.

Returns: The length of the server sample buffer

Example

1 $historyObject Sampling.BufferLength.Get

Returns:

Definition at line 19993 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Sampling.BufferLength.Set

Sets the number of samples to keep in the buffer.

The ByteBlower server has a buffer to keep some samples before they are transferred to the client. This method sets the maximum number of samples the server can hold. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed.

Example

1 $historyObject Sampling.BufferLength.Set 6

Definition at line 20005 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Sampling.Interval.Duration.Get

Duration of one sampling interval in nanoseconds.

Returns: Duration in nanoseconds

Example

1 $historyObject Sampling.Interval.Duration.Get

Returns:

1000000000

Definition at line 20017 of file api.tcl.

Rx.Latency.Distribution.ResultHistory::Sampling.Interval.Duration.Set

Sets the duration of one sampling interval.

Note: WARNING: The previously collected history will be invalidated.

Example

1 $historyObject Sampling.Interval.Duration.Set 1000000000

Example

1 $historyObject Sampling.Interval.Duration.Set 1s

Definition at line 20031 of file api.tcl.

Methods

Class overview

Method documentation