Skip Headers
Oracle® Mail Administrator's Guide
10g Release 1 (10.1.2)

Part Number B25499-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

7 Monitoring Oracle Mail

This chapter describes how to set up monitoring for the Oracle Mail component of Oracle Collaboration Suite. An Oracle Mail installation may be spread over dozens of computers.

Monitoring Oracle Mail can also be done using the oesmon and oeschart command-line utilities.

This chapter discusses the following topics:

Monitoring Oracle Mail Using Oracle Enterprise Manager 10g Grid Control Console

The following instructions assume that Oracle Mail is already installed and that Oracle Enterprise Manager 10g Grid Control Console and Oracle Management Agent are already installed. Furthermore, the following instructions assume that you have detailed knowledge of how Oracle Mail is configured and where the different protocol servers are running.

In this section you will create targets that represent components of your Oracle Mail deployment. In addition, an Oracle Mail group target will be created. The group target will include all the component Oracle Mail targets.

This section discusses the following topics:

Overview of Oracle Mail Target Types

Oracle Mail has several protocols with distinct services and servers for each type of protocol:

  • IMAP

  • SMTP inbound

  • SMTP outbound

  • POP

  • Oracle WebMail

An Oracle Mail server refers to a specific process running on a specific host. As a result, the up or down metric for a server indicates whether or not the process is running. An Oracle Mail service refers to the service provided by a collection of processes. For a service, the up or down metric indicates whether or not a user can make use of that service.

These Oracle Mail services and servers are often spread over hosts and databases. Create the targets as follows:

  • One service target for each logical service

  • One information store target for each Oracle Collaboration Suite Database

Identifying Oracle Mail Hosts and Databases

Before you begin creating the Oracle Mail targets, you should have a complete list of the hosts and the databases where your Oracle Mail components reside. For example, you should know the system identifier (SID) and password for each database.

The following sections describe how you can obtain this information using the Oracle Internet Directory for your Oracle Collaboration Suite installations:

Identifying the Oracle Mail Component Hosts

You can identify the Oracle Mail hosts by using the following ldapsearch command for your Oracle Internet Directory:

$PROMPT> ldapsearch -hoid_host -poid_port -Dcn=orcladmin -wwelcome1 -b 'cn=Computers,cn=OracleContext' 'objectclass=orclMailProcessConf' orclmailinstanceid

For example:

$PROMPT> ldapsearch -has15.acme.com -p4032 -Dcn=orcladmin -wx9djiks189 -b 'cn=Computers,cn=OracleContext' 'objectclass=orclMailProcessConf' orclmailinstanceid

Identifying Locations of Oracle Collaboration Suite Databases

To identify the hosts and the names of the databases where your Oracle Collaboration Suite Databases are located, you can use the following ldapsearch command for your Oracle Internet Directory:

$PROMPT> ldapsearch -hoid_host -poid_port -Dcn=orcladmin -worcladmin_pwd -b 'cn=EMailServerContainer,cn=Products,cn=OracleContext' 'objectclass=orclMailStores'

For example:

$PROMPT> ldapsearch -hmgthost42.acme.com -p3060 -Dcn=orcladmin -wx9djiksl89 -b 'cn=EMailServerContainer,cn=Products,cn=OracleContext' 'objectclass=orclMailStores'

Identifying the Connection String for an Oracle Collaboration Suite Database

Find the connection string for an Oracle Collaboration Suite Database, so you can connect to the information store or provide the host, port, SID, user name, or password properties for the information store, as follows:

  1. Obtain the value of the orclDBDistinguishedName attribute for the Oracle Collaboration Suite Database.

    You can obtain this value by searching for the Oracle Collaboration Suite Database host and database properties, using the command described in "Identifying Locations of Oracle Collaboration Suite Databases".

  2. Use the ldapsearch command to find the orclnetdescrstring attribute of the Oracle Collaboration Suite Database:

    $PROMPT> ldapsearch -hoid_host -poid_port -Dcn=orcladmin -worcladmin_pwd -b 'value_of_orclDBDistinguishedName' -s base 'objectclass=*'
    
    

    For example:

    $PROMPT> ldapsearch -hmgthost42.acme.com -p3060 -Dcn=orcladmin -wx9djiksl89 -b 'cn=v2store,cn=OracleContext' -s base 'objectclass=*'
    

