...
The end-of-render JSON Report must be explicitly enabled in a similar manner to the legacy XML Report, by providing a path to the output filename in the render options which is are available in all DCCs.
Option "statistics” "jsonFilename" [ "filename.json" ]
...
The stats configuration file (default name: "stats.ini") defines the settings for the stats session (i.e. the collection of stats in a single render). The ini file can also be utilized used for advanced configuration to build a list of listeners to attach, and per-listener rules for metric data to be observed by each listener.
Most of the high-level settings can be left at their default values. Custom sessions should be given their own names, and the stats component's own verbosity level can be adjusted for troubleshooting issues with Listeners or other stats processing.
...
The [ManagedListeners] section can contain one or more [Listener] blocks. All Listeners have a common set of required options, and each listener will have unique options to control their its behavior. Some Listeners require no options.
...
| Property | Meaning | Type | Default | Required? |
|---|---|---|---|---|
regexp | Specifies a regular expression which will be used to match metric names for this rule. | String | yes | |
samplingInterval | Specifies the number of milliseconds between samples of metrics which match this rule. | int | 1000ms (once per sec) | no |
sampleImmediately | Specifies whether metrics which match this rule should be sampled immediately. | int | 0 | no |
Search Order
The location of a stats configuration file can be provided to the system with the use of an environment variable which directs the system to the location of a configuration file that must be named “stats.ini". The prman command line "-statsconfig” option can be used specify a relative path to a uniquely-named configuration file or can override the path entirely if given an absolute path.
reportingRate | For event metrics, specifies that a limit of only every N events of this type should be reported. | int | 0 (don't limit) | no |
Search Order
A filename and searchpath can be specified to help the renderer locate the configuration file to be used for the stats Session. The searchpath can be specified similarly to other prman search paths, using a rendermn.ini key or environment variable.
The stats config filename can be specified using the command line option -statsconfig. This can be used either to specify a filename and path relative to one of the searchpath directories or to specify an absolute path and filename.
Using the example configuration file from the File Format section Use the example configuration file described above, the command line might include:
...
If prman is not provided a config file name via the -statsconfig command-line option then the default configuration filename "stats.ini" will be used.
The stats system will search for resolve the configuration file location in the following orderfollowing priority order (once a match is found, evaluation of lower priority methods will stop):
| Order |
|---|
| Method | Setting | Content | Default |
|---|---|---|---|
| 1 |
/stats/configpath setting in rendermn.ini
Absolute filename from command line |
| absolute path and filename | stats.ini | |
| 2 | Searchpath from environment variable, relative filename |
directory path
RMAN_STATS_CONFIG_PATH |
env var +
| search path + relative filename |
| none | |
| 3 |
Searchpath from |
| search path + relative filename | .:${RMANTREE}/etc |
If you specify an absolute path on the command line it will override any requested search paths. This is a convenient way to do quick testing without having to modify an existing config file. For example, suppose you normally run with a certain configuration of listeners, but then want to do a render with details printed to the console about a specific metric or group of metrics. You could do a debugging run that temporarily overrides the default configuration in one of two ways - either by setting/pre-pending the environment variable override:
...
Both of these methods will load the stats configuration from "/my/test/directory/debug_stats.ini"
Filename expansion
Listener settings that specify a filename can include environment variables which will be expanded when processed by the Listener. Standard environment variable formats are supported, as well as Linux shell variable expansion syntax:
...
The prmanGlobalStatements.statsoptions take precedence over all other options if they are configured (see OpScript below).$RMAN_STATS_CONFIG_PATH/stats.iniif the environment variable is set.$CWD/stats.ini$RMANTREE/etc/stats/.ini
Advanced configuration is available in RfK through the following attributes:
...