Log file monitoring environment variables

Edit online

You can set environment variables for log file monitoring in the OS agent environment files.

Set the following environment variables and replace KPC with the OS agent code where PC is the two character agent code, for example, klz is the code for the Linux OS agent.

KPC_FCP_LOG
This variable is available in the install_dir/config/.pc.environment file. The default value is True and you use it to enable or disable the log monitoring feature.
KPC_FCP_LOG_PROCESS_MAX_CPU_PCT
This setting is the maximum allowable percentage of all system CPU that the agent uses over a 1-minute interval. Valid values are 5 - 100. The default value is 100. This setting is associated with the CPU throttling feature. If you specify a value less than 5, the minimum value of 5 is used.
KPC_FCP_LOG_PROCESS_PRIORITY_CLASS
This setting is the operating system scheduler priority for the process. A is lowest, C is the operating system default, and F is the highest priority. The setting is one of the following values: A, B, C, D, E, F. These values are superseded by any values that you specify in the .conf file.
KPC_FCP_LOG_SEND_EVENTS
The default setting is True and it is used by the OS agent to send events to the Cloud APM server.
KPC_FCP_LOG_SEND_EIF_EVENTS
The default setting is True. If this option is set to Yes the agent sends event data to the Cloud APM server or to any EIF receiver such as the OMNIbus EIF probe. If the option is set to No, the agent does not send the event data. The setting of this option is global and applies to all monitoring profiles.
Note: The EIF receiver consumes events, otherwise problems might occur when the agent cache fills.
KPC_FCP_TRUNCATE_HOSTNAME_IN_LONG_SUBNODE_MSN
OS agents with log file event monitoring have a subnode limitation. To manage log file events, the subnode MSN has the following structure: UX:CITRAHOSTNAME_PROFILENAME. The maximum size limitation for the subnode name is 32 characters. If the built subnode MSN name is too long and it is more than 32 characters, it is truncated to 32 characters. This name corresponds to the substring that is taken from the Profile Name.
In the OS agent configuration file, use the following variables to manage the profile names that are too long:
  • UNIX OS agent: KUX_FCP_TRUNCATE_HOSTNAME_IN_LONG_SUBNODE_MSN=true
  • Linux OS agent: KLZ_FCP_TRUNCATE_HOSTNAME_IN_LONG_SUBNODE_MSN=true
  • Windows OS agent: KNT_FCP_TRUNCATE_HOSTNAME_IN_LONG_SUBNODE_MSN=true
For example, if you have an agent that is called aixhost_nc123456789A, which is 20 characters in length, CTIRAHOSTNAME=aixhost_nc123456789A is 20 characters.
and you have two profiles that are called:
ProfileLong12A (14 characters)
ProfileLong12B (14 characters)
the following related subnode MSNs are expected: 
UX:aixhost_nc123456789A_ProfileLong12A (38 characters)
UX:aixhost_nc123456789A_ProfileLong12B (38 characters)
However, the subnode MSNs are truncated to the 32 character limitation so the resulting names are the same for both:
UX:aixhost_nc123456789A_ProfileL
UX:aixhost_nc123456789A_ProfileL
To truncate CTIRAHOSTNAME instead of the Profile Name, set the Kpc_FCP_TRUNCATE_HOSTNAME_IN_LONG_SUBNODE_MSN=true variable.
For example, if n is the length of the Profile Name, such as 14, the substring for the MSN name that relates to CTIRAHOSTNAME is truncated to 32-n-3 characters, so the CTIRAHOSTNAME variable is: aixhost_nc1234. Then, the distinguished subnode MSNs are: 
UX:aixhost_nc1234_ProfileLong12A
UX:aixhost_nc1234_ProfileLong12B