About Oracle Mail Service Targets

The service targets monitor the Oracle Mail services. Thus, it is most beneficial to locate these targets close to where the user community using the services resides. It is also possible to create multiple targets for each service in order to measure responsiveness from multiple geographical locations.

One service target must be created for each service type. For example, an SMTP IN Service is implemented over four hosts; however, only one target is needed to monitor the overall service.

The same guidelines apply to the Oracle WebMail service. However, for Oracle WebMail use the Oracle Enterprise Manager 10g application performance management capabilities for monitoring.

Oracle Enterprise Manager 10g includes the following Oracle Mail service types:

  • E-Mail SMTP Inbound Service

  • E-Mail SMTP Outbound Service

  • E-Mail IMAP Service

  • E-Mail POP Service

  • E-Mail NNTP Inbound Service

To configure service monitoring, configure targets at points in the network close to the user communities accessing Oracle Mail. Thus, having an SMTP_IN service monitoring target type in a few key geographical locations is necessary to get an overall perspective on the SMTP_IN monitoring.

Oracle suggests using the following naming convention for service targets: SMTP_IN_SERVICE_information_store location_of_observation, such as SMTP_IN_SERVICE_EMEA_LONDON.

For monitoring Oracle WebMail, create a Web Application target and record an availability transaction for Oracle WebMail. This transaction must be run from beacons in key geographical locations that represent user communities.

This section discusses the following topics:

Creating Oracle Mail Service Targets

Create Oracle Mail service targets, as follows:

  1. Using the Grid Control Console, navigate to the Agent home page for the Oracle Management Agent that was installed on the Oracle Collaboration Suite Database host, as follows:

    1. Click the Targets tab.

    2. Click the link in the Name column of the Host type.

    3. Click the Targets link.

    4. Click the link in the Name column of the Agent type.

  2. In the Monitored Targets section of the page, select one of the following service types from the Add list and click Go to display the Add E-Mail Service page for that particular service:

    • E-Mail SMTP Inbound Service

    • E-Mail SMTP Outbound Service

    • E-Mail IMAP Service

    • E-Mail POP Service

    • E-Mail NNTP Inbound Service


      Note:

      Ensure that you select a Service and not a Server.

    Oracle recommends creating targets for the E-Mail IMAP and E-Mail SMTP Inbound services, at the minimum, as described in the subsequent steps.

    1. Select E-Mail IMAP Service from the Add list and click Go to display the Add E-Mail IMAP Service page.

    2. On the Add E-Mail IMAP Service page, enter a name for the target in the Name field.

      Provide the required information, as described in Table 7-1.

      Table 7-1 E-Mail IMAP Service Target Properties

      Property Description

      Service Address

      The host name or the IP address of the load balancer or system used by clients for accessing the IMAP service.

      Service Port

      The port where the IMAP service is running.

      E-Mail Address

      The e-mail address of a test user account to be used for the status and the service availability of the IMAP service. You can use the orclguest@your_domain account that is created by default in the e-mail system.

      E-Mail Password

      The e-mail account password of a test user account to be used for the status and the service availability of the IMAP service.


    3. Click OK to create the target.

    4. Select E-Mail SMTP Inbound Service from the Add list and click Go to display the Add E-Mail SMTP Inbound Service page.

    5. On the Add E-Mail SMTP Inbound Service page, enter a name for the target in the Name field.

      Provide the required information, as described in Table 7-2.

      Table 7-2 E-Mail SMTP Inbound Service Target Properties

      Property Description

      SMTP Host

      The host name or the IP address of the load balancer or the system used for accessing the SMTP IN service.

      Sender E-Mail

      The e-mail address of a test account used for sending an e-mail and that will be used for the status and the service availability of the SMTP IN service. You can use the orclguest@your_domain account that is created by default in the e-mail system.

      Recipient E-Mail

      The e-mail address of a test account used for receiving an e-mail and that will be used for the status and the service availability of the SMTP IN service. You can use the orclguest@your_domain account that is created by default in the e-mail system.

      Note: Sender E-Mail and Recipient E-Mail can be the same address.


    6. Click OK to create the target.

  3. Follow these same procedures for creating POP, NNTP inbound, and SMTP outbound service targets.

Creating an Oracle WebMail Web Application Target

To monitor your Oracle WebMail instances, create a Web Application target for each Oracle WebMail instance. Web Application targets can be monitored for availability and performance with Application Performance Management transactions. You can also measure the response time of pages in your Web Applications using End-User Performance Monitoring.

Create a Web Application target for your Oracle WebMail instance, as follows:

  1. Using the Grid Control Console, navigate to the Agent home page for the Oracle Management Agent that was installed on the Oracle WebMail host.

  2. In the Monitored Targets section of the page, select Web Application from the Add list.

    Oracle Enterprise Manager 10g displays the Create Web Application Wizard, which guides you through the process of creating the Web Application.

    When prompted for the home page URL, enter the URL for the Oracle WebMail instance. For example:

    http://host1.acme.com:7778/um/traffic_cop
    
    

    Click Help if you need help using the wizard.

  3. Click OK to create the target.

  4. Use the instructions in the online Help to create some representative transactions to measure the availability and performance of the Web Application you just created.

    For example, create a transaction that logs in and reads an e-mail message.


    See Also:

    Oracle Enterprise Manager Advanced Configuration to enable End-User Performance Monitoring for the Web Application using the procedures for earlier versions of the Oracle Application Server


    Note:

    Before you enable End-User Performance Monitoring to monitor your Oracle Collaboration Suite Web Application target, you must apply patch number 3040716 to the Oracle Application Server middle tier instance. You can download this patch from OracleMetaLink:

    http://metalink.oracle.com/


Creating the Oracle Mail Oracle Collaboration Suite Database Target

One information store target must be created for each Oracle Collaboration Suite Database created for Oracle Mail. It is also possible to locate these targets on any host on the network capable of accessing the Oracle Collaboration Suite Database. The benefit of this approach is that the target deployment becomes nonintrusive to the Oracle Mail information stores.

Oracle Enterprise Manager 10g includes one Oracle Mail information store target type. You must add and configure an information store target for each Oracle Collaboration Suite Database in the network that you want to monitor.

Create an Oracle Mail information store target, as follows:

  1. Using the Grid Control Console, navigate to the Agent home page for the Oracle Management Agent that was installed on the Oracle Collaboration Suite Database host, as follows:

    1. Click the Targets tab.

    2. Click the link in the Name column of the Host type.

    3. Click the Targets link.

    4. Click the link in the Name column of the Agent type.

  2. In the Monitored Targets section of the page, select E-Mail Collaboration Suite Database from the Add list and click Go to display the Add E-Mail Collaboration Suite Database page.

    Provide the required information, as described in Table 7-3.

    Table 7-3 E-Mail Collaboration Suite Database Target Properties

    Property Description

    Collaboration Suite Database Connector Descriptor

    The connect descriptor for the Oracle Collaboration Suite Database

    Collaboration Suite Database User

    The e-mail schema username; enter es_mail

    Collaboration Suite Database Password

    The password for the es_mail schema

    Oracle Home

    The ORACLE_HOME for the database

    Number of Samples

    A parameter used to calculate mail delivery times. Enter 10

    Receiving Inbound Server Name

    A parameter used to trace the route of an e-mail. Enter your host name; for example bpo22

    Receiving OCS Server Name

    A parameter used to trace the route of an e-mail. Enter your host name; for example bpo22


  3. Click OK to create the target.

Creating the Oracle Internet Directory Client Target

Oracle Internet Directory client targets are useful to measure responsiveness of Oracle Internet Directory for Oracle Mail. Thus, one such target must be created on each host where an Oracle Mail server runs. The collection of such targets will give a view of Oracle Internet Directory responsiveness across all Oracle Mail hosts.

Create the Oracle Internet Directory client target, as follows:

  1. Using the Grid Control Console, navigate to the Agent home page for the Oracle Management Agent that was installed on the Oracle Internet Directory Client host, as follows:

    1. Click the Targets tab.

    2. Click the link in the Name column of the Host type.

    3. Click the Targets link.

    4. Click the link in the Name column of the Agent type.

  2. In the Monitored Targets section of the page, select OID Client from the Add list and click Go to display the Add OID Client page.

    Provide the required information, as described in Table 7-4.

    Table 7-4 Oracle Internet Directory Client Target Properties

    Property Description

    LDAP Client Oracle home path

    The path of the Oracle home of the LDAP client system. This will be used to invoke the ldapsearch or ldapcompare utility for the computation of the various Oracle Internet Directory Client metrics.

    For example, the ldapsearch or ldapcompare utility exists in the following directory, based on the value you enter in this field:

    LDAP_Client_Oracle_home_path/bin/
    

    LDAP Host

    The host name of the system where the LDAP server is running.

    LDAP Port

    The port where the LDAP server is running.

    LDAP User

    The user name of a test user account that is needed for the ldapsearch or ldapcompare command. It is possible to use the default user set up for Oracle Enterprise Manager 10g monitoring:

    "cn=emd admin,cn=oracle internet directory"
    

    LDAP Password

    The password of the test user account that is needed for the ldapsearch or ldapcompare command. For the Oracle Enterprise Manager 10g monitoring user, the default is welcome.


  3. Click OK to create the target.

Creating the E-mail Group Target

After all the Oracle Mail targets are configured, you can create the e-mail group target, which provides a custom user interface for managing your Oracle Collaboration Suite environment.

The Oracle Collaboration Suite Email group home page contains the alerts table, followed by a table of rows of component targets and columns of key metrics. The server targets listed here can also be remotely started and stopped from this page.

Create the e-mail group target, as follows:

  1. Click the Targets tab in the Grid Control Console.

  2. Click All Targets.

  3. Select Collaboration Suite Component from the Add list and click Go to display the Create Collaboration Suite Component: Component Type page.

  4. Select E-Mail from the list of Oracle Collaboration Suite components and click Continue to display the Create Collaboration Suite Component: Targets page.

  5. Enter a name for the e-mail group in the Name field, such as My Email.

  6. Select the following targets from the Target Type list. Select the target from the Available Targets list and use the Move or Move All arrow to shuttle the target to the Selected Targets list.

    • Host: The host targets where the Oracle Mail servers reside

    • The database and listener targets that support the Oracle Mail servers

    • An E-Mail IMAP Service and E-Mail IMAP Server

    • An E-Mail SMTP Inbound Service and E-Mail SMTP Inbound Server

    • An E-Mail SMTP Outbound Server

    • An E-Mail POP Server

    • An E-Mail NNTP Inbound Server

    • An E-Mail List Server

    • An E-Mail Virus Scrubber

    • An E-Mail Housekeeper

    • An E-Mail Collaboration Suite Database

    • An Oracle Internet Directory Client

    • An E-Mail Web Application

  7. Click OK to create the group target.

  8. Add this group to any existing or future Oracle Collaboration Suite group.

Purging Monitoring Data from the Oracle Collaboration Suite Database

When you monitor your Oracle Mail targets with Oracle Enterprise Manager 10g, the Oracle Management Agent gathers monitoring data about the Oracle Mail targets and uploads them to Oracle Management Service, which loads them into Oracle Management Repository.

