Foglight Agent Manager 5.8.5.2

Runtime settings are considered as default settings for the agent package. You define these settings within the <runtime> element in the agent-definition.xml file. For example, you can apply the runtime settings to allocate more heap size than what is already allocated by the Agent Manager. On agent package deployment, these values are compared with the current Agent Manager configuration settings. If any of these settings exceed the existing Agent Manager settings, they are applied, causing the Agent Manager to be restarted.

•

Per-agent settings are considered when a certain number of agent instances is reached. You define these settings within the <agent> element, using the per-agent attribute to specify the number of agent instances. For example, if there are five or more instances of the agent type, you may need to increase the heap size beyond what is already allocated with the default Agent Manager setting. These changes also require a restart of the Agent Manager.

Before specifying these settings in your cartridge project, try defining a baseline environment and the configuration that supports it. By putting some thought into it beforehand, you can allocate the sufficient amount of resources, and at the same time limit the number of times the Agent Manager is restarted. For example, you can define the runtime settings that support up to five agent instances. When that number of agent instances exceeds that threshold, use the per-agent settings to increase resource allocation, as required.

How the Agent Manager Applies Configuration Settings

When the Agent Manager deploys your agent package (typically a .gar file), it evaluates any runtime settings specified in your agent package and compares them to its current runtime settings, and any pending requests from other agent packages, to determine if the existing configuration meets your resource requirements.

The deployment process facilitates the negotiation of changes to ensure that they are addressed. For example, if a package needs a certain heap size, the requested values are evaluated against the current values. If a change is required, it is marked as a pending resource change. If the deployment process encounters a setting that is currently not set, this value is also set as a pending change. When all resource settings are evaluated, all of the pending resource changes are applied, causing the Agent Manager to be restarted using the newly configured settings.

This process starts in the native layer of the Agent Manager launcher, working its way through various configuration setting levels. As each setting is evaluated, any overridden value supersedes the prior configuration setting. This process continues until all configuration sources are evaluated and the Agent Manager is ready to launch the JVM process.

The Agent Manager settings are evaluated and applied in the following sequence:

Evaluate the default configuration parameters used to set the memory size and required system platform. These are default values, calculated by the launcher, and cannot be edited.

Evaluate the <FGLAM_STATE>/config/client.config and <FGLAM_STATE>/config/baseline.jvmargs.config, and apply the required settings, overriding any applicable values set in the previous step.


	TIP: The client.config and baseline.jvmargs.config files can be edited by the user to persist configuration changes that override the default launcher configuration values.

Evaluate the <FGLAM_STATE>/config/deployments/vm.deployments.config and apply the required settings, overriding any applicable values set in the previous step.


	TIP: The vm.deployments.config file is a non-editable file that is maintained by the Agent Manager runtime process, as deployment runtime changes are discovered.

Evaluate any command-line property values, overriding any applicable values set in the previous step.


	TIP: Command-line settings supercede all previously declared settings. These settings are set by the user when they manually launch the Agent Manager process.

With the base runtime environment set, the Agent Manager evaluates each deployed agent package in the order in which they were deployed, and compares their runtime settings with its current settings. During the evaluation, any requested changes that meet or exceed the current configuration are aggregated and persisted to the <FGLAM_STATE>/config/deployments/vm.deployments.config file. If the evaluated runtime configuration matches that of the current environment, the Agent Manager startup sequence is complete. If a change is detected, for example, in a multi-state installation, or because of the Dquest.debug.fglam.deployonstartup flag usage, the Agent Manager process restarts. This subsequent restart process persists the updated changes to the vm.deployments.config file.

In addition to evaluating the <runtime> tag settings for each deployed agent package, the declared agent type resource settings in the agent.manifest file are also evaluated. These configuration settings differ from the <runtime> values in that their declared values are calculated based on the number of agent instances that exist on this Agent Manager. As part of the evaluation, each per-agent resource configuration is registered with a listener that is notified whenever a new agent instance is created. When these notifications are received, the resource settings are calculated and submitted for evaluation. If the calculated value results in a runtime change, the new values are persisted and the Agent Manager is restarted.

The following configuration settings can be specified in your agent-definition.xml file.

Table 4. Configurable Settings

Controls whether the Agent Manager runtime supports IPv6. The default value is true and must only be declared if your deployment specifically requires only IPv4 support.

…

JMX-Console

remote-managed

Controls access through the local host to the Agent Manager JMX Console. The default value is true and this attribute must only be declared if your deployment requires this service to be disabled.

…

JVM Memory

jvm-memory

Sets the minimum and maximum size of the VM memory (heap size) in MB on startup.

<jvm-memory min="" max=""/>

Declares a list of VM system properties to be set on startup. Only one jvm-arg value can be declared per element. Additional values must be set individually.

Default restrictions apply to -XX properties. Restrictions can be disabled by setting the -Dcom.quest.fglam.resources.jvm.args.disable.restrictions property in the config/client.config file prior to startup.

The Agent Manager maintains two queue configurations for storing and submitting messages to its upstream connection. Each of these queue types can be configured individually. The settings declared here override values in the config/fglam-config.xml file with respect to each of the upstream and upstream-verified configurations. This element is used to calculate the required upstream queue size based on the number of agent instances. Each of the upstream-queue attributes should be expressed as a multiple of the per-agent attribute.

<upstream-queues>

<upstream-queue type="upstream"

max-queue-size="" max-disk-space="" max-batch-size="" allow-runtime-change="true"/>

<upstream-queue type="upstream-verified"