Professional Documents
Culture Documents
2
Installation and Setup Guide
Installing on a UNIX System
with an External Oracle Database
© 2017 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 Software 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
Software products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE
AGREEMENT FOR THIS PRODUCT, QUEST SOFTWARE 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 SOFTWARE 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 SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest Software 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 Software 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 Inc.
Attn: LEGAL Dept.
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our website (https://www.quest.com) for regional and international office information.
Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product. For the most current
information about applicable patents for this product, please visit our website at https://www.quest.com/legal.
Trademarks
Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete
list of Quest marks, visit https://www.quest.com/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache
Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc.
Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise
Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the
U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory,
Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows
Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX,
IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many
jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered
trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC
International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture
developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered
trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Linus Torvalds in the
United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union
and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries.
VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc.
in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX
are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”,
“Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and
“Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc.
and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are
trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec
and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries.
OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow,
NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be
registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks
or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of
Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark
Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States
and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by
Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini,
and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of
Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or
registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries.
Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the
U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of
the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are
trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community
Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and
RMX® are registered trademarks of Polycom, Inc. All other marks and names mentioned herein may be trademarks of their
respective companies.
Legend
CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed.
WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death.
IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information.
Installing Foglight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Preparing to install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Installing a new version of the Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Foglight Server Startup page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Next steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
External Oracle database access for remote users . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Embedded Agent Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Installed directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Foglight settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Editing the server.config file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Enabling High Availability mode after installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Changing external database credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Setting up an encrypted database connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Setting up an encrypted LDAP connection with SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Using encryption when sending email from Foglight . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuring ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuring the cluster multicast port used in High Availability mode . . . . . . . . . . . . . . . 26
Setting up Foglight server federation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Setting memory parameters for the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Adding command-line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Binding the Management Server to an IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring Foglight to use stronger encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring Foglight to use the HTTPS port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting the length of Foglight sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
HP patch checking tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Uninstalling Foglight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Upgrading the Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Installing Foglight FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Installing Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Agent installers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Remote agent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
This guide provides instructions for installing, configuring, and starting Foglight®. Before you begin, see the
System Requirements and Platform Support Guide.
This section provides setup information and an initial overview of installing Foglight:
• What is Foglight?
• Hardware requirements and guidelines
• Planning your installation
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 solution simplifies application performance monitoring and reduces the skills and effort required to
manage applications, the user experience, and the supporting infrastructure.
Unlike other solutions, Foglight uses a single code base, and has a model-driven design that couples fast
deployment and accelerated time-to-value. It offers the modular flexibility required to deliver a range of capabilities
and sophistication to meet the needs of any organization, from organizations focused on technology-centric
monitoring to organizations that have completed the transition to application-centric or transactional monitoring.
Foglight performs equally well in physical, virtual, and mixed infrastructure environments, providing visibility into
issues affecting the application and end user experience. Intuitive workflows help you quickly move from the
symptom to the root cause in the application, database, infrastructure, or network to resolve issues, reducing
mean time to resolution. Predefined and drag-and-drop dashboards provide insight that is tailored to each
stakeholder. By offering comprehensive visibility into your monitored environment, Foglight helps ensure that
cross-functional teams collaborate on and prioritize issues that matter most to the business.
Foglight includes several different components, which are described in the Getting Started Guide.
Hardware requirements
For the current single- and multi-tier hardware requirements, see the System Requirements and Platform Support
Guide.
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 external database installations only.
The following list summarizes the main stages involved in installing and configuring Foglight:
Stage 1: Install the Management Server and configure the Management Server and database. The Management
Server is the data collection and processing server.
Stage 2: Install, configure, and initialize the database, then start the Foglight Management Server and log in.
NOTE: If you are using an external database, the database must be initialized successfully before you can
run Foglight.
Stage 3: Install and configure cartridges. Cartridges extend the functionality of Foglight, and are installed on the
machine hosting the 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 Agent Manager is a client that manages
agents installed on monitored hosts. See the Foglight Agent Manager Guide for details.
Stage 5: Install and configure agents. Agents are deployed on machines in your monitored environment and send
data to the Management Server. There are several types of agents. One or more instances of each type of agent
managed by the 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.
IMPORTANT: Install and configure the Agent Manager before deploying agents that are installed on a
monitored host.
NOTE: The default value for the restart process is 10 minutes (600 seconds). Machines with a slower
processing speed take longer to reboot. You can modify the default time by editing the startup.grace
variable in the restart_monitor.config file (located in the config directory).
• Standby Server: To reduce outage times, a standby server instance is created (for a particular Foglight
Management Server), and forms a partition. One server becomes the primary server and communicates
with the agents, receives and processes data, and processes rules. All other servers are standby servers. If
a primary server stops responding, one of the standby servers resumes service and becomes the primary
server.
NOTE: Oracle databases must be configured to support Unicode characters. For example, you can use
UTF-8 or UTF-16 to support Unicode.
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).
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.
Managing licenses
NOTE: This section is relevant only when installing Foglight for Virtualization, Enterprise Edition or Foglight
for Storage Management systems.
When you install Foglight for Storage Management, a 45-day trial license is activated.
When you install Foglight for Virtualization, Enterprise Edition, Foglight for Storage Management is also installed
along with a 45-day trial license. You must activate the Foglight for Storage Management trial license.
Foglight for Virtualization, Enterprise Edition and Foglight for Storage Management are licensed separately. You
can install a purchased license of Foglight for Storage Management at any time, either during the 45-day trial, or
after the trial period has expired. When the trial license expires, the Foglight for Storage Management user
interface is disabled. Your access to Foglight continues according to your Foglight license.
NOTE: Foglight for Storage Management functionality requires an active, licensed Foglight installation. It
cannot be accessed independently from Foglight.
If you later purchase a license, the process for installing a Foglight for Storage Management license is the same as
it for installing a Management Server license. For more information, see Importing a license file after installation.
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
For Foglight systems, the console mode is available on UNIX® only for Solaris (SPARC 64 or x86-64) and Linux®.
For Foglight for Virtualization, Enterprise Edition and Foglight for Storage Management systems, the console
mode is available on UNIX only for 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:
NOTE: Foglight installation with an external Oracle database does not allow tablespace configuration in
silent and console modes. This option is only available in the interactive installations, using advanced
settings.
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 following table.
IMPORTANT: Silent mode does not work if you set parameters in the properties file for Foglight to connect to
an external database, and an existing Foglight schema is present in that database. There is no Foglight
silent installer parameter for using an existing database schema in order to prevent the contents of an
existing database from being lost.
If you attempt to run the silent installer using a properties file that specifies an external database where an
existing Foglight schema is present, a fatal error appears in the installation logs. See Installing Foglight FAQ
for more information about the error message and workarounds.
NOTE: In certain configurations the Management Server uses ports in addition to the ones that you set using
the silent installer; for example, when Foglight is running in High Availability (HA) mode. See the
Administration and Configuration Guide for details.
NOTE: Foglight installation with an external Oracle database does not allow tablespace configuration in
silent and console modes. This option is only available in the interactive installations, using advanced
settings.
The following table lists the properties available for configuring a silent installation, and their default values.
Preparing to install
The requirements for installing Foglight are:
• A machine to host the 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.
NOTE: Link-local IPv6 addresses are not supported for the Management Server because many web
browsers do not support link-local IPv6 addresses.
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.
NOTE: The Standard Install option is only available if you are installing with an embedded database.
NOTE: The installation type (New Install) is displayed on this screen. If you want to upgrade an existing
installation of the Management Server, continue clicking Previous until you return to the Choose Install
Folder screen. See the Upgrade Guide for detailed upgrade instructions.
2 If you choose HA (High Availability): In the HA Partition field, type the partition name. All servers set up
in HA (High Availability) mode that you want to act as either primary or secondary servers for failover
must be configured with the same partition name.
IMPORTANT: Servers with different partition names do not participate in the high availability setup.
NOTE: If you do not choose HA (High Availability) while installing Foglight but want to use HA mode
later, you can enable HA mode after installation. For more information, see the Foglight High
Availability Field Guide.
3 Click Next.
If the Management Server you are installing is configured to be part of an HA cluster, you must also configure it to
connect to the same database instance as all other members of the cluster. This typically means that you set Host
and TNS Port to the same values as those used for the other members. In some rare cases, certain settings might
be different. For example, the value for Host might be different if there is a firewall between the database and
certain members of the cluster in your environment.
1 In the Host box, type the host name or IP address where the Oracle® instance will run (the default is
localhost).
2 In the TNS Port field, specify a port number or accept the default (1521). This is the TCP/IP port used by
the TNS listener on the host machine.
3 In the SID field, type the service ID for the Oracle instance.
4 In the Foglight Repository User Name box, accept the default user ID or type an alternate one. The
Management Server uses this account to connect to the database.
5 In the Foglight Repository User Account Password box, accept the default password or type an alternate
one. The Management Server uses this password to connect to the database
6 In the Foglight Repository User Account Retype Password box, accept the default or, if you have provided
an alternate password in step 5, retype the password for verification.
7 Click Next.
The Tablespaces dialog box appears.
8 You can configure Oracle tablespace information at this time. The values you specify in this dialog box are
referenced in the storage-config.xml file. See the Performance Tuning Field Guide for more information
about Oracle tablespaces.
NOTE: Check with your database administrator for information on how to correctly assign tablespace
names.
NOTE: Foglight installation with an external Oracle database does not allow tablespace configuration
in silent and console modes. This option is only available in the interactive installations, using
advanced settings.
12 If you select Automatically create the repository database, select the Repository Administrator Account
Authentication Method, and then type the Repository Administrator Account User Name and Password.
The Management Server uses the administrator account credentials to create the Oracle database.
NOTE: The Repository Administrator Account User Name cannot be the same as the User Account
User Name you created in step 4.
IMPORTANT: If the Management Server you are installing is configured to be part of an HA cluster,
you must set the Repository Administrator Account User Name and Password to the same
values as those used for the other Management Servers that share the same HA partition name.
13 Click Next.
If a database schema already exists, the Foglight Database Found screen appears. This screen allows you
to keep your existing data, create a new database, or select a different database. If you are running in HA
mode, select Keep existing data.
If you chose Manually create the repository database in step 10, and did not create the database at that
time, an error message appears. For more information, see Manual database configuration.
NOTE: In certain configurations, the Management Server uses other ports than the ones that you
can set on this screen; for example, when Foglight is running in High Availability (HA) mode. See the
Administration and Configuration Help for details.
2 If you are installing Foglight in High Availability (HA) mode and are planning to have multiple HA partitions
on the same sub-network, configure a different Cluster Multi-cast Port for each HA partition. The primary
server and secondary servers within each HA partition must be configured to use the same Cluster Multi-
cast Port.
You can set this port from the Foglight Ports Configuration screen, or change it after installation in the
server.config file. See Configuring the cluster multicast port used in High Availability mode for information
about changing this port after installing Foglight.
IMPORTANT: Errors can occur if servers that are not part of the same HA partition are configured to
multicast on the same port on the same sub-network as the HA partition. See Running the
Management Server FAQ for more information about these errors.
NOTE: If there are any port assignment conflicts, an error message dialog box appears. 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.
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).
2 Click Next.
Alternatively, you can provide a license file to the Management Server after the installation is complete. To
do so, leave the License File box blank and click Next.
NOTE: You can install Foglight for Virtualization, Enterprise Edition with the default option of a 45-day trial
license, or import an existing license. To install the default option, select Install a trial license, then click Next.
To import an existing license, follow the preceding procedure.
1 To start the Foglight Management Server without adding Foglight to the system service (the default
setting), click Next.
2 To start the Foglight Management Server as a system service, select Yes, add foglight to the system
service.
Next steps
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 installation to provide a license file to the 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 Management
Server by following the instructions in Starting and stopping the Management Server.
To log in to Foglight, see Logging in to Foglight.
To set up an encrypted database connection, see Setting up an encrypted database connection.
NOTE: Although the Foglight Agent Manager Adapter cartridge is installed by default with the embedded
Agent Manager, you must install an Agent Manager cartridge that contains installers for your supported
platforms, in order to deploy the Agent Manager to remote hosts.
See the Agent Manager Guide for information about selecting an Agent Manager cartridge, downloading
installers, and installing, configuring, and running the 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 selected 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 that client programs (such as the command-line client) use for remote
access to Foglight.
compat Cartridge files: Core-HostServices-compatibility-5_9_2.car
and FTR-WS-1_0_0.car
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 Agent Manager.
jre Version of the JRE (1.8) that Foglight uses.
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 that Foglight generates when it runs.
Generated at runtime.
postgresql Default location for the embedded PostgreSQL® library.
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
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-templates 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 that a particular Foglight server variant uses (such as
default).
state Where the running state of Foglight is kept.
It includes the following sub-directories:
• cartridge.exploded. A working directory for deploying cartridges. It
contains files extracted from installed cartridges. This is the same data as
in the corresponding CAR files, just unzipped. The contents change on
cartridge redeployment, but should not change on server restart. Users
should not modify this data (even if the server is not running).
• postgresql-data. Default location for the embedded PostgreSQL® data.
Directory Contents
support Where support bundled archive information is stored.
tmp/cartridge.deployed A working directory for deploying cartridges. This directory contains files
extracted from cartridges for the current Management Server run. Contents may
change on restart or cartridge redeployment.
This data can be deleted if the server is not running. The server re-creates what
is necessary on restart.
tools Various Foglight utilities.
UninstallerData Files that the Foglight uninstaller uses.
upgrade Directory that the installer uses.
Foglight settings
Foglight can run with its default settings. Edit these settings if you need to change run-time parameters such as
settings for running the Management Server in High Availability (HA) mode or the ports that the Management
Server uses. Many Foglight settings can be changed by editing the file <foglight_home>/config/server.config,
which contains settings.
NOTE: In certain configurations the Management Server may use ports in addition to the ones that you set
using server.config; for example, when Foglight is running in High Availability (HA) mode. See the
Administration and Configuration Guide for details.
IMPORTANT: Do not use “<“ and “>” in your password, for example jo<anne>123. These characters corrupt
the XML in the server.config file, causing Foglight to fail to start successfully.
NOTE: This procedure must be performed after installation but before you start the Management Server.
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.
Configuring ports
You can set a number of different ports using the file <foglight_home>/config/server.config, including mandatory
ports required for Foglight to run.
For a list of these ports, their default values, and the configuration parameters you can use to set them in
server.config, see the Administration and Configuration Help.
NOTE: In certain configurations the Management Server may use ports in addition to the ones that you set
using server.config; for example, when Foglight is running in High Availability (HA) mode. See the
Administration and Configuration Guide for details.
IMPORTANT: Federation is an advanced feature, which requires a dedicated Management Server separate
from the Management Servers that are acting as data collectors. Contact Quest Professional Services to
design and implement a federation strategy.
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 that the System Administrator specifies.
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 must configure your firewall or network security applications to allow both ports to remain open.
cp tomcat.keystore <your_backup_key>
2 Delete the existing tomcat key from the tomcat.keystore directory using the following command:
<foglight_home>/jre/bin/keytool<foglight_home>/config/tomcat.keystore -
keystore tomcat.keystore -storepass nitrogen -alias tomcat -delete
3 Create a new key under the tomcat alias using the following command:
<foglight_home>/jre/bin/keytool<foglight_home>/config/tomcat.keystore-keystore
tomcat.keystore -storepass nitrogen -genkeypair -alias tomcat -validity <number
of days> -keyalg RSA -keysize 2048 -dname "CN=<your_fmsserver_dns_name>,
OU=<your_organizational unit_name>, O=<your_organization_name>,
L=<your_city_name>, ST=<your_state_name>, C=<your_two-letter_country_code>" -
ext SAN=dns:<your_fmsserver_dns_name>,ip:<your_fmsserver_ip>
4 Generate a Certificate Signing Request (CSR) using the following command:
<foglight_home>/jre/bin/keytool<foglight_home>/config/tomcat.keystore-keystore
tomcat.keystore -storepass nitrogen -alias tomcat -validity <number of days> -
certreq -ext san=dns:<your_fmsserver_dns_name>,ip:<your_fmsserver_ip> -file
<your_request_file.csr>
This file must be signed by Certification Authority (CA).
5 Once you have the certificate signed, import it back to the tomcat.keystore using the following command:
<foglight_home>/jre/bin/keytool<foglight_home>/config/tomcat.keystore-keystore
tomcat.keystore -storepass nitrogen -alias tomcat -validity <number of days> -
trustcacerts -import -file <your_converted_cerificate>
You will get a prompted message similar to the following:... is not trusted. Install reply
anyway? [no]:
Type yes to install the new certificate.
The following is an example of commands for importing a certificate.
cd <foglight_home>/config
cp tomcat.keystore tomcat.keystore.backup
<foglight_home>/jre/bin/keytool -keystore tomcat.keystore -storepass nitrogen -
alias tomcat -delete
<foglight_home>/jre/bin/keytool -keystore tomcat.keystore -storepass nitrogen -
genkeypair -alias tomcat -validity 730 -keyalg RSA -keysize 2048 -dname
"CN=fms.quest.com, OU=Foglight, O=Quest, L=Aliso Viejo, ST=CA, C=US" -ext
SAN=dns:fms.quest.com,ip:192.168.1.1
<foglight_home>/jre/bin/keytool -keystore tomcat.keystore -storepass nitrogen -
alias tomcat -validity 730 -certreq -ext san=dns:fms.quest.com,ip:192.168.1.1 -
file san.p7b
<foglight_home>/jre/bin/keytool -keystore tomcat.keystore -storepass nitrogen -
alias tomcat -validity 730 -trustcacerts -import -file san.p7b
You can configure the length of inactive Foglight browser interface sessions by changing the value of the
parameter server.console.session.timeout. This parameter controls the length of time that Foglight waits
before automatically logging you out of an idle browser interface session.
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.
To uninstall Foglight:
1 Stop the Foglight Management Server using the appropriate method:
▪ To stop a standalone Management Server, follow the instructions in Stopping the Management
Server.
▪ To stop a Management Server that is running in High Availability (HA) mode, follow the instructions
in Starting and stopping the Management Server in High Availability mode.
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 the uninstaller does not remove certain directories within <foglight_home>.
NOTE: The database tool and scripts described do not create tablespaces. If you need to create new
tablespaces, you must do so manually first, before running the database tool. See the Performance Tuning
Field Guide for more information about Oracle® tablespaces.
NOTE: The -Ddb.admin.user must exist, and must have database administrator privileges.
▪ -Ddb.admin.password
▪ -Ddb.schema.username
NOTE: The tool creates the -Ddb.schema.username user when you run the command.
▪ -Ddb.schema.password
▪ -Ddb.schema.name
NOTE: To delete the database and start over, run the database tool with the dropdb option instead of the
createdb option shown in the preceding example.
NOTE: Unless you are creating custom Oracle® tablespaces, you should not need to edit these scripts. If
you are creating Oracle tablespaces, check with your database administrator to correctly assign tablespace
names.
It is recommended that you create a Foglight label for Data, Index, and Objects.
If custom tablespaces are configured in the storage-config.xml, as described in the Performance Tuning
Field Guide, the database administrator must edit the oracle_create_db.sql script and add grants for the
custom tablespaces. These grants are similar to the ones that grant a quota on the USERS tablespace. For
example:
ALTER USER @db.schema.username@ QUOTA UNLIMITED ON
SOME_CUSTOM_DATA_TABLESPACENAME_HERE;
ALTER USER @db.schema.username@ QUOTA UNLIMITED ON
SOME_CUSTOM_INDEX_TABLESPACENAME_HERE;
ALTER USER @db.schema.username@ QUOTA UNLIMITED ON
SOME_CUSTOM_LOB_TABLESPACENAME_HERE;
NOTE: In the example above, replace the italicized text (for example,
SOME_CUSTOM_DATA_TABLESPACENAME_HERE) with the actual custom tablespace names defined in the
storage-config.xml file.
NOTE: To start the Management Server in High Availability mode, see Starting and stopping the
Management Server in High Availability mode
When the Management Server starts successfully, the following message appears in the command window:
Forge Server startup completed.
Additional commands
Table 4. Starting the Management Server - additional commands
Initialization scripts
Another option is to start the Management Server using initialization scripts. This option is particularly useful when
you want to automatically start the Management Server after it has been rebooted.
The initialization scripts can be found in the directory <foglight_home>/scripts/init.d. A readme.txt file is available in
the same location. Review this file before running the script as it contains valuable information on how to use the
script for your specific platform.
NOTE: To run the HA server, you must use an external database. The database has to be running before
you start the Foglight HA server.
Logging in to Foglight
NOTE: The Management Server must be running before you can log in to Foglight.
NOTE: The Foglight browser interface requires JavaScript. Ensure that you have enabled JavaScript
in your web browser before you attempt to log in.
To view the data that the HostAgent collects for the Management Server host:
1 On the navigation panel, under Dashboards, click Infrastructure.
2 From the Select a Service list, select the service for the host.
3 On the Monitoring tab, select the host from the list.
For more information about monitoring activities and exploring the data collected for the host, see the Foglight for
Infrastructure User and Reference Guide.
Next steps
To install cartridges, see Installing and Upgrading Cartridges.
Why does the error message “cannot restore segment prot after reloc: Permission denied”
appear when I start the 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
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 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.
IMPORTANT: In both cases described here (resolving errors and planning to have multiple HA partitions on
the same subnet), the primary server and secondary servers within each HA partition must be configured to
use the same cluster multicast port.
If I stop the 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 Management Server. However, if you do use this
method, follow the following workaround.
• 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.
Why does the “JavaScript Disabled” error message appear when I try to log in to Foglight?
The Foglight browser interface requires JavaScript. You may need to modify the security settings in your web
browser to enable this functionality. Depending on your browser, this setting may be labeled either “Enable
JavaScript” (for example, in Firefox®), or “Enable Active Scripting” (for example, in Internet Explorer®).
Why does clicking the login link on the server startup page not work?
The default link to the login page points to http://localhost:8080. In some instances, this link may not
correspond to the URL of your Foglight server, resulting in the link not working. This issue can also occur when
Foglight is not able to identify your local host. Add your host/IP information to the etc/hosts files to correct this
issue.
Why does a link-local IPv6 address not work with the Foglight web user interface?
Configuring the Management Server with a link-local IPv6 address is not supported because many web browsers
do not support link-local IPv6 addresses. To correct this issue, update your host/IP information in the etc/hosts
file.
To install a cartridge:
1 Navigate to the Cartridge Inventory dashboard (Dashboards > Administration > Cartridges > Cartridge
Inventory).
2 Click Install Cartridge.
3 In the Install Cartridge dialog box, 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 that you want to install.
4 The check box Enable on install is selected by default.
▪ To enable the cartridge when it is installed, leave this check box selected.
▪ To enable the cartridge after installation, clear this check box.
5 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 4), a disabled symbol ( ) appears in the row for that cartridge
in the Installed Cartridges table on the Cartridge Inventory dashboard.
For more information about cartridge installation and configuration, see the Administration and Configuration
Guide.
NOTE: Warning messages similar to the following appear in the 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.
Upgrading cartridges
For complete cartridge upgrade instructions, see the Upgrade Guide.
Next steps:
• To install a separate (non-embedded) instance of the Foglight Agent Manager, see the Foglight Agent
Manager Guide.
NOTE: Foglight 4-converted agents create two processes for themselves when activated by the Agent
Manager.
Agent installers
Agents that depend on the Agent Manager are installed using the remote installation procedure. See Remote
agent installation and the Administration and Configuration Guide.
Some cartridges Foglight 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 Management Server to a remote machine.
NOTE: For agents that are installed individually, run the agent installer executable and set up the agent on
each machine you want to monitor with that type of agent.
The 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.
Contacting Quest
For sales or other inquiries, visit www.quest.com/contact.