Chat now with support
Chat with Support

Foglight Evolve 9.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

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.

View Audit Information

Use the View Audit Information dashboard to explore log entries. Log entries show the users that are logged in, changes made to user security settings, or any changes made to rules, schedules, or registry variables. Select a time period for which you want to view the logs, and optionally, print the desired set of entries to a file.

1
On the navigation panel, under Dashboards, click Administration > Setup > View Audit Information.
Time Range: Displays the date and time at which the specified action occurred.
User Name: Displays the user name for the user who caused the action to be performed.
Service Name: Displays the name of the Foglight service that performed the action.
Operation Name (Name): Displays the operation that was performed by Foglight. If applicable, the name of the item that was changed is also displayed in this column.
Entity ID: Displays the entity ID.
Click the Show/Hide columns button to the right of the Search box, and then indicate which columns you want to display.
Click the Show/Hide columns button. At the bottom of the list, under Actions, click Export. Select the desired output format: Export as PDF, Export as CSV, Export as Excel, or Export as XML.
Clicking Export as PDF opens the PDF output in your web browser.
Clicking Export as CSV, Export as Excel, or Export as XML opens a dialog box, allowing you open the exported file, or to save it to disk.

The following table lists the operations that are audited by Foglight. In addition to the operations listed below, Foglight audits the following operations:

cloneConfigModel(PropertyPath, String)

cloneConfigModel(String, String, String, String)

deleteClonedConfigModel(PropertyPath)

deleteClonedConfigModel(String, String, String)

removePrivateProperty(PropertyPath)

removePrivateProperty(String, String, String)

saveConfigModel(PersistableConfigModel, Boolean)

activate(String)

deactivate(String)

delete(String)

markObsolete(String)

startDataCollection(String)

stopDataCollection(String)

acknowledgeAlarm(String)

autoAcknowledgeAlarm(String)

clearAlarm(String)

activateCartridges(Collection<String>, boolean)

installCar(String)

activateCartridge(String)

deactivateCartridge(String)

uninstallCartridge(String)

com.quest.nitro.admin.ui.xwork.action.navigation.LandingPageActionsessionDestroyed(HttpSessionEvent)

sessionCreated(HttpSessionEvent)

sessionDestroyed(HttpSessionEvent)

deleteDerivations(Set<String>)

saveDerivation(DerivationInterface)

deleteModelAssociation(ModelAssociation)

deleteModelAssociation(String)

saveModelAssociation(ModelAssociation)

cancelScheduledTasks(String, String)

migrateAgent(String, String, String, Map<String, Object>)

migrateData(String, String, String, Map<String, Object>)

migrateDcm(String, String, String, Map<String, Object>)

refreshFgl4Server(String, boolean)

registerFgl4Server(String, String, String, Integer, String, String, String, File, boolean)

registerHostNameMapping(String, String, String)

unregisterFgl4Server(String)

unregisterHostNameMapping(String, String)

importLicenseFromFile(String)

removeLicense(String)

abort()

commit()

logout()

exportToFile(String)

importFromFile(String)

deleteGroupingPolicy(GroupingPolicy)

deleteGroupingPolicy(String)

deleteLifecycle(Lifecycle)

deleteLifecycle(String)

deleteRetentionPolicy(RetentionPolicy)

deleteRetentionPolicy(String)

deleteSchema(Schema)

deleteSchema(String)

saveGroupingPolicy(GroupingPolicy)

saveLifecycle(Lifecycle)

saveObservationLifecycle(ObservationLifecycle)

saveRetentionPolicy(RetentionPolicy)

saveSchema(Schema)

setDefaultLifecycle(ObservationLifecycle)

deleteRegistryVariables(Collection<RegistryVariableInfo>)

saveRegistryVariable(RegistryVariableInterface)

downloadClientFile(String, String, File)

initializeAgent(String, String, String)

initializeAgentAsync(String, String, String)

installAgentPackage(String, String)

deleteGeneratedReports(List<DataObject>)

deleteReportResults(List<String>)

deleteReportResults(String)

deleteScheduledReport(ScheduledReport)

executeReport(ReportContext)

generateReport(ReportContext, String)

saveScheduledReport(ScheduledReport)

deleteRule(String)

deleteRules(Set<String>)

saveRule(Rule)

suspendRuleActions(String, Date)

suspendRuleAlarms(String, Date)

unsuspendRuleActions(String)

unsuspendRuleAlarms(String)

deleteSchedules(Set<String>)

saveSchedule(NamedScheduleInterface)

invoke(ScriptInvocation)

runNamedScript(String, ScriptExecutionParams)

runScript(String, ScriptExecutionParams)

runScript(String, String, Object[])

runScript(String, String, TopologyObject)

runScript(String, String)

verify(ScriptVerification)

verifyScriptText(String)

addGroupToUser(SecUser, SecGroup)

addRoleToGroup(SecGroup, SecRole)

addRoleToUser(SecUser, SecRole)

changeOwnPassword(String, String, String)

changeUserPassword(String, String, String)

createGroup(String, String, String, boolean)

createGroupNesting(SecGroup, SecGroup)

createRole(String, String, String, boolean)

createUser(String, String, String, String, boolean, boolean, boolean)

deleteGroup(SecGroup)

deleteGroupNesting(SecGroupNesting)

deleteObjPermission(SecObjectPermission)

deleteRole(SecRole)

deleteUser(SecUser)

deleteUserObjPermission(SecUserObjPermission)

setObjAceByIds(String, String, int, boolean, String)

setObjAceByNames(String, String, int, boolean, String)

setUserObjAceByIds(String, String, int, boolean, String)

setUserObjAceByNames(String, String, int, boolean, String)

storeGroup(SecGroup)

storeGroupNesting(SecGroupNesting)

storeLdapConfig(SecJaasLdapConfig)

storeObjPermission(SecObjectPermission)

storeRole(SecRole)

storeUser(SecUser)

storeUserObjPermission(SecUserObjPermission)

createSupportBundle()

createSupportBundle(SupportBundle)

deleteBundle(SupportBundle)

deleteThreshold(String)

deleteThreshold(Threshold)

saveThreshold(Threshold)

 

Online-Only Topics

Learn more about:

Related Documents