You are on page 1of 65

Foglight ®

5.5.8
Installation and Setup Guide
Installing on a UNIX System with an
Embedded MySQL Database
© 2010 Quest Software, Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is furnished
under a software license or nondisclosure agreement. This software may be used or copied only in accordance with
the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any
means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser’s
personal use without the written permission of Quest Software, Inc.
The information in this document is provided in connection with Quest products. No license, express or implied, by
estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of
Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE
LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND
DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY
DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING,
WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF
INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with
respect to the accuracy or completeness of the contents of this document and reserves the right to make changes
to specifications and product descriptions at any time without notice. Quest does not make any commitment to
update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software World Headquarters
LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656
www.quest.com
email: legal@quest.com
Refer to our Web site for regional and international office information.

Patents
This product includes patent pending technology.

Trademarks
Quest, Quest Software, the Quest Software logo, Foglight, IntelliProfile, PerformaSure, Spotlight, StealthCollect,
TOAD, Tag and Follow, Vintela Single Sign-on for Java, and vFoglight are trademarks and registered trademarks of
Quest Software, Inc in the United States of America and other countries. For a complete list of Quest Software’s
trademarks, please see http://www.quest.com/legal/trademark-information.aspx. Other trademarks and registered
trademarks are property of their respective owners.

Third Party Contributions


Foglight contains some third party components. For a complete list, see the License Credits page in Foglight online
help.

Installation and Setup Guide


November 2010
Version 5.5.8
Table of Contents

Introduction to this Guide ...................................................................................................................................5


About Quest Software, Inc. .............................................................................................................................................. 6
Contacting Quest Software...................................................................................................................................... 6
Contacting Quest Support ....................................................................................................................................... 6

Before Installing Foglight....................................................................................................................................7


What Is Foglight? ............................................................................................................................................................. 7
Hardware Requirements and Guidelines ......................................................................................................................... 8
Installation Recommendations ................................................................................................................................ 8
Hardware Requirements.......................................................................................................................................... 8
Planning Your Installation................................................................................................................................................. 9
Using Embedded Databases................................................................................................................................. 10
Licensing ............................................................................................................................................................... 10
Installation Modes.................................................................................................................................................. 11

Installing Foglight ..............................................................................................................................................17


Preparing to Install ......................................................................................................................................................... 17
Installing a New Version of the Foglight Management Server ....................................................................................... 18
Installing the Foglight Management Server - Standard Install Option ................................................................... 19
Foglight Server Startup Page ................................................................................................................................ 30
Next Steps ............................................................................................................................................................. 31
Embedded Foglight Agent Manager...................................................................................................................... 32
Installed Directories........................................................................................................................................................ 33
Foglight Settings............................................................................................................................................................. 35
Editing the foglight.config File................................................................................................................................ 35
Setting Up an Encrypted Database Connection with SSL..................................................................................... 35
Setting Up an Encrypted LDAP Connection with SSL........................................................................................... 36
4 Foglight
Installation and Setup Guide

Using Encryption When Sending Email from Foglight ........................................................................................... 37


Setting Parameters for an Embedded Database ................................................................................................... 37
Configuring Ports ................................................................................................................................................... 39
Setting Up Foglight Server Federation................................................................................................................... 40
Setting the SQL Parser Properties......................................................................................................................... 40
Setting Memory Parameters for the Server ........................................................................................................... 40
Adding Command-Line Options............................................................................................................................. 42
Configuring Foglight to Use Stronger Encryption................................................................................................... 43
Configuring Foglight to Use the HTTPS Port ......................................................................................................... 43
Uninstalling Foglight ....................................................................................................................................................... 45
Upgrading the Foglight Management Server.................................................................................................................. 46
Installing Foglight FAQ ................................................................................................................................................... 46

Running the Foglight Management Server ..................................................................................................... 49


Initializing the Database.................................................................................................................................................. 49
Starting and Stopping the Foglight Management Server................................................................................................ 50
Starting the Foglight Management Server ............................................................................................................. 50
Stopping the Foglight Management Server ........................................................................................................... 51
Logging in to Foglight ..................................................................................................................................................... 51
Next Steps ............................................................................................................................................................. 52
Migrating Data from an Existing Database ..................................................................................................................... 52
Running the Foglight Management Server FAQ............................................................................................................. 53

Installing and Upgrading Cartridges ............................................................................................................... 55


Accessing the Cartridge Inventory Dashboard ............................................................................................................... 55
Installing Cartridges ........................................................................................................................................................ 55
Upgrading Cartridges...................................................................................................................................................... 57
Next Steps ...................................................................................................................................................................... 57

Installing Agents ............................................................................................................................................... 59


Agent Installers ............................................................................................................................................................... 59
Remote Agent Installation............................................................................................................................................... 60

Appendix: Switching from an Embedded to an External Database ............................................................. 61

Index ................................................................................................................................................................... 63
Introduction to this Guide

This guide provides instructions for installing, configuring, and starting Foglight.
Before you begin, see the System Requirements and Platform Support Guide.
6 Foglight
Installation and Setup Guide

About Quest Software, Inc.


Quest Software simplifies and reduces the cost of managing IT for more than 100,000
customers worldwide. Our innovative solutions make solving the toughest IT
management problems easier, enabling customers to save time and money across
physical, virtual and cloud environments. For more information about Quest go to
www.quest.com.

Contacting Quest Software

Email info@quest.com

Mail Quest Software, Inc.


World Headquarters
5 Polaris Way
Aliso Viejo, CA 92656
USA

Web site www.quest.com

Refer to our Web site for regional and international office information.

Contacting Quest Support


Quest Support is available to customers who have a trial version of a Quest product or
who have purchased a Quest product and have a valid maintenance contract. Quest
Support provides unlimited 24x7 access to SupportLink, our self-service portal. Visit
SupportLink at http://support.quest.com.
From SupportLink, you can do the following:
• Retrieve thousands of solutions from our online Knowledgebase
• Download the latest releases and service packs
• Create, update and review Support cases
View the Global Support Guide for a detailed explanation of support programs, online
services, contact information, policies and procedures. The guide is available at: http://
support.quest.com.
1
Before Installing Foglight

This chapter provides setup information and an initial overview of installing Foglight.

Important See the Release Notes for Foglight, the Foglight Agent Manager, and any cartridges you
are installing. These documents contain important information about the latest versions
of these components, such as information about late-breaking changes, updates, and
known and resolved issues.

What Is Foglight?
Foglight is an application management solution that reduces or eliminates service
disruptions to unify IT and the business. Unlike other solutions, it provides a correlated,
360 degree view of your applications from end user to database and from service levels
to infrastructure—to source the root cause of every incident impacting your business
and fix them quickly. Foglight correlates data from multiple perspectives into a single
version of the truth to provide deep insight into the service relationships that exist
between end users, the business and infrastructure components. Its unique adaptive
technology rapidly adjusts to change for improved application performance and service
levels, reduced operational cost and risk, and enhanced visibility for all stakeholders.
Foglight comprises several different components, which are described in the Getting
Started Guide.
8 Foglight
Installation and Setup Guide

Hardware Requirements and Guidelines


The hardware requirements to run Foglight can vary widely, based on a number of
factors, including:
• The number and type of agents that are being used
• The persistence and data roll-up policies
• Agent configuration settings
You should not consider doing a production implementation without conducting a
proper scoping and sizing exercise with a qualified Quest Software representative. You
can arrange for a sizing analysis by contacting your Quest Software Sales
Representative.

Installation Recommendations
Running a Foglight server requires the following components:
• The Foglight Management Server
• The Foglight database repository
These components can be installed on a single tier or on multiple tiers. It is critical to
realize that both the management server and database repository require dedicated
resources to support them. In order to help facilitate sizing, the resources required to
support each component are addressed separately. They can either be summed to
support a single-tier installation, or treated independently as the requirements for each
server in a two-tier installation.

Hardware Requirements
For the current single- and multi-tier hardware requirements, see the System
Requirements and Platform Support Guide.
Before Installing Foglight 9
Planning Your Installation

