Chat now with support
Chat with Support

Foglight for Oracle (Cartridge) 7.1.0 - User Guide

Installing and Configuring Agents Using Foglight for Oracle
Viewing the Databases Dashboard Assigning Instances to Users Selecting an Instance to Monitor Foglight for Oracle Overview Dashboard Overview view Advisories view SQL Performance Investigator (SQL PI) Oracle Activity Drilldown Pluggable Databases Drilldown Storage Drilldown Reviewing Configuration Settings Reviewing the Alert Log Reviewing Monitored Data Guard Environments Reviewing ASM Instances Reviewing Exadata-related Information
Administering Foglight for Oracle Reporting Reference Glossary

Adding ASM Instances

The process of adding ASM instances is almost identical to the process of adding Oracle instances as described in:

•
Installing and Monitoring a Single Oracle Instance .
•
Discovering Multiple Instances to Monitor .

To add ASM instances go to the ASM tab. Click Monitor more ASM instances at the upper left corner of the Databases table.

If the installer detected that the ASM instance is part of an ASM cluster, a dialog box appears asking you to verify the connection details.

After ASM instances are configured, the ASM tab will provide access to a more detailed ASM Dashboard. For details, see Reviewing ASM Instances

Configuring Multiple Instances for Monitoring using Silent Installation

* 
NOTE: The instructions below refer to adding multiple Oracle agents. A similar process exists for adding multiple ASM instances. For more information, see Configuring Multiple Instances for ASM .
To add multiple agents using the silent installation through a command line interface:
1
In the navigation panel, under Dashboards, click Administration > Cartridges > Components for Download.
2
Click the Installer icon beside DB_Oracle_CLI_Installer.
3
Follow your browser’s prompts to save the ZIP file.
4
Extract the ZIP file to a directory of your choice.
The ZIP file contains the following files:
•
README.txt file
•
oracle_cli_installer.groovy — a groovy script file that runs the silent installation. This file should be copied to the <FMS_HOME>/bin directory.
•
oracle_silent_installer_input_template.csv — a template file that should serve as the basis for inserting contents into the input CSV file. This file can be copied to any folder of your choice, provided that the path indicated by the <oracle_instances_file_name> parameter (see below) points to the selected path. For details about the contents of this file, see Contents of the input CSV file for Oracle instances
5
Copy the oracle_cli_installer.groovy file to the <FMS_HOME>/bin directory.
6
Go to the command line and execute the command:
<FMS_HOME>/bin/fglcmd -srv <fms_host_name> -port <fms_url_port> -usr <fms_user_name> -pwd <fms_user_password> -cmd script:run -f oracle_cli_installer.groovy fglam_name <fglam_name> oracle_instances_file_name <oracle_instances_file_name> lockbox_name <lockbox_name> lockbox_password <lockbox_password>
The descriptions of the flags and parameters in this command are as follows:
•
<FMS_HOME>: The Foglight Management Server installation directory.
•
<fms_host_name>: The name of the host where the Management Server is installed.
•
<fms_url_port>: The Management Server HTTP port.
•
<fms_user_name>: The user name used for connecting to the Management Server.
•
<fms_user_password>: The password of the specified user.
•
<clusters_file_name>: The full path and the name of the input CSV file.
•
<lockbox_name>: Optional — specifies the name of an existing lockbox that would be used.
•
<lockbox_password>: Optional — the selected lockbox's password.
7
After the installation process completes, review the CSV files that are created in the same folder where the input file resides:
•
A file with the input file's name and _status suffix (for example: if the input file is named input, this file is named input_status).
This file indicates the monitoring situation of all Oracle instances listed in the input CSV file. If monitoring failed for one or more of the instances, the file specifies the error message.
The _status file includes the name of the monitored Foglight for Oracle agent, the result of the monitoring validation process - MONITORED, FAILED, or AGENT EXISTS - and the error message, in case the agent creation failed.
* 
IMPORTANT: If all instances listed in the input CSV file passed the monitoring validation successfully, no additional file is created.
•
A file with input file's name and _new suffix (for example: if the input file is named input, this file is named input_new).
This file, which is only created if one or more instances, nodes or RACs failed the monitoring validation, contains all details about these instances, RACs, or nodes.
Using this CSV file, the user only needs to fix the errors and re-run the script, this time by specifying this file as the input file, that is: the original file name with suffix _new. In the example used here, the new file should be named input_new_new.csv.

Contents of the input CSV file for Oracle instances

The input CSV file contains the following fields, which are used as columns in the resulting file.

 
 
Table 1. Contents of the input CSV file for Oracle instances
Name
Description

RAC Agent Name

The name of the RAC agent. This name must be unique per agent.

•
If the instance belongs to a RAC, this field has to contain the name of the RAC agent.
•
If this RAC runs multiple nodes, all instances must have the same RAC agent name.
•
If the instance does not belong to a RAC, leave this field empty.

Instance Type

The type of the instance to be monitored. The possible values are: SINGLE, NODE, RAC ONE NODE.

•
SINGLE: the instance does not belong to a RAC.
•
NODE: the instance belongs to a RAC that has more than one instance.
•
RAC ONE NODE: the instance belongs to a RAC with a single node.

Agent Name

The requested agent name. This name must be unique per agent. If an agent with the given name already exists, the newly provided agent will not be created.

Host

The host that is serving the Oracle instance or RAC.

Port

The TNS listener port.

Connection Method

The requested connection method. The possible values are either SERVICE_NAME or SID.

SID/Service Name

The name of the SID or service name used for establishing connection to the instance.

User name

The name of the user to be used for connecting to the instance.

NOTE: The user name for monitoring must exist prior to running the silent installation.

Password

The password of the database user name.

Administrator User Name (Optional)

The user name of a user that can grant privileges to the regular database user; required only if the regular user does not have sufficient privileges.

Administrator Password (Optional)

The password of the database administrator user name mentioned above.

Enable OS Monitoring

Specifies whether to create an Infrastructure cartridge agent for the given host name; the possible values are True or False.

OS Platform (Optional)

The type of the OS platform where the Oracle instance runs; the possible values are either UNIX or WINDOWS.

Authentication (Optional)

OS authentication type. This field can have one of the following values:

•
LOGIN_PASSWORD: user/password authentication
•
RSA_KEY: RSA-based public key authentication
•
DSA_KEY: DSA-based public key authentication
•
CLIENT_LOGIN: uses the Foglight Agent Manager's login
•
WINDOWS_ACCOUNT: Windows authentication, in the domain\user and password convention

OS User Name (Optional)

The user name required for connecting to the OS.

OS Password (Optional)

The password of the OS user specified above.

Credential Name (Optional)

An existing credential name.

When using this property, the 'OS User Name', 'OS Password', 'Private Key File Path', and 'Passphrase' properties will be ignored.

SSH Port (Optional)

The port that is used for listening to SSH connections on the monitored hosts; if the monitored host is Windows-based, leave this field empty.

Private Key File Path (Optional)

The full path of the private key file; relevant only to the following credential types: RSA_KEY, DSA_KEY.

Passphrase (Optional)

The passphrase of the OS user that is used in public key authentication; relevant only to the following credential types: RSA_KEY, DSA_KEY.

Use sudo (Optional)

Used for indicating that the OS user specified above is not an administrator user, but can run certain commands that require administrative privileges as root.

The possible values are TRUE or FALSE. if the monitored host is Windows-based, leave this field empty to indicate FALSE.

Enable VMware Collection (Optional)

Indicates whether to monitor VMware metrics; The possible values are TRUE or FALSE.

VMware Host (Optional)

The VMware host name.

VMware Port (Optional)

The VMware port. If no value is inserted in this field, the port number to be used is the default number 443.

VMware User Name (Optional)

The user name required for connecting to the VMware.

VMware Password (Optional)

The password of the VMware user specified above.

Enable PI (Optional)

Indicates whether to enable PI; the possible values are TRUE or FALSE. Leaving this field empty indicates a FALSE value.

A PI repository must be already installed and assigned to at least one agent on the monitoring FglAM.

Listener Name (Optional)

The instance listener name. Default “LISTENER” name will be used if this field remains empty.

Encrypted Passwords (Optional)

Indicates whether the given passwords are already encrypted; the possible values are TRUE or FALSE. Leaving this field empty indicates a FALSE value.

The password encryption can manually be done by executing 'Dbwc_Common_Oracle_EncryptString(<Password>)' function from Foglight's script console.

Is Mounted (Optional)

Indicates whether the given monitored instance is in a mounted stand-by mode (data-guard); the possible values are TRUE or FALSE. Leaving this field empty indicates a FALSE value.

Use SSL (String - true/false)

Specifies whether an SSL connection should be used; the possible values are TRUE or FALSE.

If no value is inserted in this field, it will use the default value FALSE.

Group Names (Optional)

The database group names you want to add the monitored instance to; multiple group names should be separated with “;”. For example: groupA;groupB;groupC

When the group already exists, then the monitored instance will be attached to the existing group. When the group does not exist, then a new group will be created under the default group “Database Groups”.

Configuring Multiple Instances for ASM

To add multiple agents using the silent installation through a command line interface:
1
In the navigation panel, under Dashboards, click Administration > Cartridges > Components for Download.
2
Click the Installer icon beside DB_Oracle_ASM_CLI_Installer.
3
Follow your browser’s prompts to save the ZIP file.
4
Extract the ZIP file to a directory of your choice.
The ZIP file contains the following files:
•
README.txt file
•
asm_cli_installer.groovy — a groovy script file that runs the silent installation. This file should be copied to the <FMS_HOME>/bin directory.
•
asm_silent_installer_input_template.csv — a template file that should serve as the basis for inserting contents into the input CSV file. This file can be copied to any folder of your choice, provided that the path indicated by the <asm_instances_file_name> parameter (see below) points to the selected path. For details about the contents of this file, see Contents of the input CSV file for Oracle instances .
5
Copy the asm_cli_installer.groovy file to the <FMS_HOME>/bin directory.
6
Go to the command line and execute the command:
<FMS_HOME>/bin/fglcmd -srv <fms_host_name> -port <fms_url_port> -usr <fms_user_name> pwd <fms_user_password> -cmd script:run -f asm_cli_installer.groovy fglam_name <fglam_name> asm_instances_file_name <asm_instances_file_name> lockbox_name <lockbox_name> lockbox_password <lockbox_password>
The descriptions of the flags and parameters in this command are as follows:
•
<FMS_HOME>: The Foglight Management Server installation directory.
•
<fms_host_name>: The name of the host where the Management Server is installed.
•
<fms_url_port>: The Management Server HTTP port.
•
<fms_user_name>: The user name used for connecting to the Management Server.
•
<fms_user_password>: The password of the specified user.
•
<fglam_name>: The name of the selected Foglight Agent Manager where new agents are to be added.
•
<clusters_file_name>: The full path and the name of the input CSV file.
•
<lockbox_name>: Optional - specifies the name of an existing lockbox to be used.
•
<lockbox_password>: Optional - the selected lockbox's password
7
After the installation process completes, review the CSV files that are created in the same folder where the input file resides:
•
A file with the input file's name and _status suffix (for example: if the input file is named input, this file is named input_status).
This file indicates the monitoring situation of all Oracle instances listed in the input CSV file. If monitoring failed for one or more of the instances, the file specifies the error message.
The _status file includes the name of the monitored Foglight for Oracle agent, the result of the monitoring validation process - MONITORED, FAILED, or AGENT EXISTS - and the error message, in case the agent creation failed.
* 
IMPORTANT: If all instances listed in the input CSV file passed the monitoring validation successfully, no additional file is created.
•
A file with input file's name and _new suffix (for example: if the input file is named input, this file is named input_new).
This file, which is only created if one or more instances, nodes or RACs failed the monitoring validation, contains all details about these instances, RACs, or nodes.
Using this CSV file, the user only needs to fix the errors and re-run the script, this time by specifying this file as the input file, that is: the original file name with suffix _new. In the example used here, the new file should be named input_new.csv.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating