If enabled the Usage Agent will meter every application (OS related services will not be included) that is being used on the system.
To enable the usage agent set usageDisabled / USAGEAGENTDISABLE to false.
The usage agent can be configured with the following configurations which are only available for usage in a config file:
Options |
Description |
usageLogFileSize |
Max size (in bytes) of the usage log written by the agent. |
usageEnableSessionLogging |
If set to true a usage log is written which contains all metering information. This should be used for debugging purposes only. Default value: false |
usageSessionBackupPeriod |
Time span (in seconds) specifying how often the information is dumped from memory into a cache file. |
usageStartupDelay |
Time span (in seconds) specifying when usage agent should start operating after boot.ing |
usageMinRunTime |
Time span (in seconds) specifying how long application runs until the usage gets picked up by the agent. |
usageProcessUpdatePeriod |
Time span (in seconds) specifying how often running processes should be pulled. |
Whitelisting
To restrict the metering to a list of applications it is possible to add a whitelist to the Agent.
To whitelist certain processes, add lines for the setting usageWhitelist to the configuration file.
On successful download, these settings will be automatically applied by creating from them a file of the name whitelisted.xml in the Inventory Agent installation directory.
This way your process whitelists can be distributed along the other configuration settings.
|
Be aware: The values for whitelisted processes must represent valid Regular Expressions. This is why in the following examples special characters "." (dot) and "\" (backslash) are escaped with another backslash. |
usageWhitelist=\\winword\.exe
usageWhitelist=\\powerpnt\.exe
usageWhitelist=\\teams\.exe
usageWhitelist=\\outlook\.exe
You can also manually create a file containing required definitions for whitelisting. The file should have an XML syntax, for example:
<Whitelist>
<Process Path="\\winword\.exe" Regex="true"/>
<Process Path="\\powerpnt\.exe" Regex="true"/>
<Process Path="\\teams\.exe" Regex="true"/>
<Process Path="\\outlook\.exe" Regex="true"/>
</Whitelist>
Save it in the root directory where the agent was installed, under the name whitelisted.xml.
Alternatively, you may create such a file on your RayVentory Scan Engine host, in the directory for Inventory Agent configuration files.
In this case, the whitelist could also be downloaded using Inventory Agent scheduled arbitrary command line feature, by adding a command to download into the configuration file.
Example:
schedule:command:curl.exe --output "C\:\Program Files (x86)\RayVentory\InventoryAgent\whitelisted.xml" -f http\://rayventory\:591/rviaconfig/whitelisted.xml