Chat now with support
Chat with Support

Foglight 6.3.0 - Administration and Configuration Guide

Administering and Configuring Foglight Extending Your Monitoring Reach with Foglight Cartridges Administering Foglight Configure Rules and Metric Calculations to Discover Bottlenecks Customizing Your Foglight Environment with Tooling

Blackout Configuration

There are several starting points available form the Blackouts page that you can use to view and manage blackouts. Choose the dashboard that best suits your needs. For example, to quickly see a list of all blackouts and delete the ones that you no longer need, navigate to the Manage Blackouts dashboard, and select and delete the desired blackouts.

Manage Blackouts. Use this dashboard to view, create, and delete blackouts. For more information, see Explore and manage blackouts.
View Blackouts by Object. Use this dashboard to view topology blackouts. Topology blackouts do not interrupt the data collection for the object to which the blackout is assigned. For more information, see View a list of blacked out objects.
View Blackouts by Agent. Agent blackouts are events during which the agent ceases to collect data for the duration of the blackout period. For more information, see View a list of blacked out agents.

The Manage Blackouts dashboard allows you to view and manage existing blackouts. This dashboard lists all existing blackouts, including topology and agent blackouts. It also provides quick access to workflows for creating new blackouts.

By default, the following columns are displayed:

Name contains the blackout name.
Schedule, Name contains the name of the schedule associated with the blackout.
Schedule, Currently Blacked Out indicates whether the blackout is currently in effect: Yes or No.
Schedule, State indicates if the blackout schedule is in effect (Current), expired (Expired), or set to occur at a later time (Future).
Includes Children indicates whether the blackout is inherited by the descendents of the affected type (topology blackouts only): Yes or No.
Type shows the blackout type: agent blackout or topology blackout .

In addition to these columns, the following columns can also be displayed by clicking and selecting them from the Show Columns dwell that appears.

Next Start shows the date and time on which the next instance of the blackout period starts.
Next End shows the date and time on which the next instance of the blackout period ends.
Duration shows the length of time during which the next blackout period will be in effect.

Click Create One-Time Blackout or Create Scheduled Blackout to start the Create Blackout Wizard that allows you to quickly add a new blackout to the existing collection. For more information about the available flows, see Create one-time agent blackouts, Create scheduled blackouts for alarms, and Create scheduled blackouts for agents by selecting objects.

The left-most column in the list contains check boxes that allow you to select one or more blackouts, and delete them, as required. Click Select All and Select None to select all variables or clear all selections, respectively.

The View Blackouts by Object dashboard lists all topology objects that are blacked out. Use this dashboard to quickly identify the objects whose alarms are suspended.

To access this dashboard, on the Blackouts page, click View Blackouts by Object. For each topology object, the following columns are displayed.

Name contains the name of blacked out topology object.
Type contains the name of the topology type of the blacked out object.
Includes Children indicates whether the blackout is inherited by the descendents of the affected type (topology blackouts only): Yes or No.
Monitored Host contains the name of the host associated with the blacked out object.
Schedule contains the name of the schedule associated with the blackout.
Currently Blacked Out indicates whether a blackout is currently in effect: Yes or No.
Schedule State shows if the blackout schedule is in effect (Current), expired (Expired), or set to occur at a later time (Future).

The View Blackouts by Agent dashboard lists all agents that have blackouts. Use this dashboard to quickly identify the agents for which blackouts are configured.

To access this dashboard, on the Blackouts page, click View Blackouts by Agent. For each topology object, the following columns are displayed.

Name contains the name of blacked out agent instance.
Type contains the type of the blacked out agent instance.
Host contains the name of the host the blacked out agent is monitoring.
Schedule contains the name of the schedule associated with the blackout.
Currently Blacked Out indicates whether the blackout is currently in effect: Yes or No.
Schedule State shows if the blackout schedule is in effect (Current), expired (Expired), or set to occur at a later time (Future).

There are two types of blackouts that can be assigned to agent or topology object instances:

To create one-time blackouts, click Create a One-Time Blackout on the Blackouts page. To create scheduled blackouts, click Create a Scheduled Blackout.

The resulting workflow is in wizard form. You can navigate between the steps in the wizard using the navigation buttons that appear in the bottom-right corner of the display area (Previous, Next, Finish, and Cancel), or use the bread crumb trail to return to the Blackouts page.

The type and range of steps that you complete in the wizard depend on the type of blackout you want to create. For example, to suspend data collection for a period of time, you can identify agent instances that you want to black out and specify the blackout period. To prevent alarms from being generated during specific periods of time, identify the objects that you want to black out, and associate the blackout with a specific schedule.

For more information about the workflows in the Create Blackout Wizard, see the following topics:

Creating one-time agent blackouts suspends the agents’ data collection for a specific period of time. This can be done by selecting specific agent instances whose data collection you want to suspend and specifying the time range during which the blackout is in effect.[FDOC-378] One-time blackout periods are added to the list of Foglight schedules, and automatically deleted from there when the one-time blackouts with which they are associated expire.

1
On the navigation panel, under Dashboards, click Administration > Setup > Blackouts.
2
On the Blackouts page, click Create a One-Time Blackout.
3
Indicate that you want to black out agents. Select Suspend Data Collection, then click Next.
4
Indicate that you want to choose agents by selecting specific agent instances. Ensure that Select the Agents Directly from a List is selected, then click Next.
In the Select the Start Time boxes, type the desired start date and time.
Blackout Name: One-time blackout for infrastructure agents
Reason for Blackout: Daily maintenance
Click Finish.
9
Click Go to Manage Blackouts Page.

Creating scheduled topology blackouts suspends the alarms for specific periods of time. This is be done by selecting specific topology objects whose alarms you want to suspend.

1
On the navigation panel, under Dashboards, choose Administration > Setup > Blackouts.
3
Indicate that you want to black out alarms. Ensure that Suspend Alarms is selected, then click Next.
Click Next.
For example, if you selected Services in Step 4, and you want to select the CPU for a specific host object, in the object tree, expand the Windows > Windows Hosts node, and from the entries that appear, select a desired host object.
Click Next.
To create a new schedule, click New Schedule and follow the flow in the Simple New Schedule Wizard. When done, select the newly-created schedule. For more information, see Create a new schedule.
Blackout Name: Scheduled blackout for my Windows host
Reason for Blackout: Daily maintenance
Click Finish.
8
Click Go to Manage Blackouts Page.

Creating scheduled agent blackouts suspends the agents’ data collection for specific periods of time. This can be done by selecting topology objects associated with these instances.

1
On the navigation panel, under Dashboards, choose Administration > Setup > Blackouts.
On the Blackouts page, click Create a Scheduled Blackout.
In the Create Blackout Wizard, select Suspend Data Collection, then click Next.
In the Create Blackout Wizard, click Select Monitored Elements and Let Foglight Find Related Agents, then click Next.
Click Next.
For example, if you selected Services in Step 4, and you want to select agent instances that are monitoring a particular Windows Host object, in the object tree, expand the Windows > Windows Hosts node, and from the entries that appear, select a desired host objects.
Click Next.
To create a new schedule, click New Schedule and follow the flow in the Simple New Schedule Wizard. When done, select the newly-created schedule. For more information, see Create a new schedule.
9
Optional — Specify a different name or a reason for the blackout.
Blackout Name: Scheduled blackout for my Windows agents
Reason for Blackout: Daily maintenance
Click Finish.
10
Click Go to Manage Blackouts Page.

Schedules are used in different parts of Foglight, such as in blackouts, reports, registry variables or derived metrics definitions. A schedule consists of schedule items. Schedule items have specific start and end times, and a recurrence pattern.

Foglight includes a number of pre-defined schedules that you can use. If you do not find a schedule that meets your needs in the collection of existing schedules, you can create a new one using the Simple New Schedule Wizard. When you create a new schedule this way, that schedule is added to the master schedule collection and is accessible by all components that make use of schedules. You can access this wizard from the workflows for creating or editing blackouts and reports.

Another way to create a new schedule is using the Create Schedule dashboard. For more information about this workflow, see Create schedules.

2
In the Simple New Schedule Wizard dialog box, in the Select a schedule pattern type area, select one of the available schedule patterns.
There are four types of schedules that you can create: Once, Periodical, Daily, Weekly, Monthly, and Yearly. For details about each type, see Edit schedule items.

Editing agent blackouts is useful in situations when you need to quickly change one or more properties such as the blackout’s agents, or schedules associated with the blackout. For example, to suspend the data collection for more agents than originally defined in the blackout, simply open the agent blackout for editing, and select the additional agent instances.

1
On the navigation panel, under Dashboards, choose Administration > Setup > Blackouts.
2
4
Click the Name column.
The Blackout Agent Details view appears in the display area.
5
The Edit Name and Reason dialog box opens.
a
To change the blackout name, in the Name box, type the new name.
Default blackout names assigned by Foglight are based on the agent name and schedule and are often truncated in the views. For example, if an agent name has 15 characters or more, it appears truncated. Updating the blackout name causes the entire name to appear on the Manage Blackouts dashboard and Blackout Agent Details view without being truncated, assuming that the name length does not exceed the field/column in the display area in which the blackout name appears. Defining a meaningful name can help you quickly locate the blackout on the Manage Blackouts dashboard. For example, using agent names is useful to easily identify the parts of Foglight that are affected by the blackout. You can use any combination of alphabetical, numeric, and special characters. There are no length restrictions for to the blackout name, but it is worth noting that any text strings whose length exceeds the space allotted to the updated blackout name in the display area can appear truncated.
b
To change the reason for the blackout, in the Reason box, type the new reason.
c
Click Apply.
The Edit Name and Reason dialog box closes and the Basic Details area refreshes, showing the updated details.
The Change Schedule dialog box opens. It shows the list of all schedules that exist in your Foglight installation, including the schedules included with the server, and any schedules that you create. The schedule that is currently assigned to the agent blackout appears selected in the list. For more information about schedules, see Associate Metric Calculations with Schedules.
b
To create a new schedule, click Create New Schedule and follow the flow in the Simple New Schedule Wizard. When done, select the newly-created schedule. For more information, see Create a new schedule.
c
In the Change Schedule dialog box, click Apply.
The Change Schedule dialog box closes and the Schedule Information area refreshes, showing the updated details.
7
To remove agents from the blackout, in the Blacked Out Agents area, click Remove.
The Select Items to Remove dialog box opens. It shows a list of the agents that are affected by the current blackout.
The Select Items to Remove dialog box closes and the Blacked Out Agents area refreshes, no longer showing the newly-removed agent in the list.
8
To add more agents to the blackout, in the Blacked Out Agents area, click Add.
The Add Agents to Blackout dialog box opens. It shows a list of the agents that are affected by the current blackout.
Select the agents that you want to add. The flow for adding agents is the same as the flow for selecting agents when creating a new blackout. For detailed instructions, see Create one-time agent blackouts, starting with Step 4, or Create scheduled blackouts for agents by selecting objects, starting with Step 5. When you finish, the Add Agents to Blackout dialog box closes and the Blacked Out Agents area refreshes, showing the newly-added agents in the list.
To return to the Manage Blackouts dashboard, click Go to Manage Blackouts Page, or use the breadcrumb trail.

Editing topology blackouts is useful in situations when you need to quickly change one or more properties such as the blackout’s topology objects, or schedules associated with the blackout. For example, to suspend the data collection for more objects than originally defined in the blackout, simply open the topology blackout for editing, and select the additional object instances.

1
On the navigation panel, under Dashboards, choose Administration > Setup > Blackouts.
2
4
Click the Name column.
The Blackout Object Details view.
5
To edit the blackout name and reason, in the Basic Details area, click Change.
a
To change the blackout name, in the Name box, type the new name.
Default blackout names assigned by Foglight are based the on object name and schedule and are often truncated in the views. For example, if an object name has 15 characters or more, it appears truncated. Updating the blackout name causes the entire name to appear on the Manage Blackouts dashboard and Blackout Object Details view without being truncated, assuming that the name length does not exceed the field/column in the display area in which the blackout name appears. Defining a meaningful name can help you quickly locate the blackout on the Manage Blackouts dashboard. For example, using object names is useful to easily identify the parts of Foglight that are affected by the blackout. You can use any combination of alphabetical, numeric, and special characters. There are no length restrictions for the blackout name, but it is worth noting that any text strings whose length exceeds the space allotted to the updated blackout name in the display area can appear truncated.
b
To change the reason for the blackout, in the Reason box, type the new reason.
c
Click Apply.
The Change Schedule dialog box opens. It shows the list of all schedules that exist in your Foglight installation, including the schedules included with the server, and any schedules that you create. The schedule that is currently assigned to the topology blackout appears selected in the list. For more information about schedules, see Associate Metric Calculations with Schedules.
b
To create a new schedule, click Create New Schedule and follow the flow in the Simple New Schedule Wizard. When done, select the newly-created schedule. For more information, see Create a new schedule.
c
In the Change Schedule dialog box, click Apply.
The Change Schedule dialog box closes and the Schedule Information area refreshes, showing the updated details.
7
To remove topology objects from the blackout, in the Blacked Out Topology Objects area, click Remove Items.
The Select Items to Remove dialog box shows a list of the topology objects that are affected by the current blackout.
The Select Items to Remove dialog box closes and the Blacked Out Topology Objects area refreshes, no longer showing the newly-removed objects in the list.
8
To add more topology objects to the blackout, in the Blacked Out Topology Objects area, click Add.
The Add Items to Blackout dialog box opens. It shows a list of different object categories. The contents in the list depend on the complexity of your environment and the range of the installed cartridges.
To return to the Manage Blackouts dashboard, click Go to Manage Blackouts Page or use the breadcrumb trail.

Some Foglight dashboards have reports associated with them. This allows you to run a report based on the current dashboard. You can generate the report using the Reports menu in the top-right corner.

The Blackouts dashboard is associated with the Blackouts Report. Run this report by choosing Blackout Report from the Reports menu, and specifying the input parameters in the report wizard.

The report wizard provides more information about the Blackouts Report. For more information about reports in Foglight, see the Foglight User Help.

Manage Support Bundles

Server support bundles contain diagnostic data gathered from the Management Server. Support bundles can be created upon request by Quest Support to help you solve a problem in your environment.

The Manage Support Bundles dashboard allows you to create server support bundles, and to retrieve server and Foglight Agent Manager support bundles. To create Agent Manager support bundles, use the Agent Manager Support Bundle dashboard. For more information about this dashboard, see Create and download Agent Manager support bundles.

When you create a host support bundle, Foglight generates a ZIP file in the <foglight_home>/support/<user_name> directory on the machine hosting the Management Server. The support bundle file name uses the following syntax:

support_bundle_<Management Server host>_<user name>-<yyyy-mm-dd>-<hh-mm-ss>.zip

For example:

1
On the navigation panel, under Dashboards, click Administration > Support > Support Bundles.
2
Click Create Management Server Support Bundle.
In the Create Bundle dialog box, in the Description box, type the description of the support bundle.
The Create Bundle dialog box closes and the Create Bundle message box opens, indicating progress.
After a few moments, the Create Bundle message box closes, and the Support Bundle Generated message box opens.
4
In the Support Bundle Generated message box, click Download Bundle.
1
On the navigation panel, under Dashboards, choose Administration > Support > Support Bundle.
2
On the Support dashboard, in the Support Bundle Inventory view, locate the support bundle that you want to retrieve.
3

Server support bundles contain diagnostic data gathered from the Management Server. Support may ask you to upload these bundles to a Support server. Before uploading a Support bundle, your Quest Support contact will provide you with several registry variable values which will need to be set, including:

For information on how to create or edit registry variables, see View and edit registry variable settings .

1
On the navigation panel, under Dashboards, choose Administration > Support > Support Bundle.
4
Click Upload to Support.
The Upload Support Bundles Confirmation dialog opens.
5
Type the Case Number associated with the support bundle that is being uploaded, and then click Upload.
NOTE: The Case Number must be 30 characters max.
The Upload Bundle progress dialog appears.
When the upload is completed, the Upload Success dialog appears and a notification will appear in your browser.
7
Click Close to close the dialog.

Each server support bundle contains several files. The following list illustrates a file collection sample that may appear in a server support bundle. This list does not include the entire collection of files that are typically contained in a server support bundle. It is a partial listing that illustrates the directory structure and describes some of the common files that appear in the support bundle. To explore the contents of an Agent Manager Support Bundle, see Explore the Agent Manager support bundle .

A listing of recent changes to the FMS/registry/rules/cartridges/security/etc. It contains information about the before and after states of a configuration object, including rules, registry variables, agent properties, schedules, derived metrics, or thresholds, for changes that occur within the applicable default time range.

A diagnostic snapshot consisting of service status, agent status, thread dump, and other indicators.

A full file listing for all files in the server installation directory.

Server installation log

A listing of all installed cartridges, and their versions.

An export of the server’s monitoring policies.

Brief description of this support bundle

 

Defines the “weight” of attached agents. Used to help determine the server load

Configuration parameters for the server logging process.

Various configuration options for running the Management Server as a service

Various log configuration options for the Management Server.

Server restart configuration parameters (if running as a service).

Server configuration parameters and their values

Server logging parameters.

 

The three most recent server logs.

A comprehensive performance report that contains detailed information about the monitoring environment, its configuration and overall health. In addition to the copy of this file in the support bundle, Foglight places another copy of this file to the logs directory, under <foglight_home>/logs.

The report is also known as Management Server Performance Summary. It is primarily for use by Quest Support.

 

 

 

Server’s JacORB configuration parameters.

 

Server’s data source definition.

 

A JBoss application configuration file.

A JBoss application configuration file.

Agent Manager support bundles contain diagnostic data gathered from the monitored host. Support bundles can be created upon a request by Quest Support to help you solve a problem in your environment.

The Support dashboard allow you to create and download Agent Manager support bundles. To download previously created Agent Manager support bundles, use the Support dashboard. For more information about this dashboard, see Create and download server support bundles.

Alternatively, Agent Manager support bundles can be created using the support-bundle command. For syntax information, see the Command-Line Reference Guide.

When you create an Agent Manager bundle, Foglight generates a ZIP file in the <foglight_home>/support/<user_name> directory on the machine hosting the Management Server. The support bundle file name uses the following syntax:

support_bundle_FglAM_<Agent Manager host>_<Management Server host>_<user name>-<yyyy-mm-dd>-<hh-mm-ss>.zip

For example:

1
On the navigation panel, under Dashboards, choose Administration > Support > Support Bundle.
2
On the Support page, click Create Agent Manager Support Bundle.
Click Download Bundle to immediately download the generated bundle.

Agent Manager support bundles contain diagnostic data gathered from the monitored host. Support may ask you to upload these bundles to a Support server. Before uploading a Support bundle, your Quest Support contact will provide you with several registry variable values which will need to be set, including:

For information on how to create or edit registry variables, see View and edit registry variable settings .

To upload a support bundle:

1
On the navigation panel, under Dashboards, choose Administration > Support > Support Bundle.
4
Click Upload to Support.
5
Type the Case Number associated with the support bundle that is being uploaded, and then click Upload.
NOTE: The Case Number must be 30 characters max.
The Upload Bundle progress dialog appears.
When the upload is completed, the Upload Success dialog appears, the Upload Success dialog appears and a notification will appear in your browser.
7
Click Close to close the dialog.

Each Agent Manager support bundle contains several files. The following list illustrates a file collection sample that may appear in a host support bundle. This list does not include the entire collection of files. It is a partial listing that illustrates the directory structure and describes some of the common files that appear in the support bundle. To explore the contents of a Server Support Bundle, see Explore the server support bundle .

agentstate/

 

<cartridge_name>/

 

 

<cartridge_version>/

 

 

 

config/

 

 

 

 

<agent_type>/

 

 

 

 

 

<agent_type>AttributeDefs.xml

Attributes for the agent package

 

 

 

 

 

<agent_type>ConfigDefs.xml

Property configuration definitions for the agent package

 

 

 

 

 

<agent_type>LogDefs.xml

Log definitions for the agent package

 

 

 

 

 

<agent_type>Manifest.xml

Manifest for the agent package

 

 

 

 

 

<agent_type>ProcedureDefs.xml

Procedure definitions for the agent package

common/

 

jvminfo.txt

Java VM information

 

jvmthreaddump.txt

Java thread dump information

 

mbean-info.txt

MBean information

glueconfig/

 

fglam.config.xml

Foglight Agent Manager configuration information

 

log.config

Log configuration

 

process.config

Process configuration

 

tools.config

Tools information

 

client.config

Internal Agent Manager configuration

 

baseline.jvmargs.config

VM configuration

logs/

 

FglAM-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>.log

Successful startup logs

 

failed-startup-<yyyy>-<mm>-<dd>T<hh>-<mm>-<ss>.log

Failed startup logs

 

<cartridge_name>/

 

 

<cartridge_version>/

 

 

 

<agent_type>/

 

 

 

 

 

<agent_name>_<yyyy>-<mm>-<dd>_<hhmmss>_001.log

Agent log

system/

 

<os>-system-info.txt

OS information

Foglight Configuration

The Federation view contains information about the server federation. Federation is a Foglight feature that addresses the needs of customers who monitor large-scale environments that are naturally partitioned into logical units. Each of these partitions is traditionally served by one Foglight Management Server instance and its distributed clients/agents. Federation enables the use of one Management Server to operate, while using other Management Servers as the data source. The Federation Master Server manages the operation of those units, merging their data into a central model. Clicking an entry in this view drills down to the Foglight Server Topology view.

This view displays the following information:

Mode tells you whether the current Management Server installation is a Federated Child or a Federation Master in a federated system.
Standalone indicates that your monitoring environment is not federated.
Master indicates that the server is a Federation Server.
Children contains the number of children of the current Management Server installation in a federated system. If this setting shows zero ‘0’, combined with the Mode value of Child/Standalone, that is a good indicator that your monitoring environment is not federated.

The High Availability view indicates if Foglight is running in High Availability (HA) mode. Configuring Foglight in HA mode allows you to run multiple servers in a JBoss partition offering HA. For more information on starting Foglight in High Availability mode, see the High Availability Field Guide.

This view displays the following information:

Status shows if Foglight is running in HA mode () or not ().
Peers shows the number of servers in the cluster, not including the current server.

The Server view displays information related to the Foglight Management Server.

The view shows the following settings:

Version. The version number of the Management Server whose configuration items you are viewing.
Build. The build version of the Management Server whose configuration items you are viewing.
Foglight Home. The installation directory of the Management Server on the computer on which it is installed.
JBoss Server Directory. The installation directory of the JBoss application server that is running the Management Server, on the computer on which the Management Server is installed.

This view contains information about federation settings. The federation settings are defined in the file <foglight_home>/config/federation.config. For more information about this file, see the Federation Field Guide.

The Federation view displays the following settings:

Connection URLs. The JNDI-provider URLs for federated servers. These URLs should use the JNDI JNP port (see Explore the Ports view ), as configured in <foglight_home>/config/server.config on the corresponding federated server. This setting is defined by the JndiURLs parameter in the file <foglight_home>/config/federation.config.
Max Alarm Update Delay (millis). The maximal delay in milliseconds that is allowed for the federation server to check all federated servers for alarm changes. This setting is defined by the MaxAlarmUpdateDelay parameter.
Max System Time Difference (millis). The maximal acceptable difference in system time between federated servers and the federation server, in milliseconds. This setting is defined by the MaxSystemTimeDifference parameter.
Topology Queries. A list of one or more topology queries that identify topology objects that are be merged with the federated topology model. This setting is defined by the TopologyQueries parameter.
Topology Refresh Period (millis). The number of milliseconds between major topology refresh operations. A major topology refresh operation involves re-fetching all relevant topology objects from all federated servers and merging them into the local topology model. This setting is defined by the TopologyRefreshPeriod parameter.

This view contains information about database settings. The database settings are defined in the file <foglight_home>/config/server.config. For more information about this file, see the Installation and Setup Guide set.

The Database view displays the following settings:

Database Name. The name of the database. This setting is defined by the server.database.name parameter.
Embedded. Indicates if the Management Server is using an embedded or external database. Possible values are true or false.This setting is defined by the server.database.embededd parameter.
Hibernate Dialect. The name of the component that defines the database hibernate dialect.
Host. The name of the database host. This setting is defined by the server.database.host parameter.
Port. The port number used by the database. This setting is defined by the server.database.port parameter.
Secure Connection. Indicates if the Management Server is using a secure connection. Possible values are true or false. This setting is defined by the server.database.secureconn parameter.
Type. The type of the database. This setting is defined by the server.database.type parameter.
User. The database user name. This setting is defined by the server.database.user parameter.

This view contains information about JVM settings.

The JVM view displays the following settings:

Name. The name of the Java Virtual Machine (JVM) of the computer in which the Management Server is running.
Version. The version number of the JVM.
Vendor. The name of the JVM vendor.
Architecture (bit). The bit architecture of the JVM.
Options: Add JVM settings to the server.config file by entering and saving them in this field.

The JVM settings that appear in this view are not the full set. By default, the Foglight launcher sets a number of additional JVM settings. To see all of the JVM parameters, look for them under VM Options in the log file for the current session, <foglight_home>/logs/ManagementServer_<date>_<time>_001.log, as shown in the code listing below that illustrates the default JVM settings.

The OS view contains information about the OS of the machine on which the Management Server is running.

The view displays the following settings:

Type. The name and version of the operating system on which the Management Server is running.
Patch. The patch level of the operating system on which the Management Server is running.

The WCF view contains information about the Web Component Framework (WCF) included with the Management Server.

The view displays the following settings:

Version. The version number of the Web Component Framework that is included with the Management Server.
Build. The build version of the Web Component Framework that is included with the Management Server.

This view shows the email settings that are used by Foglight to send messages to specified recipients. For example, you can configure Foglight to generate and send reports to a specified mail recipient, or email warning messages to Foglight administrators when certain thresholds are reached. For information on how to configure email actions in Foglight, see Configuring email notifications.

The Mail (Global Settings) view displays the following settings:

Connection Timeout. The default connection timeout for sending emails to specified email recipients. This setting is defined by the global value of the mail.connection.timeout Foglight registry variable.
From. The default email address used by Foglight from which emails are sent. This setting is defined by the global value of the mail.from Foglight registry variable.
SMTP Host. The default email host name used by Foglight from which emails are sent when required. This setting is defined by the global value of the mail.host Foglight registry variable.
SMTP Port. The default port number of the email server used by Foglight from which emails are sent when required. This setting is defined by the global value of the mail.port Foglight registry variable.
Recipient. The default email address used by Foglight to which emails are sent when required. This setting is defined by the global value of the mail.recipient Foglight registry variable.
Socket Timeout. The default socket timeout for sending emails to specified email recipients.
User. The default user name for logging into the email server that is used by Foglight to which emails are sent when required. This setting is defined by the global value of the mail.user Foglight registry variable.
Use STARTTLS. Indicates whether the STARTTLS protocol is enabled. Possible values are true or false. This setting is defined by the global value of the mail.smtp.starttls.enable Foglight registry variable.
Use SSL. Indicates whether you want to enable the SSL protocol and use encryption when sending emails from Foglight. Possible values are true or false. This setting is defined by the global value of the mail.use.ssl Foglight registry variable.

This view lists the ports used by Foglight.

The Ports view displays the following ports:

For complete information about the above ports, such as their default numbers or communication points involved, see Default port assignments.

The following table shows the default port assignments for the ports listed in the Ports view along with a few other ports that are used for communication with the database or internal application ports. The port numbers can be specified at installation time, or after the installation using the configuration parameters in the file <foglight_home>/config/server.config. For more information, see the Installation and Setup Guide set.

1098

JNDI RMI Port

N/A

Description: Port for the Remote Method Invocation (RMI) naming service.

Configuration parameter: foglight.jndi.rmi.port

1099

JNDI JNP Port

N/A

This port is not involved for server/client communication.

Description: Port for the bootstrap JNP service.

Configuration parameter: foglight.jndi.jnp.port

1100

HA JNDI JNP Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Port for the bootstrap JNP service when Foglight is running in the High Availability (HA) mode. For more information about the HA mode, see the High Availability Field Guide.

Configuration parameter: foglight.ha.jndi.jnp.port

1101

HA JNDI RMI Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Port for the Remote Method Invocation (RMI) naming service when Foglight is running in HA mode. It can be used to observe the network traffic between the Management Server and other computers on the same network. If it finds another JBoss server, it checks the partition name to see if the JBoss server is a primary or a secondary server. For more information about the HA mode, see the High Availability Field Guide.

Configuration parameter: foglight.ha.jndi.rmi.port

1102

HA JNDI UDP Group Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Port for the UDP group when Foglight is running in the HA mode. For more information about the HA mode, see the Installation and Setup Guide set.

Configuration parameter: foglight.ha.jndi.udpgroup.port

3528

ORB (IIOP) Port

Management Server

Foglight Client

Yes

From Foglight Client to Management Server

Description: Corba ORB port used by the Foglight Client.

Configuration parameter: foglight.orb.port

3529

ORB (IIOP) SSL Port

Management Server

Foglight Client

Yes

From Foglight Client to Management Server

Description: Corba ORB SSL port used by the Foglight Client.

Configuration parameter: foglight.orb.ssl.port

4444

JRMP Invoker Port

N/A

Description: Port for the RMI/JRMP invoker.

Configuration parameter: foglight.jrmp.invoker.port

4446

HA Pooled Invoker Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Pooled invoker port when Foglight is running in the HA mode. For more information about the HA mode, see the High Availability Field Guide.

Configuration parameter: foglight.ha.pooled.invoker.port

4447

HA JRMP Invoker Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Port for the RMI/JRMP invoker when Foglight is running in the HA mode. For more information about the HA mode, see the High Availability Field Guide.

Configuration parameter: foglight.ha.jrmp.invoker.port

8080

HTTP Port

Management Server

Browser interface and Agent Manager

Yes

From the browser interface to the Management Server and from the Agent Manager to the Management Server

Description: HTTP/1.1 connector used for HTTP connections.

Configuration parameter: foglight.http.port

8443

HTTPS SSL Port

Management Server

Browser interface and Agent Manager

Yes

From the browser interface to the Management Server and from the Agent Manager to the Management Server

Description: HTTP/1.1 connector used for HTTPS connections.

Configuration parameter: foglight.https.port

The Management Server uses the HTTP port for local access even if you are accessing the browser interface through an HTTPS connection. If that is the case, both ports are open: the HTTPS port for external requests coming from the browser interface and the HTTP port for local requests. For example, the reporting service accesses the Management Server through the HTTP port while external requests use HTTPS.

8448

QP5 Application Port

Management Server

Management Server

No

Local to Management Server

Description: Port for the SQL parser.

Configuration parameter: foglight.qp5app.port

41705

JavaEE Agent

Management Server

JavaEE Agent

Yes

From JavaEE Agent to Management Server

Description: Port used by the JavaEE Agent. For more information about the JavaEE Agent, see your Cartridge for Java EE Technologies documentation.

Configuration parameter: Unlike other configuration parameters that are described in this table, whose values can be viewed and edited in the server configuration file, <foglight_home>/config/server.config, this port can be set in the configuration file that ships with the JavaEE Agent. For more information about this file, see your Cartridge for Java EE Technologies documentation.

45566

Cluster Mcast Port

Management Server

Management Server

No

From HA Management Server Primary to HA Management Server Secondary and the other way around

Description: Cluster multi-cast port. It is used when Foglight is running in the HA mode. For more information about the HA mode, see the High Availability Field Guide.

Configuration parameter: foglight.cluster.mcast_port

The Foglight Management Server supports to configure a new language for a PDF report. Once this language is imported, users can view the PDF report without installing this language as it has been embedded into the report by default.

1
On the navigation panel, under Dashboards, click Administration > Setup > Management Server Configuration.
The Management Server Configuration dashboard appears in the display area, showing a list of views that are associated with the Management Server.
2
In the Report section, click the Edit button next to Import a new language for PDF.
The Import Language Font dialog box appears.
Font Name: Specifies the name of the imported language, for example, Garuda.
Character Start Range: Specifies the start range of Unicode characters. The value of this field must be integer, for example, 3584 (for Thai). Search for Unicode character ranges yourself and enter the corresponding start range in this field.
Character End Range: Specifies the end range of Unicode characters. The value of this field must be integer, for example, 3711 (for Thai). Search for Unicode character ranges yourself and enter the corresponding end range in this field.
Font Path: Specifies the file folder under which the language file (.ttl) locates. for example, C:\temp. This field is mandatory for the languages that are not installed on your operating system (OS). If you are going to import a language that has been installed on your OS, leave this field blank.

Some Foglight dashboards have reports associated with them. This allows you to run a report based on the current dashboard. You can generate the report using the Reports menu in the top-right corner.

The Management Server Configuration dashboard is associated with the Management Server Configuration Report. Run this report by selecting Management Server Configuration Report from the Reports menu, and specifying the input parameters in the report wizard.

The report wizard provides more information about the Management Server Configuration Report and instructions on how to set the input values. For more information about reports in Foglight, see the Foglight User Help.

Connection Status

The Connection Status dashboard lists the users that are logged in to the Management Server. For each user, the list shows the client IP address, login time, request name, and request time.

On the navigation panel, under Dashboards, click Administration. In the Investigate column, Server section, click Connections.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating