Chat now with support
Chat with Support

Foglight for Databases 5.9.4 - 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

Configure Password Settings

Foglight password settings dictate the restrictions for password creation. Use the Password Settings view to explore and edit these settings to comply with your security requirements.

For example, you can set the complexity level that must be used in the passwords of internal users and the users with the Security role. Foglight uses the following levels:

1: Passwords are not checked for complexity.
2: Passwords must contain both alphabetic and numeric characters.
3: Passwords must contain at least one upper case letter, lower case letter, and numeric character, as well as at least one character that is not alphanumeric.

The security levels are set as User password complexity level and Administrator password complexity level values.

By default, the complexity level for internal users’ passwords is 2, while the default complexity level for users with the Security role is 3. The complexity level for administrator passwords must be set to 2 or higher.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
3
On the Password Settings view, click the Value of the property that you want to edit.
The Password Settings view refreshes, showing the updated setting.
4
Editing multiple settings. On the Configure Password Settings view, click Edit.
The Settings Editor dialog box opens.
Click Save.
After a few moments, the message box closes, indicating success. The Configure Password Settings view refreshes, taking into account the latest changes, as applicable.

Configure Directory Services

Default settings for LDAP directory servers are different. Use the following information as guidelines and substitute the default settings with the most appropriate values. See the documentation for your specific LDAP server for more information about these settings and the applicable values.

If you are using Active Directory, and have trusts configured to allow users from one domain to access resources in different domain, keep in mind that these trusts require OS authentication and as such cannot be used in Foglight. When LDAP is configured, Foglight authenticates users through the main Active Directory forest, but it only searches the domains that are the children of the primary LDAP server (specified by the Nearest LDAP server URL setting). If the primary LDAP server fails, it searches the domains that are the children of the secondary LDAP server (specified by the Secondary LDAP server URL setting). For more information about problems that you may encounter when configuring LDAP with Active Directory, see Common Active Directory configuration problems.

Learn more about:

Nearest LDAP server URL: The URL to the primary LDAP server.
host is the fully qualified domain name or IP address of the LDAP server.
port is the port number of the LDAP server.
Secondary LDAP server URL: The URL to the secondary LDAP server.
If you are using Active Directory, and the primary LDAP server (specified by the Nearest LDAP server URL setting) fails, Foglight searches the domains that are the children of the secondary LDAP server.
Account is anonymous: If set to true, Foglight uses an anonymous service account to search for users in the extended directory. The default user name for anonymous service accounts is __anonymous__. Enabling this option sets the Distinguished name of the service account to __anonymous__.
Distinguished name of the service account: The distinguished name (DN) of the service account for further user searching, or a special account, such as __anonymous__. In Active Directory, typically, a common name (CN) is used instead of DN.
Group attribute for nested group searching: Specifies the name of the attribute of groups (for example, member) that contains nested groups’ distinguished names. It is used for resolving nested group membership in indirect Mode of group searching.
JAAS LoginModule Name: This setting is internal and as such should never be modified.
Match on User DN: Indicates if user distinguished names are matched.
Maximum level of group nesting: Specifies the maximum number of nested groups that can be queried.
Parent group attribute ID: Specifies the name of the attribute of users and groups (for example, memberOf) that holds the containing groups’ distinguished names. Used for resolving group membership of users and recursive groups in direct Mode of group searching.
Password: The password of the service account used for user searching in the external directory.
LDAP query prefix, LDAP query suffix: An LDAP query searches for user accounts in the external directory. It takes the user information provided on the Foglight login page (see Logging in to the Foglight browser interface) and searches for user information in the external directory. The directory tree typically contains multiple levels. Searching individual parts of the directory tree makes the authentication process shorter and more efficient as opposed to searching the entire directory tree which can result in request time-outs. You can narrow down to the specific groups that you want the LDAP queries to use by setting the prefix and suffix of the query.
LDAP query suffix: ,CN=Users,DC=2k3,DC=dom
Role attribute ID, Is Role attribute a DN: Groups in the external directory are objects with attributes. Each attribute has an ID and a value.

The setting Role attribute ID specifies the name of the attribute that uniquely identifies the name of the role in the external directory. LDAP queries use the role attributes to authenticate users.

