# Statistical Criteria Parameters

Use the following parameters to configure the statistics that you want to measure.

When you configure XML fields for statistic restrictions (`AEqualStat`, `ARangeStat`, `NEqualStat`, `NRangeStat`, and `BitANDStat`) in the configuration file, you must provide either the full XML path (excluding the root element) or the last branch name.

For example, to create a statistic for the following XML event:

    <?xml version='1.0' encoding='ISO-8859-1' ?>
    <events>
      <queryinfo>
        <appIDs>
          <appID>DOMATCH</appID>
        </appIDs>
      </queryinfo>
    </events>

You can configure the statistic either by using the full XML path:

    AEqualStat=queryinfo/appIDs/appID,ARCHIVE

or by using the last XML branch:

    AEqualStat=appID,ARCHIVE

NOTE: `AEqualStat=appIDs/appID/,ARCHIVE` is an invalid restriction. As a result, all statistic results are stored on disk, ignoring the restrictions.

On startup, if a statistic restriction setting contains an XML path, a warning message is logged in the `application.log` file to remind the user to check the settings to ensure that it uses a valid path.

## AEqualStat

Specify the field and the string value that the field must contain to trigger the statistic.

Enter multiple field-value pairs as comma-separated variables in the form `fieldN,valueN`:

    AEqualStat=field1,value1,field2,value2

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `AEqualStat=action,query`

## ARangeStat

Specify the field and the alphabetical range into which a value must fall to trigger the statistic. To set the range, enter the lower and upper limits as comma-separated values.

Enter multiple field-value combinations as comma-separated variables in the form `fieldN,valueN1,valueN2`:

    ARangeStat=field1,value1_1,value1_2,field2,value2_1,value2_2

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `ARangeStat=term,captain,lieutenant`

## BitANDStat

Specify the field and bitwise AND value that the field must match to trigger the statistic.

Enter multiple field-value pairs as comma-separated variables in the form `fieldN,valueN`:

    BitANDStat=field1,value1,field2,value2

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `BitANDStat=MyOption,5`

## NEqualStat

Specify the field and the numeric value that the field must contain to trigger the statistic.

Enter multiple field-value pairs as comma-separated variables in the form `fieldN,valueN`:

    NEqualStat=field1,value1,field2,value2

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `NEqualStat=numhits,0`

## NRangeStat

Specify the field and the numeric range into which a value must fall to trigger the statistic. To set the range, enter the lower and upper limits as comma-separated values.

Enter multiple field-value combinations as comma-separated variables in the form `fieldN,valueN1,valueN2`:

    NRangeStat=field1,value1_1,value1_2,field2,value2_1,value2_2

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `NRangeStat=numhits,10,20`

## DynamicField

Specify the XML tag that triggers a dynamic statistic. For dynamic statistics, a substatistic is added when a new value of the dynamic field is recorded.

For example, if you set `DynamicField` to `Location` and Statistics Server records the new value `London` in this field, it creates a substatistic. This substatistic records the information configured in the dynamic statistic for each event that contains the value `London` in the `Location` field.

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `DynamicField=location`

## Field

Specify the XML tag that triggers the statistic.

Type: | String
Default: | None
Required: | Yes
Configuration Section: | [MyStatistic]
Example: | `Field=duration`

## Offset

Add an offset to the time range that is used to collect data. Specify the date and time when one statistics period ends and the next begins. You can use this parameter to align Statistics Server time periods with the periods for which you want to record statistics.

By default, Statistics Server starts a statistics period at a time when the epoch time is divisible by the period length. If you set `Offset` to a date and time, the statistics period starts at that time, rather than the default start time.

NOTE: Statistics Server starts to collect data immediately when a statistic is created, even if it is in the middle of a period.

You must specify `Offset` in the format `YYYY/MM/DD HH:MM:SS`. This date and time can be in the past.

Type: | String
Default: | 0
Required: | No
Configuration Section: | [MyStatistic]
Example: | `Offset=2010/04/01 12:30`
See Also: | Period

## Operation

Specify the type of statistic. Enter one of the following values:

- `Count`. The number of results since the previous statistical report.

- `CumulativeCount`. The total number of results.

- `TopN`. The top `N` results in a particular time period. If you enter `TopN`, you must also enter the number you want to measure, separated by a comma. You can enter `all` to list an unlimited number of ranked terms.

- `CumulativeTopN`. The top `N` results for all time. If you enter `CumulativeTopN`, you must also enter the number you want to measure, separated by a comma. You can enter `all` to list an unlimited number of ranked terms.

- `Average`. The average number of results in a particular time period.

Type: | String
Default: | None
Required: | Yes
Configuration Section: | [MyStatistic]
Example: | `Operation=TopN,100`

## Period

Specify the frequency in seconds of statistical reports.

Type: | Long
Default: | 3600
Required: | Yes
Configuration Section: | [MyStatistic]
Example: | `Period=3600`

_FT_HTML5_bannerTitle.htm