However, the Oracle Mail information store itself also gathers monitoring data about your Oracle Mail targets. After you start monitoring your Oracle Mail targets with Oracle Enterprise Manager 10g, the data saved in the Oracle Collaboration Suite Database is redundant with the information available in Oracle Management Repository.


Note:

Purging monitoring data is done automatically by the Housekeeper process when it is configured to run in the Statistics Cleanup operation mode.

Using oesmon and oeschart

oesmon and oeschart are command-line utilities used to collect and view Oracle Mail system statistics for the purposes of monitoring the performance of Oracle Mail.

This section discusses the following topics:

Using oesmon

The oesmon utility obtains raw metric data directly from Oracle Mail server processes and provides a summary of the mail system's statistics. Each statistic is represented by either an ASCII string or a number, rendered in keyword-value pairs.

Table 7-5 lists oesmon syntax options.

Table 7-5 oesmon Syntax Options

Command Description
oesmon

Returns the usage message

oesmon targets

Lists all possible targets for Oracle Mail servers

oesmon names target

Lists all of the metric names for a particular target

oesmon get target metric_name

Returns the statistics


Oracle Mail has nine service types, such as the IMAP service. These services can run on the same host or on separate hosts. One or more instances of a service can be running on a host. The oesmon utility collects statistical information about a service on a host (target). Targets are named as a concatenation of:

host:um_system:service_type

In this example, host is the name of the host where the service is running, and service_type is one of the following types listed in Table 7-6.

Table 7-6 Different Service Types Used in Target Names

service_type Description
gc

Housekeeper

imap

IMAP server

list

List Server

pop

POP server

smtp_in

SMTP process for inbound mail routing

smtp_out

SMTP process for outbound mail routing

nntp_in

NNTP inbound news server

nntp_out

NNTP outbound news server

vs

Virus Scrubber


All statistics and managed objects have names. Names are case-sensitive and contain only alphanumeric characters and the underscore character (_). Statistic names are hierarchical and separated by a period (.). A request for a managed object returns all of the managed objects and statistics beneath it.


See Also:

Appendix H, "Oracle Mail Server Metrics" for a complete list of the available statistics

Consider the following example:

oesmon  get  mycomputer:um_system:pop .um.admin

In this case, two values are returned for the two metric objects in the hierarchy:

  • process identifier

  • date and time the service was started

.um.admin.os_pid = 8239
.um.admin.uptime = Wed Jan 29 14:17:36 2003
.um.admin.log.discard = 0
.um.admin.log.total = 100

In the previous example:

  • .um.admin.log.discard is the number of log messages discarded when high log levels cause log messages to be generated faster than they can be written to disk

  • .um.admin.log.total is the total number of log messages logged by the processes, including the ones that are discarded and written to disk

oesmon  get  mycomputer:um_system:pop  .um.admin.os_pid

Only the process identifier is returned.

.um.admin.os_pid = 8239

See Also:

Appendix H, "Oracle Mail Server Metrics" for more information about server statistics

Using oeschart

Oracle Mail servers track a range of metrics that are periodically stored in a set of mail statistics tables. The oeschart utility generates charts and images that can be used to publish reports and Web pages, providing a company with a graphic picture of the status of the mail system implementation.

This section discusses the following topics:

Setting the Statistics Collection Interval

You can set the frequency by which metrics are sampled and recorded using the oidadmin administration tool provided by Oracle Internet Directory.


Note:

The collection interval parameters are not configurable in Oracle Enterprise Manager 10g.


See Also:

Chapter 4, "Directory Administration Tools" in Oracle Internet Directory Administrator's Guide for information about how to access oidadmin

The orclMailAdminCollectionInterval parameter specifies the number of seconds that elapse between statistics collecting. A setting of zero (0) seconds stops the service from logging statistics altogether.

Set the orclMailAdminCollectionInterval parameter at the target level, rather than the instance level. If you set the value at the instance level, statistics collection occurs at different intervals for each instance of the same type of mail service.

Collecting statistics at the same interval for all server types is not recommended. The collection process utilizes different amounts of resources and collects statistics of varying degrees, depending on which mail service is engaged in collecting the statistics. For example, the Housekeeper process is more resource intensive and collects fewer dynamic statistics than the SMTP server collection process.

The recommended collection intervals for the different types of servers are:

  • Housekeeper: 3600 (one hour)

  • IMAP: 600 (ten minutes)

  • POP: 600 (ten minutes)

  • SMTP_IN: 600 (ten minutes)

  • SMTP_OUT: 600 (ten minutes)

  • List: 600 (ten minutes)

  • NNTP_IN: 600 (ten minutes)

  • NNTP_OUT: 600 (ten minutes)

Cleaning Up Mail Statistics

Perform the following steps to clean up mail statistics through the Housekeeper process:

  1. Using Application Server Control Console for Collaboration Suite, navigate to the Oracle Mail Service Targets page.


    See Also:

    "Oracle Enterprise Manager 10g Application Server Control Console for Collaboration Suite" for information about accessing Application Server Control Console for Collaboration Suite

  2. Click Housekeeper.

  3. Click an instance in the Process Instances section.

  4. Select Statistics Cleanup from the Operation Mode list in the Housekeeping Operations section.

  5. Click Apply.

  6. Return to the Housekeeper page.

  7. Click the name of the instance you selected in Step 3.

  8. In the General Parameters section, enter the number of days you want to retain sample data in the Age Threshold parameter.

  9. Click Apply.

  10. Stop and start the Housekeeper process to apply the changes.

Mail Statistics Schema

Each mail process has a default store database. Processes supporting multiple stores, such as the IMAP server, have a default store that is set in the orclMailAdminStoreDN parameter during the installation of each Oracle Collaboration Suite Applications tier.

Statistical information is stored in tables in the esperftbl tablespace in the default mail store of the process. Because these tables can expand indefinitely, you should monitor the esperftbl tablespace and delete or export data as needed.

The schema consists of the following:

es_perf_process Table

The es_perf_process table is a list of the process instance records. The column process_dn is the complete distinguished name (DN) of the process, found in Oracle Internet Directory. The processes that produce metric data insert records into this table as needed.

Table 7-7 lists values and descriptions for columns contained in the es_perf_process table.

Table 7-7 es_perf_process Table

Column Name Value Description
process_id

Number (nonzero)

An internal assigned unique number for each process

process_dn
Varchar2 (500)

The DN of the process in Oracle Internet Directory


es_perf_metric Table

Table 7-8 lists values and descriptions for columns contained in the es_perf_metric table.

Table 7-8 es_perf_metric Table

Column Name Value Description
metric_id

Number (nonzero)

Internally assigned unique number for each metric

metric_name
Varchar2 (100)

Name of the metric

metric_type

Number (nonzero)

If 1, the metric is numeric

If 2, the metric is a string, and defines which column is important in the es_perf_sample table


es_perf_timestamp Table

The es_perf_timestamp table records each time metric data is stored in the tables. This table, along with the es_perf_data view grows without bound over time. You must clean out historic data that is no longer needed for charting or analysis at the installation. This can be done by configuring the Housekeeper process.

Table 7-9 lists values and descriptions for columns contained in the es_perf_timestamp table.

Table 7-9 es_perf_timestamp Table

Column Name Value Description
timestamp_id

Number

Internally assigned unique number for each time period that a process enters a statistics time stamp

date

Date

Time the data was inserted


es_perf_sample Table

The es_perf_sample table records each metric at each time stamp. This table increases over time, so you must delete data that is no longer required in order to keep the table size manageable.

There are two possible columns that store the sample data, depending upon whether the data is numerical (nvalue) or a string (svalue).

Table 7-10 lists values and descriptions for columns contained in the es_perf_sample table.

Table 7-10 es_perf_sample Table

Column Name Value Description
process_id

Number (nonzero)

Corresponds to the process_id row in es_perf_process

metric_id

Number (nonzero)

Corresponds to the metric_id row in es_perf_metric

timestamp_id

Number (nonzero)

Corresponds to the timestamp_id row in es_perf_timestamp

nvalue

Number

Numeric value of the metric (if the metric is numeric)

svalue
Varchar2 (1000)

String value of the metric (if the metric is a string)


es_perf_data View

es_perf_data is a view of the tables described in this section: es_perf_process, es_perf_metric, es_perf_timestamp, and es_perf_sample.

Table 7-11 lists values and descriptions for columns contained in the es_perf_data view.

Table 7-11 es_perf_data View

Column Name Value Description
process_dn
Varchar2 (500)

The DN of the process in Oracle Internet Directory

metric_name
Varchar22 (100)

Name of the metric

metric_type

Number (nonzero)

If 1, the metric is numeric

If 2, the metric is a string, and defines which column is important in the es_perf_sample table

timestamp

Date

Time the value was sampled

nvalue

Number (nonzero)

Numeric value of the metric (if the metric is numeric)

svalue
Varchar2 (1000)

String value of the metric (if the metric is a string)


Creating Graphs

The oeschart utility creates graphs. The utility requires a single command-line parameter that points to a property file. The property file is a text file with keyword value pairs defining the information the utility needs to generate the graph. A valid property file would have the following mandatory and optional parameters.

Table 7-12 and Table 7-13 describe mandatory entries and optional values, respectively.

Table 7-12 oeschart Mandatory Properties

Parameter Description
server

Host name of the statistics database

port

Database listener port

sid

SID or service name for the server

username

Account user

password

Account password

process_dn

Query used to gather statistics, such as process_dn=%value_in_ini_file%, which retrieves all processes that follow this DN pattern. This lets you graph a specific process, a set of processes, or the entire system by specifying the level of detail.

metric_name

Metric to query

graph_type

Type of graph. Possible graphs are:

  • command_data

  • xy_rate

  • xy_cummulative

  • xy_current

image_file_name

Choose a name for the generated file.

Note: Either .gif or .png will be appended to this file name depending upon which encode_type you choose.

image_title

Title to display on the graph

number_of_hours

Number of hours, going backward in time, starting from the present


Table 7-13 oeschart Optional Properties

Parameter Default Description
encode_type

gif

Possible values are gif and png

image_dir

./

Directory where graphs are stored

aggregate_
time_period

600

Time span in which multiple logging processes are grouped together and the metrics combined to show an aggregate value.

As an example, consider two running IMAP servers, IMAP1and IMAP2. IMAP1 logged its statistics at 3:00 p.m. and IMAP2 logged its statistics at 3:02 p.m. The servers log statistics at intervals specified in seconds using oidadmin relative to when they started; in this case, IMAP2 must have been started 2 minutes after IMAP1.

To show the total number of sockets on the system, combine the values from IMAP1 and IMAP2. aggregate_time_period defines what is an acceptable window for different process statistics to be combined. This should be the same as the submit period specified in oidadmin for this process type.

max_lifetime

300

Number of seconds until the program terminates

show_
statistics
FALSE

Number of data points, minimum, maximum, average, and median, at the bottom of the graph

debug
FALSE

Provides a detailed output of the utility


The following is an example of a property file that informs the oeschart utility to generate an xy graph of the number of concurrent IMAP sockets for all IMAP servers in aggregate over the last 24 hours:

server=testdb.acme.com
sid=test
port=1521
username=schema_owner_username
password=schema_owner_username_password
process_dn=test1:um_system:imap:
graph_type=xy_current
image_dir=full_path_images_directory
number_of_hours=24
encode_type=png
show_statistics=true
aggregate_time_period=600
debug=false
max_lifetime=120

metric_name=.ES_SPS.socket.currload
image_file_name=socketcount
image_title=Socket count on test1

See Also:

Appendix H, "Oracle Mail Server Metrics" for a complete list of metric names

oeschart obtains information from the es_perf schema and generates one of four possible types of charts. Three of these are variations of scatter graphs. The fourth is a bar chart.

By executing oeschart at regular intervals, you are provided with a current view that can be published on a company Web site or within Oracle Enterprise Manager 10g.

For example, you can schedule the creation of graphs that show information such as the number of connected sockets, the login response time, and the number of queued outbound messages, and publish the results in a custom HTML page or in Oracle Enterprise Manager.

Displaying Graphs in Oracle Enterprise Manager

To display graphs in Oracle Enterprise Manager:

  1. Modify the target metadata definition.

    The $ORACLE_HOME/sysman/admin/metadata directory contains a list of target metadata definition files.

    For a particular target definition, add the following elements to the Instance Properties section:

    <!--This property specifies the total number of statistic charts to be displayed -->
          <InstanceProperty NAME="totalNumberOfStats" CREDENTIAL="FALSE"
           OPTIONAL="TRUE">
             <Display>
                <Label NLSID="totalnumberofstats">Total Number of Statistics</Label>
             </Display>
          </InstanceProperty>
    
         <!--This property specifies the header title for the first charting picture-->
          <InstanceProperty NAME="Title0" CREDENTIAL="FALSE"
           OPTIONAL="TRUE">
             <Display>
                <Label NLSID="stat0">Statistic Number 0</Label>
             </Display>
          </InstanceProperty>
    
         <!--This property specifies the tool tips string for the first charting 
    picture, coded to Section 508 standards-->
          <InstanceProperty NAME="ToolTips0" CREDENTIAL="FALSE"
           OPTIONAL="TRUE">
             <Display>
                <Label NLSID="tooltips0">This is tooltips 0 for ADA</Label>
             </Display>
          </InstanceProperty>
    
         <!--This property specifies the relative picture path under the servlet for the first charting picture.-->
          <InstanceProperty NAME="PicPath0" CREDENTIAL="FALSE"
           OPTIONAL="TRUE">
             <Display>
                <Label NLSID="picpath0">Picture Path 0</Label>
             </Display>
          </InstanceProperty>
    
         <!--This property specifies the physical path for the first charting picture. The admin code will test if the file exists according to the path below-->
          <InstanceProperty NAME="PicPhysicalPath0" CREDENTIAL="FALSE"
           OPTIONAL="TRUE">
             <Display>
                <Label NLSID="picphysicalpath0">Picture Physical Path 0</Label>
             </Display>
          </InstanceProperty>
    
    
  2. To increase the number of charts displayed, change the value of the totalNumberOfStats parameter in the targets.xml file accordingly, and the additional picture properties must be defined using the following naming standard:

    Title[N], ToolTips[N], PicPath[N], PicPhysicalPath[N]
    
    

    In this naming standard, N is a nonnegative natural number.

  3. Edit the targets.xml file to specify the property instance values, by adding the following properties to the specific target section in $ORACLE_HOME/sysman/emd/targets.xml file:

    <Property NAME="totalNumberOfStats" VALUE="1"/>
      <Property NAME="ToolTips0" VALUE="My First Statistic Tool Tips"/>
      <Property NAME="PicPhysicalPath0" 
    VALUE="<…>/sysman/webapps/emd/ias/umsg/es/images/pic1.gif"/>
      <Property NAME="PicPath0" VALUE="/emd/ias/umsg/es/images/pic1.gif"/>
      <Property NAME="Title0" VALUE="My First Statistic Header"/>
    
    

    In the preceding example, the ...es/images... portion of the directory does not exist. It must be created or the administrator can choose another directory.

If any of the following situations occur, the charting picture is skipped and not displayed in Oracle Enterprise Manager:

  • totalNumberOfStats is missing, zero, or not a number

  • Title[N] is missing for the particular chart

  • ToolTips[N] is missing for the particular chart

  • PicPath[N] is missing for the particular chart

  • PicPhysicalPath[N] is missing for the particular chart

  • The picture file specified under PicPhysicalPath[N] does not exist