Is Role attribute a DN
specifies if the role attribute is a distinguished name.
Mode of group searching: Indicates the direction in which groups are searched:
disabled: Do not search for groups.
direct: Search for groups using the Parent group attribute ID (for example, memberOf).
The scope(s) to search for groups, The second group namespace, and The third group namespace: These settings indicate the groups in the external directory tree that are queried for a specific user whose authentication information is provided on the Foglight login page. You can specify up to three groups in the external directory, as required. The order in which the groups are searched is determined by the order these settings are listed: first, the query searches the group specified by the The scope(s) to search for groups setting, then the group specified by The second group namespace, and finally, the group specified by The third group namespace.
Environments with up to three or four users: There is no need to assign these groups. Instead, have the Foglight administrator assign the required roles after the initial user logins.
Larger environments: In Active Directory, create the same set of groups that exist in Foglight: Foglight Administrators, Foglight Security Administrators, and Foglight Operators. Add Active Directory user accounts that you want to integrate with Foglight to these groups, and set the The scope(s) to search for groups to point to the OU contaning these groups.
LDAP search timeout (milliseconds): Specifies the maximal duration of an LDAP search, in milliseconds. LDAP searches that take longer than that result in time-outs.
Name of JAAS security domain: This setting is internal and as such should never be modified.
User alias attribute ID: User accounts in an external directory can have aliases. This setting specifies the name of the attribute associated with the user alias.
User attribute ID to search for groups: Specifies the name of the attribute of groups (for example, member) that contains users’ distinguished names. It is used for resolving group membership through groups in indirect Mode of group searching.
The LDAP context for user searching: Similar to specifying the groups in the directory tree, this setting provides a way for selecting a portion of the directory tree, giving a context to the query.
LDAP query suffix: ,CN=Users,DC=2k3,DC=dom
The LDAP context for user searching: CN=Users,DC=2k3,DC=dom

ldap://ukdatemea01:389

ldap://uklonemea01:389

No

Yes

No

CN=JW admin,OU=EMEA Admins,DC=emea,DC=corp,DC=apax,DC=com

__anonymous__

CN=foglight_admin, O=services

member

uniqueMember

member

com.quest.nitro.service.security.auth.spi.NitroExtendedLdapLoginModule

true

5

memberOf

********

CN=

uid=

CN=

,CN=Users,DC=emea,DC=corp,DC=apax,DC=com

,OU=Employees,DC=example,DC=com

,O=novell

name

cn

cn

false

direct

indirect

direct

OU=Foglight Admins,DC=emea, DC=corp,DC=apax,DC=com

Note: Setting the scope to search for a group with the ldap root DN may cause a javax.naming.PartialResultException during searching. To search from the root DN, change the ldap url to use a global category. For example, setting the Nearest LDAP server as ldap://ukdatemea01:3268 should prevent a javax.naming.PartialResultException.

OU=Groups,DC=example,DC=com

O=novell

OU=EMEA Admins, DC=emea,DC=corp,DC=apax,DC=com

 

OU=Dynamic Groups,DC=example,DC=com

N/A

CN=Foglight,OU=EMEA Admins,DC=emea,DC=corp,DC=apax,DC=com

N/A

10000

fgl-web-console

sAMAccountName

uid

uniqueId

memberOf

uniqueMember

member

OU=EMEA Admins,DC=emea,DC=corp,DC=apax,DC=com

OU=People,DC=example,DC=com

o=novell

Integrating Active Directory with Foglight can sometimes result in configuration problems. This topic lists the common configuration problems and provides the suggested solutions.

The Service Account must use the distinguished name (DN) format. The syntax must match exactly how the LDAP directory sees the object. You can use an LDAP browser (free LDAP browsers are available for download) to inspect your LDAP directory.

You can use the Active Directory dsquery command to see the DN for a Service Account.

This command creates a text file that you can search for proper Service Account DNs.

For example:

Foglight uses the LDAP context for user searching setting to determine where to start looking for LDAP users in the LDAP directory when an LDAP user logs into Foglight. Foglight searches for that user in that location, and every container level under that starting point. If the user account is at a higher level than what is set by the LDAP context for user searching, the login fails.

To test this behavior, simply set the context to the highest level of the LDAP tree. In Microsoft Active Directory, this is the Domain. For example, if the AD domain is example.com, the .LDAP context for user searching can be set to DC=example,DC=com.

You can adjust this setting later after ensuring that Foglight integration with LDAP works.

Foglight can only handle any check and return requests coming from LDAP. For example, Foglight cannot process requests for changing passwords that occur during login. Other types of requests that are also not handled by Foglight include: prevention of logon hours, prevention of logon to (specific workstations), password expirations, disabling accounts, and proprietary security requests. See your LDAP Administrator to help you inspect the Service Account.

To test this, log in to a Windows machine, to the Domain using the specified LDAP account. If anything is presented other than a successful login, Foglight will have a problem with this when it tries to submit an authentication. See your LDAP administrator to resolve your LDAP account issues.

If LDAP authentication is not working in Foglight, try configuring the LDAP query prefix setting to force using older NTLM authentication. Do this by changing the LDAP query prefix from “CN=” to “sAMAccount=” .

Cross-reference your Configure Directory Services settings with those on another Management Server that are not edited. Compare the formats of the entries. Check the settings that you think have not changed. Examples of incorrect formatting include:

Missing the leading comma in the LDAP query suffix setting. The valid format looks like this:
Changes to the JAAS LoginModule Name setting. The valid format looks like this:

Observing the result of a login attempt can often tell you if LDAP is successfully configured.

To do that, log in to the Foglight browser interface using your Active Directory account. If LDAP is successfully configured, you see the following message:

This message confirms that the LDAP configuration is successful. You just need to log in as a Foglight Security Administrator and add the newly added LDAP (External) user to a Foglight group which has the appropriate abilities (roles) granted.

If LDAP is not configured correctly, you see the following message:

You can return to the beginning of this topic and go through the troubleshooting steps to determine the problem.

Starting with the Foglight Management Server 5.7.5.7, it is possible to configure multiple LDAP directories and you are allowed to select any of the LDAP configurations for user authentication.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Configure Directory Services view appears.
3
From the Configuration for drop-down list, select an LDAP configuration to be used for leverage.
4
Click Copy & Create on the upper right corner of the Configure Directory Services view.
The Copy Configuration dialog box appears.
5
Click OK to copy and create a new LDAP configuration based on the selected one.

You are allowed to activate an LDAP configuration for authenticating the user login to Active Directory, as needed.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Configure Directory Services view appears.
3
From the Configuration for drop-down list, select an LDAP configuration that you want to use for the user authentication.
4
Click Activate.
The Update Directory Services Status dialog box appears, and the selected LDAP configuration is activated.

Once an LDAP configuration is activated, the Activate button will be changed to Deactivate. You can repeat the above workflow to deactivate this LDAP configuration when needed.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Configure Directory Services view appears.
3
From the Configuration for drop-down list, select an LDAP configuration that you want to delete.
4
Click Delete.
The Delete Configuration dialog box appears.
5
Click OK.
The Configure Directory Services view refreshes automatically and removes the selected LDAP configuration.

With the support of multiple LDAP configurations, the Foglight Management Server enables you to sort the LDAP query configurations for more effective user authentication.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Configure Directory Services view appears.
3
Click Reorder on the upper right corner of the Configure Directory Services view.
The Sort LDAP Configurations dialog box appears.
4
Click the arrow under the Move Up or Move Down column to sort LDAP configurations, as needed.
5
Click Save.

Use the Configure Directory Services view to enable Foglight to access user information that is stored in an external directory and to test these settings.

2
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Configure Directory Services view appears.
1
On the Configure Directory Services view, click Reorder.
The Sort LDAP Configurations dialog box appears.
2
Click Move Up or Move Down to sort LDAP configurations, as needed.
5
Editing one setting at a time. On the Configure Directory Services view, click the Value column of the setting you want to edit.
Type the desired value into the dialog box and click Save. A message box opens, indicating that your changes are being saved.
After a few moments, the message box closes, indicating success. The Configure Directory Services view refreshes, showing the updated setting.
a
To edit the LDAP server’s URL, in the LDAP Locations view, click Edit.
Replace the default Nearest LDAP server URL and Secondary LDAP server URL entries with the valid values, as applicable. To test the connectivity to the nearest and secondary LDAP servers, click Test. When done, save your changes by clicking Save.
The URLs Editor dialog box closes and a message box opens, indicating that your changes are being saved.
After a few moments, the message box closes and the LDAP Locations view refreshes, showing the newly-edited values.
b
To edit the remaining settings, in the Settings view, click Edit.
The Settings Editor dialog box closes and a message box opens, indicating that your changes are being saved.
After a few moments, the message box closes and the Settings view refreshes, showing the newly-edited values.
a
In the Settings view, click Test Configuration.
The Test Configuration dialog box opens.
b
In the Test Configuration dialog box, type the name of a user account that exists in the newly integrated external directory, and click Test.
The Name Lookup Tracker message box opens.
After a few moments, the Name Lookup Tracker message box closes and the Test Result message box opens, listing the user names that start with the provided text.

Use the User Session Settings link on the Users & Security Management dashboard to configure the period of time after which Foglight logs out inactive users. You can set it to a desired number of minutes, or to an infinite period, as required. The time-out session minimum is five minutes.

1
On the navigation panel, under Dashboards, click Administration > Users & Security.
The Change User Session Timeout dialog box opens.
To define a specific user session timeout, in the Number of minutes after which user should be logged out box, type the number of minutes.
4
In the Change User Session Timeout dialog box, click OK.
The Change User Session Timeout dialog box closes and the User Session Settings task entry refreshes, indicating the newly configured timeout.

By default, global search is enabled for the Management Server. In some cases, you may want to disable global search, either for individual users, or for the entire Management Server. You can disable global search by following this procedure.

After you have disabled global search, you can enable it for specific users. Any users that require access to global search must have the WCF permission globalSearch set on their account. This allows you to control what users can access in their designated environment.

Where **Some other Role** is a role that you have created and assigned to users or groups that you want to be able to perform global search.

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

Related Documents