Planning Your Installation


Before you install Foglight, you need to review the components that you are going to
install. Ensure that you have the necessary information, such as port numbers and server
names, and the locations where you are going to install the components.

Note This guide provides instructions for installing new instances of Foglight only, not for
upgrading Foglight.
For best practices for upgrading Foglight, an overview of the upgrade process, and upgrade
procedures, see the Upgrade Guide.

Note You can choose to use an embedded database or an external database. The instructions in
this guide are for embedded database installations only.

The following list summarizes the main stages involved in installing and configuring
Foglight:
Stage 1: Install the Foglight Management Server and configure the Management Server
and database. The Management Server is the data collection and processing server.
Stage 2: Start the Foglight Management Server and log in.

Note If you are using the embedded database, the database initialization occurs when you start
the Foglight Management Server.

Stage 3: Install and configure cartridges. Cartridges extend the functionality of


Foglight, and are installed on the machine hosting the Foglight Management Server. A
cartridge contains one or more cartridge components, such as agents for deployment,
communication capabilities, modifications to the way that data is transformed or
handled, rules, reports, and views.
Stage 4: Install, configure, and start the Foglight Agent Manager. The Foglight Agent
Manager is a client that manages agents installed on monitored hosts. See the Foglight
Agent Manager Installation Guide for details.
Stage 5: Install and configure agents. Agents are deployed on machines in your
monitored environment and send data to the Foglight Management Server. There are
several types of agents. One or more instances of each type of agent managed by the
Foglight Agent Manager can be deployed per host. For example, there is an agent that
collects metrics from the operating system of the host machine. There are also agents
that are embedded into systems or the software that they monitor. The Java EE
10 Foglight
Installation and Setup Guide

Technology Agent, which collects service request traces, runs embedded on Java EE
application servers.

Caution You must install and configure the Foglight Agent Manager before you can deploy agents
(excluding Java EE Technology Agents) that are installed on a monitored host.

Using Embedded Databases


Foglight offers the option to use MySQL (v5.0.72) as an embedded database. The
lifecycle of the embedded database matches that of the Foglight Management Server. If
the Management Server is stopped or started, the embedded database is automatically
stopped or started.
Switching to an external database may improve Foglight performance. See “Appendix:
Switching from an Embedded to an External Database” on page 61 for information
about how to migrate an embedded database used with the Foglight Management Server
to an external MySQL database.

Licensing
This section provides information about licensing for Foglight.

Important See the Administration and Configuration Guide for information about license
requirements, managing licenses, and the different categories of cartridges (based on
their license requirements).

Providing a License File During Installation


You can install a license file during installation if you perform a Custom Install. See
“Step 12: Add Foglight License File” on page 28 in Installing a New Version of the
Foglight Management Server.

Importing a License File After Installation


You can also import a license after installing Foglight. There are three ways of
providing a license file to the Management Server after installation.

Using the Manual Process


• Move an existing license file into the <foglight_home>/license folder.
Before Installing Foglight 11
Planning Your Installation

Using the Foglight Administration Module


• Upload a license file using the Foglight Administration Module. See the
Administration and Configuration Help for instructions.

Using the Command Line


1 Start the Foglight Management Server.
2 Ensure that JAVA_HOME is set.
3 If you have not already done so, extract the file fglcmd.zip in <foglight_home>/
tools.
4 Upload a license by navigating to <foglight_home>/tools and entering the
following command:
fglcmd -usr <username> -pwd <password> -cmd license:import -
f <license_file>
The command listed above assumes that you are using the default port 8080 and
localhost. If you are not running with these default values, use the following
options to indicate server and port:
-port <xx> -srv <server_name>
For example, if you want to connect to the Foglight Management Server using the
default HTTPS port, include the option -port 8443 with the fglcmd command.

Note See the Command-Line Reference Guide for information about running the fglcmd utility
and the options that can be used with fglcmd, including additional license-management
commands.

Installation Modes
The default mode for the installer is the graphical user interface mode. On UNIX
systems, in cases where a graphics display is not available, the Foglight installer can be
started in command-line mode by using the console mode or silent mode.

Console Mode
The console mode is available on UNIX only for Solaris (SPARC or x86-64) and Linux.
In console mode, the install instructions are in text format, but otherwise are the same as
the graphical user interface install. To execute the console mode type the following
command:
12 Foglight
Installation and Setup Guide

Solaris
Foglight-5_5_8-install_solaris-sparc.bin -i console
Foglight-5_5_8-install_solaris-x86_64.bin -i console

Linux
Foglight-5_5_8-install_linux-ia32.bin -i console
Foglight-5_5_8-install_linux-x86_64.bin -i console

Silent Mode
In silent mode, a properties file is used to feed in the installation parameters. The file
consists of a list of key-value pairs, which are described in the table below.
To run the installer in silent mode:

Solaris
Foglight-5_5_8-install_solaris-sparc.bin -i silent
Foglight-5_5_8-install_solaris-x86_64.bin -i silent

Linux
Foglight-5_5_8-install_linux-ia32.bin -i silent
Foglight-5_5_8-install_linux-x86_64.bin -i silent
To use a specific properties file in silent mode, append the following option:
-f <fms_silent_install>.properties
The installer loads the specified properties file. When the file name and installer prefix
are the same, the installer uses the properties automatically.
For example, the installer Foglight-5_5_8-install_linux-ia32.bin uses the properties file
Foglight-5_5_8-install_linux-ia32.properties automatically.

Note In certain configurations, the Foglight Management Server may use ports in addition to the
ones that you can set using the silent installer. See the Administration and Configuration
Guide for details.
Before Installing Foglight 13
Planning Your Installation

The following table lists the properties available for configuring a silent installation, and
their default values:

Property Description Default

FMS_ADMIN_PASSW Administrator password for Foglight. foglight


ORD

FMS_CLUSTER_MCA Cluster Multicast port. 45566


ST_PORT

FMS_DB Allows you to specify whether the embedded


database is embedded or external.
Must be set to external if
FMS_HA_MODE=1

FMS_DB_ADMIN_PA Allows you to specify the password None.


SSWORD for the database administrator user
account.
This setting is not required if
FMS_DB=embedded.

FMS_DB_ADMIN_US Allows you to specify the database foglight


ER administrator user account.
This setting is not required if
FMS_DB=embedded.

FMS_DB_HOST Allows you to specify the host name localhost


of the database machine.
This setting is not required if
FMS_DB=embedded.

FMS_DB_NAME Allows you to specify the name of the foglight


Foglight database.
This setting is not required if
FMS_DB=embedded.

FMS_DB_PORT User-defined port for the database. 13306


14 Foglight
Installation and Setup Guide

Property Description Default

FMS_DB_SETUPNOW 0 = Set up the database after 1


installation is complete.
1 = Set up the database as part of the
installation.

FMS_DB_TYPE Specifies the database type. mysql


This setting is not required if
FMS_DB=embedded.

FMS_DB_USER Database user name. foglight

FMS_DB_USER_PAS Database user password. foglight


SWORD

FMS_HA_JNDI_JNP Bootstrap JNP service in HA mode. 1100


_PORT

FMS_HA_JNDI_RMI Port of RMI naming service in HA 1101


_PORT mode.

FMS_HA_JNDI_UDP JNDI UDP group port in HA mode. 1102


GROUP_PORT

FMS_HA_JRMP_INV JRMP invoker port in HA mode. 4447


OKER_PORT

FMS_HA_MODE 0 = Run Foglight in standalone mode. 0


1 = Run Foglight in HA (High
Availability) mode.

FMS_HA_PARTITIO High Availability (HA) partition FMS_HA


N name.
Only required if FMS_HA_MODE=1.

FMS_HA_POOLED_I Pooled invoker port in HA mode. 4446


NVOKER

FMS_HTTP_PORT HTTP port. 8080


Before Installing Foglight 15
Planning Your Installation

Property Description Default

FMS_HTTPS_ONLY 0 = Do not run Foglight in secure 0


mode (HTTPS) only.
1 = Run Foglight in secure mode
(HTTPS) only.

FMS_HTTPS_PORT HTTPS port. 8443

FMS_JNDI_JNP_PO Bootstrap JNP service. 1099


RT

FMS_JNDI_RMI_PO Port of RMI naming service. 1098


RT

FMS_JRMP_INVOKE JRMP invoker port. 4444


R_PORT

FMS_LICENSE_AGR License agreement acknowledgment. yes


EEMENT

FMS_LICENSE_FIL Allows you to add a license file by None (the license


E specifying the path to the license. file you specify is
Note See the Administration and validated).
Configuration Guide for information
about license requirements,
managing licenses, and the
different categories of cartridges
(based on their license
requirements).

FMS_POOLED_INVO Pooled invoker port. 4445


KER_PORT

FMS_QP5APP_PORT The port for an embedded query 8448


engine.

FMS_RUN_NOW Starts the Foglight Management false


Server at the end of the installation.

FMS_UNIFIED_INV Unified invoker port. 4448


OKER_PORT
16 Foglight
Installation and Setup Guide

Property Description Default

FMS_UPGRADE Only required to update an existing 1


installation, in which case it must be
set to 1.

INSTALLER_UI The property is set to SILENT for SILENT


silent mode.
This is the default setting and is
mandatory.

USER_INSTALL_DI The Foglight installation directory. None.


R If you want to upgrade an existing
installation, specify the path to the
existing installation directory here
(and ensure that FMS_UPGRADE is set
to 1).

USER_SHORTCUTS Sets the shortcut location. None.


2
Installing Foglight

The Foglight 5.5.8 installer allows you either to install a new instance of the Foglight
Management Server or to upgrade an existing installation of a Foglight 5.x Management
Server. This guide provides the procedures for a new installation of version 5.5.8 of the
Management Server. For upgrade procedures, see the Upgrade Guide.

Note The Foglight Management Server should be installed on a dedicated machine.

Preparing to Install
The requirements for installing Foglight are:
• A machine to host the Foglight Management Server. The Management Server
should run on a dedicated machine because it must process and store large
volumes of data.
Note Ensure that a host name resolution and reverse lookup are confirmed prior to
installing the Foglight Management Server.

• Administrator or root access to all machines requiring a Foglight agent.


• An administrator password for Foglight. The user name foglight and the default
password for this account can initially be used to log in to the browser interface
and to use command-line interface options with root privileges. Quest Software
recommends that you change the default password for this account.
• A user account on the machine where you are installing Foglight.
18 Foglight
Installation and Setup Guide

• The IATEMPDIR environment variable is set to a location with sufficient space


for installer self-extraction to meet the requirements described in the document
available at:
http://kb.flexerasoftware.com/selfservice/microsites/
search.do?cmd=displayKC&docType=kc&externalId=Q000054
• If you are installing Foglight with the embedded MySQL database, the Foglight
installer and Foglight Management Server must be able to write to the directory
where the MySQL socket is installed. By default, the MySQL socket is installed
in the /tmp directory (which is world-writable on UNIX).
Note For UNIX installations, certain agents may need root privileges to collect the required
data.

• If you are installing Foglight with the embedded MySQL database on Linux or
Solaris operating systems, you must define the IPv4 entry for localhost in the /etc/
hosts file prior to installing Foglight. If you do not do so, the installer cannot start
the embedded database and the installation fails.
To prevent the installation from failing, add the following IPv4 entry for localhost
in the /etc/hosts file prior to installing Foglight:
127.0.0.1 localhost.localdomain localhost
• If you are installing Foglight on 64-bit Linux platforms, the 32-bit version of
libgcc*.rpm must be installed for the Foglight installer to run.

Installing a New Version of the Foglight Management


Server
Once all system requirements are in place, you are ready to install the Foglight
Management Server. The installer prompts you to input data, and provides you with
progress feedback during the installation process.
The Foglight installer offers two installation options:
• Standard — This option accepts all of the installer defaults, and installs an
embedded SQL database only. To use this option, follow the instructions in
“Installing the Foglight Management Server - Standard Install Option” on
page 19.
• Custom — This option allows you to modify the installer defaults, and to choose
an external database type. To use this option, follow the instructions in “Installing
the Foglight Management Server - Custom Install Option” on page 22.
Installing Foglight 19
Installing a New Version of the Foglight Management Server

The Foglight installation process consists of the same basic steps for all platforms. For
specific platform customizations, see “Installed Directories” on page 33.

Installing the Foglight Management Server - Standard Install


Option
Start the installation process by initiating the executable included on the Foglight install
media. Each installation screen includes a Previous button, allowing you to go back and
adjust the information you have specified.

Step 1: Introduction
The Introduction screen provides an overview of the mechanics of the installation
interface. Review the contents of this screen, then click Next.

Step 2: Transaction Product Agreement


1 Read the Transaction Product Agreement statement, and accept or decline the
terms of the agreement.
2 If you selected I accept the terms of the License Agreement, click Next.

Step 3: Select Installation


Accept the default Standard Install by clicking Next.
20 Foglight
Installation and Setup Guide

Step 4: Installing Foglight 5.5.8


Foglight installs files into the default directories.

Step 5: Foglight Server Startup


The Foglight Server Startup step provides you with the option of starting the Foglight
Management Server from the installer.
Installing Foglight 21
Installing a New Version of the Foglight Management Server

1 To start the Management Server at this point (the default setting), click Next.
If you do not want the installer to start the Management Server, clear the Run
Now check box, and then click Next.
2 If you selected Run Now, the installer starts Foglight and the Foglight Server
Startup page launches in a Web browser (if a Web browser is available). See
“Foglight Server Startup Page” on page 30 for more information.
In either case, the Install Complete screen appears.

Step 6: Install Complete


Click Done to complete the installation process.
Proceed to “Next Steps” on page 31.
22 Foglight
Installation and Setup Guide

Installing the Foglight Management Server - Custom Install


Option
Start the installation process by initiating the executable included on the Foglight
installation media. Each installation screen includes a Previous button, allowing you to
go back and adjust the information you have specified.

Step 1: Introduction
The Introduction screen provides an overview of the mechanics of the installation
interface. Review the contents of the screen, then click Next.

Step 2: Transaction Product Agreement


1 Read the Transaction Product Agreement statement, and accept or decline the
terms of the agreement.
2 If you selected I accept the terms of the License Agreement, click Next.

Step 3: Select Installation


Click the Custom Install option, then click Next.
Installing Foglight 23
Installing a New Version of the Foglight Management Server

Step 4: Choose Installation Folder


1 Choose the location where you want to install Foglight. You can accept the
default location .../Quest_Software/Foglight or click the Browse button to
navigate to another location.

2 Click Next.

Step 5: Choose Link Location


1 Choose the location where you want to create links (shortcuts).
24 Foglight
Installation and Setup Guide

2 Click Next.

Step 6: Pre-Installation Summary


Review the installation information. If you are satisfied with the parameters of your
installation, click Install.
To make changes to the installation parameters, click Previous.

Note The installation type (New Install) is displayed on this screen. If you want to upgrade an
existing installation of the Foglight Management Server to version 5.5.8, click Previous until
you return to the Choose Install Folder screen. See the Upgrade Guide for detailed upgrade
instructions.

Step 7: Installing Foglight 5.5.8


Foglight installs files into the specified directory.

Step 8: Foglight Administrator Password


1 In the Foglight Administrator Password field, accept the default password
(foglight) or type an alternate one.
Installing Foglight 25
Installing a New Version of the Foglight Management Server

2 In the Retype Administrator Password field, accept the default (foglight) or, if
you have provided an alternate password in step 1, retype the password for
verification.
To run Foglight in secure mode (HTTPS) only, select the Secure Server (HTTPS
Only) check box.

3 Click Next.

Step 9: Foglight Mode


1 Accept the default server mode (Standalone).
Note A server running in HA mode can only use an external database.
26 Foglight
Installation and Setup Guide

2 Click Next.

Step 10: Foglight Database Configuration


This step lets you configure the Foglight database. After you click Next, the installer
creates the user (foglight is the default user ID) in the database and sets the appropriate
permissions.
1 In the Foglight Database Account User ID field, accept the default user ID
(foglight) or type an alternate one. This is the name for the Foglight user that you
are creating. The Foglight Management Server uses this account to store data in
the database.
2 In the Foglight Database Account Password field, accept the default password
(foglight) or type an alternate one.
3 In the Foglight Database Account Retype Password field, accept the default
(foglight) or, if you have provided an alternate password in step 2, retype the
password for verification.
4 From the Foglight Database list, select Embedded. See Embedded Database for
instructions.
Note The Foglight Database list is disabled if you selected HA as the server startup
mode in Step 9: Foglight Mode.
Installing Foglight 27
Installing a New Version of the Foglight Management Server

Embedded Database
1 Accept the default port (13306) or type an alternate in the Database Port field.
2 In the DB Administrator Password field, accept the default password provided
(foglight) or type an alternate one.
3 In the Retype DB Administrator Password field, accept the default (foglight)
or, if you have provided an alternate password, re-type the password for
verification.
4 Click Next. A progress box appears as the embedded database is installed.

Step 11: Foglight Ports Configuration


1 Configure the server ports. The Foglight Ports Configuration screen displays
default ports that you can assign.
Note In certain configurations, the Foglight Management Server may use ports in addition
to the ones that you can set on this screen. See the Administration and
Configuration Help for details.

2 If you want to revert to the default values, click Defaults.


28 Foglight
Installation and Setup Guide

3 Click Next.
Note If there are any port assignment conflicts, an error message dialog box appears. You
can either click Review Ports, if you want to return to the Foglight Ports
Configuration screen to configure the conflicting port(s), or click Ignore and
Continue to continue with the installation without resolving the port conflicts. Select
one of these options to continue.

Step 12: Add Foglight License File


1 Specify the path to the Foglight license file in the License File field, or browse to
a license file by clicking the Browse button.
Important See the Administration and Configuration Guide for information about license
requirements, managing licenses, and the different categories of cartridges (based on
their license requirements).
Installing Foglight 29
Installing a New Version of the Foglight Management Server

2 Click Next.
Alternatively, you can provide a license file to the Foglight Management Server
after the installation is complete. To do so, leave the License File field blank and
click Next.

Step 13: Foglight Server Startup


The Foglight Server Startup step provides you with the option of starting the Foglight
Management Server from the installer.
30 Foglight
Installation and Setup Guide

1 To start the Management Server at this point (the default setting), click Next.
If you do not want the installer to start the Management Server, clear the Run
Now check box, then click Next.
2 If you selected Run Now, the installer starts Foglight and the Foglight Server
Startup page launches in a Web browser (if a Web browser is available). If a Web
browser is not available, the Foglight Server Startup page does not launch.
See “Foglight Server Startup Page” on page 30 for more information.
In either case, the Install Complete screen appears.

Step 14: Install Complete


Click Done to complete the installation process.

Foglight Server Startup Page


If you selected the Run Now check box in the Foglight Server Startup step in the
installer, the installer starts Foglight and launches the Foglight Server Startup page in a
Web browser.
Installing Foglight 31
Installing a New Version of the Foglight Management Server

Figure 1
This page provides information about the status of Foglight as it starts up, such as:
• The number of services that have started and cartridges that are enabled.
• The latest status of the Foglight Management Server as it starts.
• A list of the Foglight services that are starting. As shown in the image above,
services listed in grey have not yet started, services listed next to a blue circle are
starting, and services listed next to a green square with a check mark have started.
• A link to the Foglight login page (once the Management Server startup is
complete).
The information on the page is updated as Foglight starts. The page also includes a link
that allows you to refresh the page.

Next Steps
If you performed a Standard Install, follow the instructions in “Importing a License File
After Installation” on page 10 to provide a license file to the Foglight Management
Server after installation.
If you performed a Custom Install and you did not install a license in Step 12: Add
Foglight License File, follow the instructions in “Importing a License File After
32 Foglight
Installation and Setup Guide

Installation” on page 10 to provide a license file to the Foglight Management Server


after installation.

Important See the Administration and Configuration Guide for information about license
requirements, managing licenses, and the different categories of cartridges (based on
their license requirements).

If you did not select the Run Now option in the Foglight Server Startup step of the
installer, start the Foglight Management Server by following the instructions in
“Starting and Stopping the Foglight Management Server” on page 50.
To log in to Foglight, see “Logging in to Foglight” on page 51.
To import and initialize your database, see the procedures in “Migrating Data from an
Existing Database” on page 52.
To set up an encrypted database connection, see “Setting Up an Encrypted Database
Connection with SSL” on page 35.

Embedded Foglight Agent Manager


An instance of the Foglight Agent Manager is automatically installed with new
installations of the Management Server. This embedded Foglight Agent Manager
instance runs on the Management Server machine. You can deploy agents to the
embedded Foglight Agent Manager if you want to monitor the machine on which the
Management Server runs.
In certain environments, Foglight starts and stops the embedded Foglight Agent
Manager along with the Management Server by default. For more information about
running the embedded Foglight Agent Manager, see the Foglight Agent Manager
Installation Guide.
You can configure whether or not you want the embedded Foglight Agent Manager to
run in tandem with the Management Server. See the Foglight Agent Manager
Installation Guide for more information.
Installing Foglight 33
Installed Directories

Note Although the Foglight Agent Manager Adapter cartridge is installed by default with the
embedded Foglight Agent Manager, you must still install a Foglight Agent Manager
cartridge that contains installers for your supported platforms in order to deploy the Foglight
Agent Manager to remote hosts.
See “Installing and Running the Foglight Agent Manager” in the Foglight Agent Manager
Installation Guide for information about selecting a Foglight Agent Manager cartridge,
downloading installers, and installing, configuring, and running the Foglight Agent Manager.

Installed Directories
The following table describes the directories that are created under your target
installation folder. They may vary, depending on the product features that you select and
the components installed for your platform.

Directory Contents

bin Foglight executables for running the server and utilities.

cartridge Installed cartridge files in their original form.

client Files used by client programs (such as the command-line


client) for remote access to Foglight.

config Configuration files and subdirectories.


The files in the config directory contain settings that are
most likely to require editing. Files at the next level are less
likely to need changing. Files at the lowest level contain
settings that are unlikely to need changing except in special
circumstances.

docs HTML and PDF versions of the product documentation.

dtd Descriptors for configuration files that can be imported into


Foglight (for example, by installing a cartridge).

extension Directory for extension cartridges (optional cartridges that


are not installed by default).

fglam Directories for the embedded Foglight Agent Manager.


34 Foglight
Installation and Setup Guide

Directory Contents

jre Version of the JRE (1.6.0_18) used by Foglight.

lib The Foglight JAR files.

license The Foglight license file you install.


Note See the Administration and Configuration Guide for
information about license requirements, managing licenses,
and the different categories of cartridges (based on their
license requirements).

logs Default location of the log files generated by Foglight when


it runs.
Generated at runtime.

mysql The current embedded database version is 5.0.72.


If the embedded database is selected during installation, then
the database is created, populated, and used for Foglight
runtime.
To start the embedded database separately, without running
Foglight, use these parameters:
[run|shutdown]Db.sh in <install-dir>/bin
Note This directory is always installed, even if you select an
external database when installing Foglight.

scripts SQL scripts and examples of the two types of Script Agents.
scripts/agent contains sample Type 1 and Type 2 Script
Agent files. See the Administration and Configuration Guide
for more information about Script Agents.
scripts/sql contains SQL scripts to drop/create schema, or
create/populate the database. The scripts included in this
directory are specific to the type of database that you
selected when installing Foglight.

server JAR files and data files used by a particular Foglight server
variant (such as default).

state Where the running state of Foglight is kept.

support Where support bundled archive information is stored.


Installing Foglight 35
Foglight Settings

Directory Contents

tmp/cartridge.deploy A working directory for deploying cartridges.

