Foglight 7.3.0 - Administration and Configuration Guide


	TIP: If you prefer working with the previous version of the Administration dashboard, you can switch to it by clicking the link: Use 5.6 Administration View. For more information, see Explore the 5.6 Administration View.

Use this view to access some of the most common tasks in Foglight, as an alternative to the navigation panel. The following table lists the entries on the Administration dashboard and provides links to the associated dashboards or views.

Table 1. Links available on the Administration dashboard.
	Entry		Dashboard or View	Use this dashboard to
Monitor
	Agents
		All	Agent Status	Configuring Foglight Agents for Host Monitoring
		Credentials	Credentials	Controlling System Access with Credentials
		Global Properties	Agent Properties	Edit instance-specific agent properties
		Agent Managers	Agent Managers	Configuring Foglight Agents for Host Monitoring
	Rules
		All	Rules	Configure Rules and Metric Calculations to Discover Bottlenecks
		Variables	Manage Registry Variables	Working with Foglight Registry Variables
	Blackouts		Blackouts	Suspending Alarms and Data Collection
	Downloads		Components for Download	Download Foglight agent components using the browser interface
Investigate
	Data
		Retention Policies	Retention Policies	Manage Foglight Database Performance
		Object Cleanup	Object Cleanup	Manage Foglight Database Performance
		Derived Metrics	Derived Metrics	Working with Derived Metrics
		Thresholds	Manage Thresholds	Working with Metric Thresholds
		Script Console	Script Console	Building Script Agents
	Server
		Logs	Log Analyzer	Explore server logs
		Performance	Performance Overview	Monitor Server Performance
		Connections	Connection Status	Viewing Client Connection Status
		Audit Information	View Audit Information	Viewing Audited Entries
		Configuration	Management Server Configuration	Viewing Configuration Details
Administer Server
	Users & Security		Users & Security Management	Managing Users and Security
	Cartridges		Cartridge Inventory	Enable or disable Foglight cartridges
	Email		Email Configuration	Configuring email notifications
	Licenses		Manage Licenses	Managing Licenses
	Usage Feedback		Usage Feedback	Enabling Usage Feedback
	Schedules		Manage Schedules	Create a new schedule
	Proxy Configuration		Configure proxy	Setting up Proxy Configuration
	Updates		Automatic Communication with Quest	Enabling Automatic Communication with Quest
Support
	Support Bundles		Support Bundles	Managing Support Bundles
	Support Notifications		Automatic Communication with Quest	Enabling Automatic Communication with Quest

Explore the 5.6 Administration View

The Administration dashboard contains links to typical administration tasks. It displays configuration specifics that are of interest to daily administration.

Figure 2. The 5.6 Administration View.

Use this view to access administrative tasks, as an alternative to the navigation panel. The following table lists the entries in the Administration dashboard and identifies the dashboards or views that they link to.

Table 2. Links available on the 5.6 Administration dashboard.
Entry		Dashboard or View	Use this dashboard to
Agents
	Status	Agent Status	Manage individual agent instances
	Properties	Agent Properties	View and edit global agent properties
	Hosts Running Agents	Agent Managers	Deploy agent packages to Agent Managers
	Support Bundles	Agent Manager Support Bundle	Explore and manage Agent Manager support bundles
	Adapters	Agent Adapters	Activate or deactivate agent adapters
Credentials
	Credential Management	Credentials	Manage credentials
Cartridges
	Inventory	Cartridge Inventory	Install, view, and manage cartridges
	Component Download	Components for Download	Explore and download agent installers
Data
	Data Management	Object Cleanup Retention Policies	Explore the topology model
	Metrics	Manage Derived Metrics	Explore and manage derived metrics
	Metric Diagnostics	Derived Metrics Diagnostics	Inspect run-time behavior of derived metrics
	Intelliprofile	IntelliProfile	Review activity levels
	Thresholds	Manage Thresholds	Explore and manage thresholds
	Topology Types	Add Topology Type	Add custom topology types
Rules and Notifications
	Rules	Manage Rules	Explore and manage rules
	Rule Diagnostics	Rule Diagnostics	Inspect run-time behavior of rules
	Variables	Manage Registry Variables	Explore and manage registry variables
Schedules
	Schedule Management	Manage Schedules	Explore and manage schedules
Support
	Configuration	Foglight Configuration	Explore Foglight configuration items
	Audit Information	View Audit Information	Explore audit log entries
	Blackouts	Blackout Configuration	Suspend alarms or data collection
	Connection Status	Connection Status	View existing users connected to the server
	Email	Email Configuration	Configure email notifications
	Licenses	Manage Licenses	Explore and manage licenses
	Support Bundles	Manage Support Bundles	Explore and manage server support bundles
	Usage Feedback	Usage Feedback	Enable or disable usage feedback
Tooling and Diagnostics
	Server Log Overview	Log Analyzer	Explore server log entries
	Server Performance Overview	Performance Overview	Inspect the server performance
	Script Agent Builder	Script Agent Builder	Build custom, script-based agents
	Script Console	Script Console	Write queries and scripts against the current data set
Users and Security
	Users & Security Management	Users & Security Management	Explore and manage user access

Explore the Current Statistics view

The Current Statistics view contains information about the installed cartridges, active agents, rules, users, and the Foglight Management Server configuration.

Figure 3. The Current Statistics view on the Administration dashboard.

This view displays the following information:

•

Active Agents shows the number of current agent instances. Each Foglight agent is a process that monitors a specific part of your environment, such as an operating system, application, or server. This number gives you a rough idea on how much data is coming into the Foglight Management Server. If you have no active agents, there is probably a connectivity issue between the agents and Foglight Management Server. If that number is lower than you think it should be, clicking this entry drills down to the Agent Status dashboard. Use this dashboard to find out which agent instances are not connected.

•

Installed Cartridges shows the number of Foglight cartridges in your system. A Foglight cartridge contains components that encapsulate a specific Foglight functionality. Your monitoring environment includes a set of server-specific cartridges, as well as additionally installed Foglight cartridges that are designed to monitor a specific type of environment. This number includes both the cartridges that come with the Foglight Management Server, and any other installed cartridges that exist in your system. Clicking this entry drills down to the Cartridge Inventory dashboard. Use this dashboard to view the list of all cartridges that exist in your monitoring environment.

•

Rules shows the number of rules that exist in your monitoring environment. This number includes the rules that come with the Foglight Management Server, any installed cartridges, and also any rules that you create. It gives you an idea of how much business logic is running on your server. That number is proportional to the number of cartridges you deploy. It is also a good general indicator of the environment complexity. The more rules you have, the more work the server is doing to analyze the data and generate alarms. Clicking this entry drills down to the Manage Rules dashboard. Use this dashboard to view, edit, and create rules.

•

Users shows how many active users are currently logged in, and the total number of users logged into Foglight. They also give you an idea how many people are accessing Foglight. If the users experience slow response, that might be caused by a large number of users and you might want to consider using federation to separate users’ actions from data processing. Clicking this entry drills down to the Manage Users dashboard. Use this dashboard to view and create users.

•

Server Version contains the server and build version numbers. Clicking this entry drills down to the Foglight Configuration dashboard. Use this dashboard to view the server configuration.

•

Server OS identifies the operating system of the computer on which the Foglight Management Server is installed. Clicking this entry drills down to the Foglight Configuration dashboard. Use this dashboard to view the server configuration.

Explore the License Information view

The License Information view contains information about one or more installed licenses. Expired Foglight licenses can cause unwanted behavior and this can be prevented by ensuring that your Foglight licenses are valid and up to date. Clicking an entry in this view drills down to the Manage Licenses dashboard. Use this dashboard to view and install Foglight license.

A Foglight license, typically distributed as in a foglight.license file, contains the information about the capabilities that are licensed. Installing this file on the Foglight Management Server enables all of the licensed capabilities.

Figure 4. The License Information view on the Administration dashboard.

This view displays the following information:

•

Installed Licenses contains the total number of all installed Foglight licenses that exist in your system, including current and expired licenses.

•

Expired Licenses contains the number of expired licenses that exist in your system.

•

Licenses Expiring in 30 Days contains the number of licenses that will expire in the next 30 days.

Explore the Federation view

The Federation view contains information about the server federation. Federation is a Foglight feature that allows you to monitor large environments that are partitioned into logical units, where each unit acts as a data source, managed by a Foglight Management Server instance (Federated Server), and a Federation Server, that 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.

Figure 5. The Federation view on the Administration dashboard.

This view displays the following information:

•

Mode tells you whether the current Foglight Management Server installation is a child (Federated Server) or a master (Federation Server) in a federated system.

•

Standalone indicates that your server is a Federated Server, or 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 Foglight Management Server installation in a federated system. If this setting shows zero ‘0’, combined with the Federation Mode value of Child/Standalone, that is a good indicator that your monitoring environment is not federated.

Explore the High Availability view

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 Installation and Setup Guide set.

Figure 6. The High Availability view on the Administration dashboard.

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.

Send messages to active Foglight users

The Administration home page includes a messaging action that allows you to send messages to all Foglight users that are currently logged into the browser interface. The messaging action can be initiated from the action panel on the right. Use it to quickly inform current users of any administration activities that may disrupt their work, or affect it in any way. For example, before shutting down the server, send a message to all active users, giving them sufficient time to save their work.

To send a message to all active Foglight users:

On the navigation panel, under Homes, click Administration.

Open the action panel on the right side of the browser interface.

On the action panel, under Actions, click Send Message.

Type the message subject in the Subject box in the Send Message to All Users dialog box. For example:

Server restart

In the Message box, type the message text. For example:

The server will be restarted in 15 minutes. Please save your work.

Choose the length of time during which the message appears in the message box as described in Step 8.

Click Expires in and select the from the existing values: 5 Minutes, 15 Minutes, 30 Minutes, 1 Hour, or 24 Hours.

Choose the message level that best describes the message severity.

Click Message Level and select from the existing values: Info, Warning, or Error.

Click Send.

The Send Message to All Users dialog box closes and a message box appears in the top-right, just above the action panel.

In a few moments, the same message appears in the browser interface of every active user, regardless of their access permissions and the page they currently have open.

