NIFI 1007 Updated Admin guide for stats configuration

Signed-off-by: joewitt <joewitt@apache.org>
This commit is contained in:
Jon Anderson 2016-01-09 21:16:42 -05:00 committed by joewitt
parent 8a8ae5508f
commit 035562bb33
2 changed files with 10 additions and 3 deletions

View File

@ -736,11 +736,17 @@ Providing three total locations, including _nifi.provenance.repository.director
The Component Status Repository contains the information for the Component Status History tool in the User Interface. These
properties govern how that tool works.
The buffer.size and snapshot.frequency work together to determine the amount of historical data to retain. As an example to
configure two days worth of historical data with a data point snapshot occurring every 5 minutes you would configure
snapshot.frequency to be "5 mins" and the buffer.size to be "576". To further explain this example for every 60 minutes there
are 12 (60 / 5) snapshot windows for that time period. To keep that data for 48 hours (12 * 48) you end up with a buffer size
of 576.
|====
|*Property*|*Description*
|nifi.components.status.repository.implementation|The Component Status Repository implementation. The default value is org.apache.nifi.controller.status.history.VolatileComponentStatusRepository and should not be changed.
|nifi.components.status.repository.buffer.size|Specifies the buffer size for the Component Status Repository. The default value is 288.
|nifi.components.status.snapshot.frequency|This value indicates how often to present a snapshot of the components' status history. The default value is 5 mins.
|nifi.components.status.repository.buffer.size|Specifies the buffer size for the Component Status Repository. The default value is 1440.
|nifi.components.status.snapshot.frequency|This value indicates how often to present a snapshot of the components' status history. The default value is 1 min.
|====

View File

@ -1342,7 +1342,8 @@ past five minutes, it is often useful to have a view of historical statistics as
by right-clicking on a component and choosing the ``Stats'' menu option or by clicking on the Stats History in the Summary page (see <<Summary_Page>>
for more information).
The amount of historical information that is stored is configurable in the NiFi properties but defaults to 24 hours.
The amount of historical information that is stored is configurable in the NiFi properties but defaults to 24 hours. For specific
configuration information reference the Component Status Repository of the Administration guide.
When the Stats dialog is opened, it provides a graph of historical statistics:
image::stats-history.png["Stats History"]