tools Various Foglight utilities.

UninstallerData Files used by the Foglight uninstaller.

Foglight Settings
Foglight can be run with its default settings. However, you can edit these settings if you
need to change runtime parameters such as settings for running the Foglight
Management Server in High Availability (HA) mode or ports used by the Management
Server. Many Foglight settings can be changed by editing the file <foglight_home>/
config/foglight.config, which contains central settings.

Note In certain configurations, the Foglight Management Server may use ports in addition to the
ones that you can set using foglight.config. See the Administration and Configuration Guide
for details.

Editing the foglight.config File


The foglight.config file contains parameters for port settings, virtual memory, command
line options, and server federation. You can edit the file using a text editor. Values
within quotation marks can be edited.

Setting Up an Encrypted Database Connection with SSL


The following procedure outlines how to set up a secure embedded MySQL database
connection and verify that the MySQL Server supports SSL encryption.

Note This procedure must be performed after installation but before you have started the Foglight
Management Server.
36 Foglight
Installation and Setup Guide

To set up an encrypted embedded MySQL database connection with SSL:


1 Import a CA certificate into the Foglight Management Server keystore (cacerts)
as outlined in “Importing a Network Security Certificate” on page 44.
2 Update the MySQL configuration file (my.ini) with the new security certificate
and key information by adding the following properties:
• ssl-ca=<cacert.pem>
• ssl-cert=<server-cert.pem>
• ssl-key=<server-key.pem>
3 Uncomment and set the foglight.database.secureconn attribute in the
foglight.config file to true, as shown below.
foglight.database.secureconn = "true";
Caution Do not enable this option until the database server’s CA certificate is properly
imported into <foglight_home>/jre/lib/security/cacerts.

4 Start the Foglight Management Server.


To verify whether the MySQL Server (mysqld) supports SSL connections:
1 Ensure that the MySQL Server (mysqld program) for your Foglight database is
running.
2 Login to mysql:
mysql --host <hostname> –port=<mysql_db_port_number> –
user=<mysql_user> --password=<mysql_user_passwword>
3 At the mysql prompt, run the following query:
show variables like 'have_ssl'
4 The output shows the variable have_ssl with a value of either YES or
DISABLED.
If the value is YES, the MySQL Server supports SSL connections. If the value is
DISABLED, the MySQL Server supports SSL connections but was not started with
the appropriate SSL command options (-ssl-<option_name>=<value>). See
the MySQL documentation for more information about these options.

Setting Up an Encrypted LDAP Connection with SSL


Use the following instructions if you need to encrypt communication between the
Foglight Management Server and the LDAP server.
Installing Foglight 37
Foglight Settings

To encrypt communication between Foglight Management Server and LDAP:


1 Acquire the LDAP server certificate in .pem format from the administrator.
2 Import the certificate into the Foglight Management Server keystore, <foglight_
home>/jre/lib/security/cacerts (default password: changeit), with the following
command:
<foglight_home>/jre/bin/keytool -import -file <path_to_cert_
file> -alias ldapsvrcert -keystore <path_to_cacerts>
-storepass <store_pwd>
Note If you do not specify the password using the -storepass option, keytool
prompts you to supply it.

3 On the navigation panel, under Dashboards, click Administration > Users &
Security > Directory Services Settings.
4 Under LDAP Locations, click Edit.
5 Specify the LDAP server URL in the following format:
ldaps://ldap_server_host_name:636

Note The port number for LDAP over SSL is usually 636. Confirm the exact port number with
your LDAP server administrator.

Using Encryption When Sending Email from Foglight


You can use encryption when sending email from Foglight. To do so, you must enable
Foglight to use the SSL protocol and configure the mail server used by Foglight to use
an SSL certificate that is not self-signed.
You can configure Foglight to use the SSL protocol either on the Email Configuration
Dashboard or by editing the related mail.use.ssl registry variable. See the
Administration and Configuration Help for more information.
See the documentation for your mail server for information about configuring it to use
an SSL certificate.

Setting Parameters for an Embedded Database


The file <foglight_home>/config/foglight.config contains a number of settings related
to the embedded database. In most cases, you do not need to make any changes to them.
38 Foglight
Installation and Setup Guide

If you need to edit these parameters, you must restart the Foglight Management Server
after doing so.

Specifying Whether an Embedded Database is Used


When you run Foglight with an embedded database, the parameter
foglight.database.embedded is set to true. If you are switching from an
embedded to an external database, you must set this parameter to false. See
“Appendix: Switching from an Embedded to an External Database” on page 61 for
more information.
If you have been running Foglight with an external database, then set
foglight.database.embedded to true and restart the Management Server,
Foglight starts with the embedded database. The data displayed in Foglight after you
perform these steps depends on whether you had previously run Foglight with the
embedded database:
• If you have previously run Foglight with the embedded database: The
Management Server reflects the state of the previously run embedded database.
• If you did not previously run Foglight with the embedded database: The state
of the Management Server is like new, since no data exists in the database.

Configuring the Database Start Up and Shut Down Grace Periods


There are also optional settings for configuring the start up and shut down grace periods
for the embedded database: foglight.database.embedded.startup.grace and
foglight.database.embedded.shutdown.grace.
Foglight starts and stops the embedded database. These settings control the length of
time that Foglight waits before considering an attempt to start or stop the database to
have failed.
The values for these optional settings are specified in seconds, as in the default values
shown below.
foglight.database.embedded.startup.grace = "300";
foglight.database.embedded.shutdown.grace = "300";
Installing Foglight 39
Foglight Settings

Understanding the Password and Socket Settings


The file foglight.config also contains parameters that set the password and socket used
by the embedded database.

Embedded Database Password Parameter


The password specified by the foglight.database.embedded.password
parameter is the root password used for the embedded database. The default value is
nitrogen.
If you previously selected the embedded database option while installing Foglight and
now want to switch back to using an embedded database, then you do not need to
change the root password.
If you did not previously select the embedded database option during installation, you
need to specify the correct mysql root password as the value of
foglight.database.embedded.password. This password can be specified in
either an encrypted or plain-text format. If required, you can encrypt the password using
the <foglight_home>/bin/keyman.sh tool.
During installation, the Foglight installer overwrites the default value of
foglight.database.embedded.password when you select the embedded
database.

Embedded Database Socket Parameter


The foglight.database.embedded.socket parameter specifies a UNIX domain
socket. This parameter is used on Linux and Solaris platforms only. The installer
generates a unique socket name for each installation.

Caution Do not change this setting.

Configuring Ports
You can set a number of different ports using the file <foglight_home>/config/
foglight.config, including mandatory ports required for Foglight to run.
40 Foglight
Installation and Setup Guide

For a list of these ports, their default values, and the configuration parameters you can
use to set them in foglight.config, see the Administration and Configuration Guide.

Note In certain configurations, the Foglight Management Server may use ports in addition to the
ones that you can set using foglight.config. See the Administration and Configuration Guide
for details.

Setting Up Foglight 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 you to use one Foglight Management Server to operate, while using
other Foglight Management Servers as the data source. For detailed information about
Foglight federation and how to create a federated environment, see the Federation Field
Guide.

Important Federation is an advanced feature, which requires a dedicated Foglight Management


Server separate from the Foglight Management Servers that are acting as data
collectors. Contact Quest Professional Services to design and implement a federation
strategy.

Setting the SQL Parser Properties


The following default system properties appear in the foglight.config file. The port
setting can be changed during the install process, or by editing the foglight.config file.

# qp5app port and info


foglight.qp5app.max.connections = "10";
foglight.qp5app.port = "8448";

Setting Memory Parameters for the Server


If you are running the Foglight Management Server by running bin/fms, you can
configure the Java Virtual Machine’s (JVM’s) minimum and maximum memory
parameters for the server in the <foglight_home>/config/foglight.config file.
Installing Foglight 41
Foglight Settings

