...
Advanced users may also configure other presentation Listeners through the use of an "ini" INI configuration file.
Live Statistics Configuration
...
| Note |
|---|
Configuration options are limited as this is a prototype feature. As this feature evolves so will the ability to create custom configurations of live stats. |
...
Advanced Configuration: INI File
The stats configuration file (default name: "stats.ini") holds the basic default settings for the stats session, . It can also be utilized for advanced configuration to build a list of listeners to attach, and per-listener rules for metric data to be observed by each listener.
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
# checkpoint_stats.ini # Stats default configuration file # # Copy this file to: /a/path/of/your/choosing # then run: # prman -statsconfig /a/path/of/your/choosing/checkpoint_stats.ini version 0.1 # Set this to 1 for extra information when parsing this file verbose 01 # Stats processing log level. # Range is 0 (none) to 5 (debug output). Default is 3 (warnings) logLevel 35 # Session configuration [Session] name "Checkpoint Session" # List of listeners which the session should create and manage. [ManagedListeners] # JSON output report listener [Listener] type "jsonreport" name "jsonListener" outputFilename "checkpoint_stats.json" keepAllCheckpoints 1 [MetricRules] # Save all metrics to the JSON file, sampled once per second [Rule] regexp ".*" samplingInterval 1000 |
| Note |
|---|
This example configuration file has both the |
The stats configuration file is provided to the prman command via the "-statsconfig" option:
...
The default configuration filename is "stats.ini" . If prman is If command-line prman is not provided a config file via the -statsconfig option, or if the filename given is a relative filename, then the stats configuration search path order will be used to attempt to find a configuration file.
...
| Note |
|---|
Listener control and configuration are not yet dynamic. In most cases, a render must be restarted in order to see the configuration change. In the case of RfM and RfB, the application will need to be restarted. |
...
DCC Configuration
A live stats configuration UI pane is available in all RenderMan bridge products, with the exception of Solaris which does not yet have support for the new stats system. In addition, advanced configuration with an INI file is also available through the use of the config environment variable. See below for DCC-specific details.
Blender
RfB uses the prman command-line mechanism as described above, including the use of the RMAN_STATS_CONFIG_PATH override environment variable.
Houdini
If the RMAN_STATS_CONFIG_PATH environment variable is set RfH will use that search path to look for a file named stats.ini.
...
These attributes are currently not exposed in PrmanGlobalStatements, they must be set via AttributeSet or OpScript at the moment. Attribute names are subject to change.
| Code Block | language | xml
|---|---|
| title | Configuration OpScript Node |
| collapse | true | <katana release="4.0v2" version="4.0.2.000001">
<node name="__SAVE_exportedNodes" type="Group">
<node baseType="OpScript" edited="true" name="StatsConfigurationAdvancedStatsConfiguration" ns_colorb="0.050000" ns_colorg="0.260000" ns_colorr="0.090000" ns_errorGlow="0.000000" ns_fromContext="legacy" selected="true" type="OpScript" x="143287.024861350171" y="-253212.437185346316">
<port name="i0" source="PrmanGlobalStatementsGafferThree.out" type="in"/>
<port name="out" type="out"/>
<group_parameter name="StatsConfigurationAdvancedStatsConfiguration">
<string_parameter name="CEL" value="((/root))"/>
<string_parameter name="location" value="/root/world/location"/>
<group_parameter name="script">
<string_parameter name="lua" value="
-- Default: 'stats.ini'
local configFile = Interface.GetOpArg('user.configFile'):getValue()

-- Default: '.:${RMANTREE}/etc'
-- Can be overriden with RMAN_STATS_CONFIG_PATH
local configSearchPathconfigPath = Interface.GetOpArg('user.configSearchPathconfigPath'):getValue()

-- Default: $RMANTREE/lib/plugins/listeners 
-- Can be overriden with RMAN_LISTENER_SEARCHPATH
local listenerSearchPath = Interface.GetOpArg('user.listenerSearchPath'):getValue()

Interface.SetAttr(
 'prmanGlobalStatements.stats.configFile', 
 StringAttribute(configFile))

Interface.SetAttr(
 'prmanGlobalStatements.stats.sconfigSearchPathconfigPath', 
 StringAttribute(configPath))

Interface.SetAttr(
 'prmanGlobalStatements.stats.listenerSearchPath',
 StringAttribute(listenerSearchPath))

"/>
</group_parameter>
<string_parameter name="executionMode" value="immediate"/>
<string_parameter name="applyWhere" value="at locations matching CEL"/>
<string_parameter name="applyWhen" value="during op resolve"/>
<string_parameter name="modifierNameMode" value="node name"/>
<string_parameter name="modifierName" value="modifier"/>
<string_parameter name="resolveIds" value=""/>
<number_parameter name="recursiveEnable" value="0"/>
<string_parameter name="disableAt" value=""/>
<string_parameter name="inputBehavior" value="by index"/>
<number_parameter name="multisampleUserOpArgs" value="0"/>
<group_parameter hints="{}" name="user">
<string_parameter hints="{'widget': 'fileInput'}" name="configFile" value="checkpoint_stats.ini"/>
<string_parameter expression="'/tmp:.:'+getenv("RMANTREE", ".")+'/etc'" hints="{}" name="configSearchPath"/>
<string_parameter expression="getenv("RMANTREE", "./")+'/lib/plugins/listeners'" hints="{}" name="listenerSearchPathconfigPath"/>
</group_parameter>
</group_parameter>
</node>
</node>
</katana>
|
Maya
If the RMAN_STATS_CONFIG_PATH environment variable is set RfM will use that search path to look for a file named stats.ini.
...