Foglight 6.1.0 - Federation Field Guide

Chat now with support

Metric pull on demand Alarm service communication channel

Setting up a federated environment Federation configuration changes Security settings Query limitations Custom script queries Upgrading cartridges on a federated system Selectively disabling federation services Deploying cartridge components

Troubleshooting Frequently asked questions

Custom script queries

When deploying cartridges on a federated environment, by default, the following components are not deployed on the Federation Master:

•

Monitoring Policies (for example, Rules, Derived Metrics)

•

Agent Adapters

•

CDTs (Canonical Data Transformation) and Agent Adapters Extensions

Custom (Groovy) script queries running on a standalone Foglight® Management Server do not show on the Federation Master after the .car file has been successfully deployed. This is because the federateDeployType attribute of query components in cartridges is set to DEFAULT_DEPLOY by default.

To allow custom script queries defined in cartridge components to appear on the Federation Master:

•

Set the federateDeployType component to ALWAYS_DEPLOY.


	NOTE: This procedure is valid for all cartridge components.

Upgrading cartridges on a federated system

To upgrade a cartridge on a federated system:

Disable the topology synchronization in the Federation Master by commenting out all queries in the federation.config file.

Upgrade the cartridges on the Federated Children.

Upgrade the cartridges on the Federation Master.

Enable the topology synchronization, by editing the queries in the federation.config file.

Selectively disabling federation services


	NOTE: This is an advanced configuration procedure; it is not part of your basic federation setup process. Use it only if necessary.

Certain areas of the federation functionality can be disabled independently of each other with the help of Java system properties, as presented in the following table.

Table 3. Disabling Federation services
Java System Property	Value	Result
server.federation.remote. alarms.disabled	true	Disables downloading alarms from Federated Children. The Federation Master continues to show local alarms.
server.federation.remote. properties.disabled	true	Disables remote calls during dynamic properties evaluation. Any dynamic properties that require information from Federated Children have null values.
server.federation.remote. data.disabled	true	Disables retrieving observations (including metrics) from Federated Children. The Federation Master continues to show local metrics (for example, local derived metrics).
server.federation.remote. topology.disabled	true	Disables topology synchronization. This option is useful only after an initial topology synchronization has been performed.
server.federation.type. synchronization.disabled	true	Disables topology type synchronization between Federated Children and the Federation Master.

These properties must be set only on the Federation Master. To take effect, any changes to these properties require a server restart using the -D option. For example, to disable remote calls during dynamic properties evaluation, restart the server using the option:

-Dserver.federation.remote.properties.disabled=true

Deploying cartridge components


	NOTE: This is an advanced configuration procedure; it is not part of your basic federation setup process. Use it only if necessary.

Cartridges consist of components of various types. Each component is deployed and enabled individually. Whether a particular component is enabled in a Management Server depends on the server type (Federation Master or Federated Child) and on the federation deployment type.

You can control whether components are actually deployed by overriding the default federation deployment type during the cartridge build process. If no explicit value is provided for the federation deployment type, the server uses the default values.

The federation deployment type of a component is set in the federateDeployType cartridge manifest entry for that component. The cartridge-building ant task (<car>) allows you to set that attribute by using the federateDeployType (optional) parameter on cartridge sub-elements.

The following table lists possible values of the federateDeployType parameter.

Table 4. federateDeployType parameter values
Value	Effect
<not specified>	Same as DEFAULT_DEPLOY.
DEFAULT_DEPLOY	The server uses the default value based on the type of the cartridge component.
ALWAYS_DEPLOY	The component is deployed on the Federation Master and on the Federated Children.
FEDERATE_ONLY_DEPLOY	The component is deployed on Federation Masters, but not on Federated Children.
NON_FEDERATE_ONLY_DEPLOY	The component is deployed only on Federated Children, not on Federation Masters.

If a cartridge component has the DEFAULT_DEPLOY federation deployment type, the Management Server uses a pre-defined set of rules (based of the type of the component) to decide whether to deploy the component or not. The following table presents the cartridge components that are not deployed by default on Federation Masters.

Table 5. Cartridge components not deployed by default on Federation Masters
Component Type	Examples of artifacts that may be deployed in components of this type
Agent Configuration	Agent configuration (agent properties).
Adapter Extension Config	Agent adapter libraries, upgrade packages.
Installers	Agent packages and installers.
Monitoring Policy	Rules, derivations, registry variables, scripts, baseline computation parameters.
Agent-Adapter	Agent adapters (for example, Foglight Agent Manager Adapter).

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Foglight 6.1.0 - Federation Field Guide

Custom script queries

Upgrading cartridges on a federated system

Selectively disabling federation services

Deploying cartridge components