If you are starting Foglight using the run.[bat|sh] command, the JVM heap
memory parameters set in the <foglight_home>/config/foglight.config file do not take
effect. Use -X options to pass the memory parameters straight to the VM.
If your installation supports a large number (100s) of agents, Quest suggests you set the
Java heap memory minimum (-Xms) and maximum (-Xmx) options to the same size.
For example, assigning 1GB of memory can be set in the foglight.config file as follows:
foglight.vm.option0 = “-Xms1024M”;
foglight.vm.option1 = “-Xmx1024M”;
Ensure that you uncomment these lines in the file.
You can set up to 100 VM options in total.

Note The -Xms and -Xmx options are different for 32-bit and 64-bit JVMs and available physical
memory.
The values of the -Xms and -Xmx options do not necessarily have to be the same size.
However, the value of the -Xmx option should not exceed certain limits as determined by
the System Administrator.

Process Heap Use


When a thread is created and run, a run-time stack is dynamically allocated from the
native process heap (not the Java heap). This native heap requires a large contiguous
memory block. If the system you are running does not have enough RAM, or if the
operating system cannot find a large enough contiguous memory block, new native
threads cannot be created and a java.lang.OutOfMemoryError occurs.
If the VM generates errors relating to a failure to allocate native resources, or relating to
exhaustion of process address space, you must increase the native process heap size.
Errors appear as a Java VM internal error message or a detail message associated with
an out-of-memory error. Messages with the relevant errors indicate that the problem is
process heap exhaustion.
You cannot directly set the size of the process heap. The process heap uses memory
within the 32-bit address space not used by the garbage-collected heap. To increase the
size of the process heap, decrease the maximum Java heap size using the -Xmx option in
the foglight.config file.

Default Stack Size


The default stack size can be adjusted with the -Xss option.
42 Foglight
Installation and Setup Guide

Adding Command-Line Options


The foglight.config file allows you to add up to ten command-line options for the fms
command.
Each command-line argument corresponds to a space-delimited argument passed to the
Foglight process.
For example, the following lines in the foglight.config file:
foglight.cmdline.option0 = "-n";
foglight.cmdline.option1 = "process_name";
correspond to this direct argument on the command line:
fms -n process_name
Certain arguments can be specified in a single line that uses the long name for an option.
For example:
foglight.cmdline.option0 = "--host=hostname";
which corresponds to the following command-line argument:
fms --host=hostname

Binding the Foglight Management Server to an IP Address


To cause the Foglight Management Server to bind to a specific IP address, you can
modify foglight.config by adding a command line option. For example:
foglight.cmdline.option0 = "-Djboss.bind.address=127.0.0.1";
or
foglight.cmdline.option0 = “-Dbind.address”;
foglight.cmdline.option1 = “127.0.0.1”;
where 127.0.0.1 is the desired IP address
or
foglight.cmdline.option0 =
"-Djboss.bind.address=host1.example.com";
foglight.cmdline.option1 = "-Dbind.address=host1.example.com";
where host1.example.com is the desired host name
or
Installing Foglight 43
Foglight Settings

foglight.cmdline.option0 = "--host=127.0.0.1"
Binding Foglight to a specific IP address is useful in situations where, for example, the
machine hosting the Management Server has multiple IP addresses associated with it
and each IP address delineates a virtual boundary between services. In such situations,
you might need to cause the Management Server to listen for incoming TCP traffic only
on a specific IP address.

Configuring Foglight to Use Stronger Encryption


Foglight Management Server includes a standard JRE with default encryption. In some
cases, such as Credential Management, this encryption level may be insufficient. If
256-bit (or higher) AES keys are necessary, use the following procedure to configure
the Management Server to use stronger encryption.
To configure Foglight to use stronger encryption:
1 Download the Java Cryptography Extension (JCE) Unlimited Strength
Jurisdiction Policy Files 6 from:
http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-
138363.html
2 Copy the .jar file into the following directory: <foglight_home>/jre/lib/
3 Stop the Foglight Management Server.
4 Open the file <foglight_home>/config/foglight.config on the Management Server
machine.
5 Set the parameter foglight.vm.option0 to 256 (or higher):
foglight.vm.option0 =
"-Dfoglight.credentials.enc.key.size=256";
6 Save the foglight.config file.
7 Restart the Management Server.

Configuring Foglight to Use the HTTPS Port


If you do not choose to install Foglight in Secure Server mode, you can edit
foglight.config after installation and manually configure Foglight to restrict the
Management Server to use the HTTPS port when accessing the browser interface.
You must have a signed, valid certificate to use this HTTPS configuration. Quest
recommends that you obtain a valid certificate from a third party as outlined in
Importing a Network Security Certificate.
44 Foglight
Installation and Setup Guide

To configure the Management Server to use the HTTPS port:


1 Stop the Foglight Management Server.
2 Open the file <foglight_home>/config/foglight.config on the Management Server
machine.
3 Set the parameter foglight.console.httpsonly to true:
foglight.console.httpsonly = "true";
4 Save the foglight.config file.
5 Import the signed certificate into the Foglight keystore. See Importing a Network
Security Certificate for instructions.
6 Restart the Management Server.
7 Launch the Foglight browser interface using the appropriate HTTPS URL
(https://<hostname>:<https_port>) to ensure that the Foglight Management
Server can be accessed by means of HTTPS.

Note The Foglight 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 Foglight
Management Server through the HTTP port while external requests use HTTPS.
You need to configure your firewall or network security applications to allow both ports to
remain open.

Importing a Network Security Certificate


In order to set up the Foglight Management Server to use HTTPS, you must generate a
key pair (security certificate) into the Foglight keystore. This allows the server to
communicate through the HTTPS protocol. You need to delete the existing certificate
shipped with Foglight before generating a new key pair. Use the keytool utility shipped
with Foglight to create, import, and export certificates. This utility can be found at:
<foglight_home>/jre/bin/keytool
There are two keystores used by Foglight:
• The built-in Tomcat keystore located at:
<foglight_home>/server/default/conf/tomcat.keystore (default password:
nitrogen)
Installing Foglight 45
Uninstalling Foglight

• The Foglight Management Server keystore located at:


<foglight_home>/jre/lib/security/cacerts (default password: changeit)
To import a certificate:
1 Delete the existing tomcat key from the tomcat.keystore directory using the
following command:
<foglight_home>/jre/bin/keytool -keystore <foglight_home>/
server/default/conf/tomcat.keystore -storepass nitrogen -
delete -alias tomcat
2 Create a new key under the tomcat alias using the following command:
<foglight_home>/jre/bin/keytool -keystore <foglight_home>/
server/default/conf/tomcat.keystore -storepass nitrogen -
genkey -alias tomcat
3 Generate a Certificate Signing Request (CSR) using the following command:
<foglight_home>/jre/bin/keytool -keystore <foglight_home>/
server/default/conf/tomcat.keystore -storepass nitrogen -
certreq -alias tomcat -file <your_request_file.csr>
This file must be signed by Certification Authority (CA).
4 Once you have the certificate signed, import it back to the tomcat.keystore using
the following command:
<foglight_home>/jre/bin/keytool -keystore <foglight_home>/
server/default/conf/tomcat.keystore -storepass nitrogen -
import -trustcacerts -alias tomcat -file <your_converted_
cerificate>
You are prompted to specify the keystore password.
5 Type nitrogen.

Uninstalling Foglight
You can uninstall Foglight using the uninstaller utility for your platform. The uninstaller
can be found in <foglight_home>/UninstallerData.
The default mode for the uninstaller is the graphical user interface (GUI) mode. In cases
where a graphics display is not available on UNIX systems, the Foglight uninstaller can
be run from the command line by using console mode or silent mode. Console mode is
available only for Linux and Solaris.
46 Foglight
Installation and Setup Guide

To uninstall Foglight:
1 Stop the Foglight Management Server. See “Stopping the Foglight Management
Server” on page 51 for instructions.
2 Navigate to the UninstallerData directory of your Foglight installation and run
the Uninstall_Foglight shell script.
• To launch the uninstaller in GUI mode, simply run the Uninstall_Foglight
shell script.
• Linux and Solaris only: To launch the uninstaller in console mode, run the
UninstallFoglight shell script using the following command:
./Uninstall_Foglight -i console
• To launch the uninstaller in silent mode, run the Uninstall_Foglight shell
script using the following command:
./Uninstall_Foglight -i silent -f
installvariables.properties
3 After uninstallation, you can safely delete the <foglight_home> directory. It is
recommended that you do so, since certain directories within it are not removed
by the uninstaller.

Upgrading the Foglight Management Server


See the Upgrade Guide for detailed upgrade instructions.

Installing Foglight FAQ


Foglight generated the following error during installation: “Embedded DB Error: Failed to
startup embedded database”. Why does this error appear?
If you are installing Foglight with the embedded MySQL database on Linux or Solaris
operating systems, the installer cannot start the embedded database and the installation
fails if you do not define the IPv4 entry for localhost in the /etc/hosts file prior to
installing Foglight.
To prevent the installation from failing, add the following IPv4 entry for localhost to /
etc/hosts prior to installing Foglight:

127.0.0.1 localhost.localdomain localhost


Installing Foglight 47
Installing Foglight FAQ
48 Foglight
Installation and Setup Guide
3
Running the Foglight Management
Server

The instructions in this chapter assume that you have already installed Foglight. If you
have not, see “Installing Foglight” on page 17 for installation instructions.

Note On 64-bit Linux platforms, the 32-bit version of libgcc*.rpm must be installed for Foglight to
run.

Initializing the Database


If you are using the embedded database, the database initialization is performed when
you start Foglight.

Caution Do not make the MySQL database file my.cnf world-writable, for example by issuing the
command chmod a+w <foglight_home>/mysql/my.cnf. Foglight and the
database cannot start if there is world access to the configuration file my.cnf.
50 Foglight
Installation and Setup Guide

Starting and Stopping the Foglight Management Server


The following sections describe how to start and stop the Foglight Management Server.

Starting the Foglight Management Server


The following sections describe how to start the Foglight Management Server from the
command line and lists additional commands for use when starting or running the
Management Server.
To start the Management Server from the command line:
• Navigate to the directory <foglight_home>/bin and execute the following
command:
fms
When the Management Server starts successfully, the following message appears in the
command window:
Foglight Management Server startup completed.
Running the Foglight Management Server 51
Logging in to Foglight

Additional Commands:

Command Represents Description

-s start Starts the Foglight Management Server (this is


assumed if no command is specified).

-n name Provides a unique name for this instance of the


Foglight Management Server.

-j jvm-argument Sets an option to be passed directly to the Java


VM.
Can be used to set more than one VM option.

-v version Displays the version number for this program and


exits.

-h help Shows this information, and additional options,


then exits.

Stopping the Foglight Management Server


The following section describes how to stop the Foglight Management Server.
To stop the Foglight Management Server:
Do one of the following:
• Type Ctrl-C on the command window in which the Management Server started.
• Navigate to the directory <foglight_home>/bin and execute the following
command:
fms -q

When the server has stopped successfully, the Start Foglight command window closes.

Logging in to Foglight
Note The Management Server must be running before you can log in to Foglight.
52 Foglight
Installation and Setup Guide

To log in to Foglight using a Web browser:


1 Open a Web browser and type the following:
http://<hostname>:<port>
Where <hostname> is the name of the machine where the Foglight Management
Server is installed and <port> is the http port specified during installation (the
default is 8080).
2 Enter a valid user name and password and click Login.

Next Steps
To install cartridges, see “Installing and Upgrading Cartridges” on page 55.

Migrating Data from an Existing Database


The contents of the MySQL database can be copied to another MySQL instance via an
export/import cycle.
The following procedure performs a full export of the database and can be run against a
database currently in use by a server.
To export and import a MySQL database:
1 Run the following command from the MySQL command shell:
mysqldump -u <username> -p <password> -h <hostname> -P <port>
--databases <database name> --single-transaction >
backup.sql
The -h parameter can be omitted if the database is on the same host.
2 Import the database using the following syntax:
mysql -u <username> -p <password> -P <port> < backup.sql
The import process recreates the tables in the database. Therefore, any data that
was in the destination environment prior to the import is lost.

Caution The Foglight servers must be stopped during the import process.

When moving a database between environments, care should be taken to ensure that the
Foglight schema version is lower or equal to the Foglight Management Server version
Running the Foglight Management Server 53
Running the Foglight Management Server FAQ

in the destination environment as an upgrade to a new schema is possible (start the


Management Server with the option -Dfoglight.database.upgrade=true or run
foglight_db_upgrade.sh).

Running the Foglight Management Server FAQ


Why do I see an extra process named Quest Process Runner when I run Foglight?
On Unix, Foglight uses the Quest Common Process Runner to run processes such as the
embedded MySQL database, the embedded Foglight Agent Manager, and command
actions.
Why does the error message “cannot restore segment prot after reloc: Permission denied”
appear when I start the Foglight Management Server?
Newer Linux distributions have enabled new kernel security extensions from the
SELinux project at the NSA (National Security Agency). SELinux is an NSA project to
improve the security of Linux through Mandatory Access Control (MAC). These
extensions allow finer-grained control over system security. However, SELinux also
changes some default system behaviors, such as shared library loading, which can be
problematic to third-party programs.
If you see the error message “cannot restore segment prot after reloc: Permission
denied” when you start the Foglight Management Server, your SELinux configuration is
preventing IDL (the Interface Definition Language) from launching.
To rectify this issue, you can perform one of the following workarounds:
• Change the default security context for the Foglight Management Server by
issuing the command:
chcon -t texrel_shlib_t <foglight_home>/jre/lib/i386/*.so
chcon -t texrel_shlib_t <foglight_home>/jre/lib/i386/server/
*.so
• Disable SELinux altogether by setting it to disabled in your /etc/sysconfig/
selinux file:
SELINUX=disabled
For more information about SELinux, consult your Linux distribution vendor.
54 Foglight
Installation and Setup Guide

I am running Foglight with a MySQL database. When I try to start Foglight, it fails to start
and an SQL exception appears in the logs. Why does this happen?
If you encounter this problem, the cause might be that the MySQL database file my.cnf
has been made world-writable.
Do not make the MySQL database file my.cnf world-writable, for example by issuing
the command chmod a+w <foglight_home>/mysql/my.cnf. Foglight and the
database cannot start if there is world access to the configuration file my.cnf.
When I try to start the Foglight Management Server using Remote Desktop, an error
appears. How can I resolve this error?
There are two options to resolve this problem.
• Use VMWARE Console to start the server.
• Change the JVM options by reducing the memory requirements of the Foglight
Management Server so you can start it using Remote Desktop. To do so, use one
of the following methods:
• Navigate to the directory <foglight_home>/bin and execute the following
command:
fms -j -XX:MaxPermSize=96m
• Edit the foglight.config file found in <foglight_home>/config and modify the
following parameter:
foglight.vm.option0 = "-XX:MaxPermSize=96m";
After you have used one of these methods, restart the server.
If I stop the Foglight Management Server by closing the Command Prompt window, an
error appears when I start up the server again. How do I restart the server?
It is recommended that you do not use this method to stop the Foglight Management
Server. However, if you do use this method, follow the workaround listed below.
1 If you are running the embedded MySQL database, stop the database manually
before restarting the Foglight Management Server.
2 Remove the stale .pid file that is located in the state directory. The logs or the
console output inform you which .pid file to remove when you restart the server.
4
Installing and Upgrading
Cartridges

Using the Foglight Administration Module, you can install cartridges on the machine
hosting the Foglight Management Server, enable and manage cartridges, and download
agent installers.

Accessing the Cartridge Inventory Dashboard


The Cartridge Inventory dashboard in the Foglight Administration Module contains
controls for installing, enabling, disabling, and uninstalling cartridges, as well as for
viewing information about the installed cartridges.
To access the Cartridge Inventory dashboard:
• On the navigation panel, under Dashboards, click Administration > Cartridges
> Cartridge Inventory.
The Cartridge Inventory dashboard appears.

Installing Cartridges
Installation is the first step in adding a cartridge to the Foglight Management Server. A
cartridge file has the extension .car. Installing the .car file causes the Management
Server to be aware of all cartridges in the .car file.

Note You can install a .car file that is in a local directory on the machine hosting the Management
Server or upload a .car file from your local machine to the Management Server through the
Administration Module.
56 Foglight
Installation and Setup Guide

A cartridge must also be enabled before it is added to the Foglight Management Server.
You can cause a cartridge to be enabled upon installation, or you can enable it after
installation. See the Administration and Configuration Help for instructions on enabling
and disabling cartridges after installation.
To install a cartridge:
1 Navigate to the Cartridge Inventory dashboard.
2 In the Install Cartridge area, type the path to the .car file for the cartridge you
want to install.
• Type the path in the File on Local Machine box if you want to upload a .car
file from your local machine to the Management Server.
• Type the path in the File on Server box if you want to install a .car file that is
in a local directory on the machine hosting the Management Server.
Alternatively, you can click Browse to navigate to a .car file on your local
machine using a file chooser. Click OK in the file chooser when you have
selected the .car file you want to install.
3 The check box Enable on install is selected by default.
• If you would like the cartridge to be enabled when it is installed, leave this
check box selected.
• If you would like to enable the cartridge after installation, clear this check box.
4 Click Install Cartridge.
If the installation is successful, the message “Cartridge has been installed successfully”
appears in the Install Cartridge area and the cartridge is listed in the Cartridge Inventory.
If Enable on install was not selected (see step 3), a caution symbol ( ) appears in the
row for that cartridge in the table in the Cartridge Inventory.
For more information about cartridge installation and configuration see the
Administration and Configuration Guide.

Note Warning messages similar to the following appear in the Foglight Management Server log
when you install a cartridge:
WARN - Module system:<name> was converted to the newest
version during loading
These warnings are expected and do not affect functionality.
Installing and Upgrading Cartridges 57
Upgrading Cartridges

Upgrading Cartridges
For complete cartridge upgrade instructions, see the Upgrade Guide.

Next Steps
To install the Foglight Agent Manager, see the Foglight Agent Manager Installation
Guide.
58 Foglight
Installation and Setup Guide
5
Installing Agents

A cartridge may include one or more executable Foglight agent installers. The agent
installers included in a cartridge are listed on the Components for Download dashboard
in the Foglight Administration Module (select Administration > Cartridges >
Components for Download from the navigation panel on the left side of the Foglight
interface). Agents must be installed on all of the machines you want to monitor. For
agents that are installed on the monitored host, with the exception of the Java EE
Technology Agent, you need to install and configure the Foglight Agent Manager.

Note Foglight 4-converted agents create two processes for themselves when activated by the
Foglight Agent Manager.

Agent Installers
Agents that depend on the Foglight Agent Manager are installed using the remote
installation procedure. See “Remote Agent Installation” on page 60 and the
Administration and Configuration Guide.
Some cartridges (for example, the Foglight Cartridge for Java EE Technology) include
one or more executable agent installers. The agent installers that are available for
download are listed on the Components for Download dashboard. You can use the
controls on this dashboard to download agent installers from the Foglight Management
Server to a remote machine.
To download an agent installer:
1 On the navigation panel, under Dashboards, click Administration > Cartridges
> Components for Download.
The Components for Download dashboard appears.
2 Click the name of the installer that you want to download.
60 Foglight
Installation and Setup Guide

3 Follow the on-screen instructions for each step of the installation process and
specify the appropriate installation options.

Note For agents that are installed individually, you have to run the agent installer executable and
set up the agent on each machine you want to monitor with that type of agent.
The Foglight Agent Manager defines agents with their Agent Package name. When
displayed in the Create Agent dialog, the agent names are prepended with the cartridge
name.

Depending on the type of agent that you installed, you may need to edit its properties to
configure it for the part of your environment that you want to monitor. For information
about agent properties, see the Administration and Configuration Guide and the User
Guide for the cartridge with which the agent was included.

Remote Agent Installation


You can install Foglight agents on any remote host on which the Foglight Agent
Manager is installed. See the Foglight Agent Manager Installation Guide.
For more information about remote agent installation, see the Administration and
Configuration Guide.
A
Appendix: Switching from an
Embedded to an External Database

You may find a performance improvement in Foglight if you use an external database.
This section describes how to migrate from using an embedded MySQL database with
the Foglight Management Server to using an external MySQL database.
1 Stop the Foglight Management Server.
2 Start the embedded database manually:
<foglight_home>/bin/runDb.sh
3 Export the database content:
<foglight_home>/mysql/bin/mysqldump -uroot -p [password] --
port=13306 --databases foglight > <foglight_home>/
foglight.dump
4 Shut down the database:
<foglight_home>/bin/shutdownDb.sh
5 Connect to the external MySQL instance via MySQL:
<foglight_home>/mysql/bin/mysql -h [mysql host] -P [mysql
port] -u root -p
6 Create the Foglight database instance by running:
mysql> source <foglight_home>/scripts/sql/
mysql_create_db.sql
7 Re-import the data dump:
mysql> source <foglight_home>/foglight.dump
8 Configure the Foglight Management Server to use this new database by opening
the following file:
<foglight_home>/config/foglight.config
62 Foglight
Installation and Setup Guide

9 Update the following values in the above file:


foglight.database.host = "[mysql host]";
foglight.database.port = "[mysql port]";
foglight.database.embedded = "false";
10 Remove the part of your Foglight installation that was used for the embedded
MySQL database by deleting the directory <foglight_home>/mysql.
11 Restart the Foglight Management Server.
12 Verify that the Management Server starts successfully:
a Open the most recent Management Server log file in <foglight_home>/logs.
b Look for the message Foglight Management Server startup
completed and ensure that there are no errors listed after it.
13 Verify that the Management Server connects to the migrated external MySQL
database. There are two ways to do so:
• Open the most recent Management Server log file in <foglight_home>/logs.
Verify that the parameter foglight.database.host lists your external
MySQL database host as its value and that foglight.database.embedded
is set to false.
• Log in to the browser interface and navigate to Dashboards >
Administration > Setup & Support > Foglight configuration. Verify that
your external MySQL database host is listed in the Database Host box and
that External is listed in the Database Location box.
Index 63

Index

Miscellaneous directories
256 bit AES keys 43 installed directories 33
documentation directory 33
dtd directory 33
A
administration
default user name and password 17
E
administrator elevated encryption policy 43
access 17 embedded Foglight Agent Manager 32
AES keys 43 encryption 43
Agents 9 extension directory 33
embedded 9
installing 59 F
fglam directory 33
B Foglight
bin directory 33 uninstalling 45
Foglight Agent Manager
embedded 32
C
cartridge directory 33
H
cartridges
installing 55 how to
client directory 33 access
config directory 33 the Cartridge Manager 55
console installation mode 11 install
credential management 43 a cartridge 56

D I
database installation
initializing 49 modes 11
recommendations 8
64 Foglight
Installation and Setup Guide

requirements 17 P
installed directories 33 password
bin 33 administrator 17
cartridge 33 properties file 12
client 33
config 33
docs 33 R
dtd 33 recommendations
extension 33 for installing Foglight 8
fglam 33 remote agent installation 60
jre 34 root
lib 34 access 17
license 34 running
logs 34 Foglight 49
mysql 34
scripts 34 S
server 34 scripts directory 34
state 34 server
support 34 starting 50
UninstallerData 35 stopping 51
installing cartridges 55 server directory 34
silent installation mode 12
J starting the server 50
JAR files directory 34 state directory 34
JRE directory 34 stopping the server 51
stronger encryption 43
support 6
L support directory 34
lib directory 34
license directory 34
licensing 10 T
logging in technical support 6
to Foglight 51
logs directory 34 U
UninstallerData directory 35
M uninstalling
Management Server 9 Foglight 45
mysql files directory 34 UNIX
Index 65

console mode 11
user account
administrator 17