The number in the top right, just above the message window is the message counter, indicating the number of these types of messages received so far.

The message box closes after a few moments.

To delete one or more messages from the collection of all received messages:

To expand the message box, click the message counter, or the message box while it is still open.

To delete one message, click

on the right of the message subject.

To delete all messages, click Clear All.

The deleted messages no longer appear in the message box and the message counter resets to zero ’0’.

To close the message box, click Close.

Run the Environment Report

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 Administration home page is associated with the Environment Report. Run this report by choosing Environment Report from the Reports menu, and specifying the input parameters in the report wizard.

Figure 7. The Administration dashboard with the Reports menu selected.

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

LogAnalyzer

Explore server logs

Use the Log Analyzer dashboard to view the contents of any types of log files, or download log files to a desired location. The time, level, source, and description of log messages appear for each log you view using this dashboard.

To view server logs:

On the navigation panel under Dashboards, choose Management Server > Diagnostic > Log Analyzer.

To view the list of log messages in this dashboard, on the Log Analyzer dashboard, click Open.

In the Log Selector dialog box that appears, select the log file whose contents you want to view.

The list of log entries on the Log Analyzer dashboard refreshes, showing the log entries from the selected log files.

To download the selected log file, click Download and save the file to a desired location.

Schema Browser

Explore data objects in Foglight

The Schema Browser dashboard shows the structure of the data model and allows you better understand the database schema and the existing object dependencies.

To explore a data object:

On the navigation panel, under Dashboards, choose Development Tools > Schema Browser.

Find the data type in the list.

•

Scroll down the list to locate the data type

•

To narrow down the search criteria, type a character in the Search by Name box (for example, Host) and click Search.

•

To search by a regular expression, click Property Search. Type the property name or the topology type, and click Search.

When you select an object type, you can sort by various constituents of the object by using the View by options: Properties, Ancestors, Descendants, and Instances.

Database Overview

•

Explore the database activities

•

Grant permissions to explore database activities

Explore the database activities

Use the Database Overview dashboard to see the state of the Foglight database and its activity. This dashboard contains several views that show the row operations, database buffer pool, and/or the number of inserts, deletes, and/or updates. Its appearance depends on the database type in use. For MySQL databases, this dashboard shows four different views: Row Operations, Database Buffer Pool Status, Database Data I/O, and Database Page I/O. For Oracle, PostgreSQL and MS SQL Server databases, the dashboard shows only the Row Operations view.

To view database details:

In the navigation panel, under Dashboards, click Management Server > Servers > Database Overview.

Choose the database type from the Choose a Foglight Server box.


	NOTE: If Choose a Foglight Server does not contain entries for Oracle or MS SQL Server, databases, you might need to grant additional permissions to the database user. For more information, see Grant permissions to explore database activities.

The Database Overview dashboard refreshes, showing the information for the selected database:

MySQL databases only.

Consult the views on the dashboard, which display charts for:

•

Row Operations

•

Database Buffer Pool Status

•

Database Data I/O

•

Database Page I/O

Oracle, PostgresSQL and Microsoft SQL Server databases only.

The following metrics are plotted on a single chart:

•

Database Row Insert

•

Update

•

Delete

The name of the metrics that contain database reads, inserts, and updates depend on the type of the supported database that Foglight uses to store information, as indicated in the following table.

Table 3. Metric names for database activities in Foglight.
Database	Metric
MS SQL, PostgreSQL	num_rows_deleted
	num_rows_inserted
	num_rows_updated
MySQL	innodb_rows_inserted
	innodb_rows_inserted_per5min: #innodb_rows_inserted# * 300
	avg_inserts_per5min: avg(#innodb_rows_inserted_per5min for 60 minutes#)
Oracle	qa_db_inserts : select sum(inserts) from sys.dba_tab_modifications where TABLE_OWNER='xxxx'
	delta_db_inserts: delta(#qa_db_inserts from QA_DB_INSERTS_Agent_Table_DB_INSERT_COUNT#)
	delta_avg_per5min: avg(#delta_db_inserts for 60 minutes#)

Grant permissions to explore database activities

To populate the database charts that are available for Oracle and Microsoft SQL Server on the navigation panel under Dashboards > Management Server > Servers > Database Overview, you need to grant the special permissions on the back-end database for the Foglight Management Server. For a MySQL or PostgreSQL database, special permissions are not required.

To grant permissions to explore database activities:

•

For Microsoft SQL Server, run the following command to grant permissions for the database user:

use master;

exec sp_adduser @loginame = 'fmsdbuser';

grant select on fn_dblog to fmsdbuser;

•

For Oracle, run the following command to grant permissions for the database user.

grant analyze any to fmsdbuser;

Where fmsdbuser is the name of the Foglight database user, as defined by the foglight.database.user parameter in <Foglight_home>/config/server.config.


	NOTE: You may need to restart the Management Server service to ensure that the permissions are updated. This is because database connections to the external database are already established.

Please select your product:

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

Recommended Solutions for Your Problem

Foglight 7.3.0 - Administration and Configuration Guide

Administration Home

LogAnalyzer

Schema Browser

Database Overview