|
|
The uOne Manager is a Web-based CGI program which aids in the centralized management and monitoring of Cisco's distributed uOne application. It provides operational, status, and trending information to the administrator responsible for monitoring overall system functionality and reliability. The program is a software component that assists in reporting, trending, and diagnosing the uOne system.
The uOne Manager application requires Sun Solaris 2.6 operating on the SPARC hardware platform. This system should be outfitted with hard disk space capacity commensurate with the number of distributed host systems employed and the time period for which data and reports will be needed for trending purposes.
Careful consideration should be given to the location of the uOne Manager in the network. Each gateserver in the domain could log up to 240 MB maximum per day to the central server. Therefore, the central logging server should be located as topologically close as possible to the remote gateservers.
 |
Note  All topics covered in the section are configured via the quickconfig tool. |
Set up remote shell and remote copy permissions for spmaster on those gateserver hosts that you have defined to uOne Manager via entries into the oam.ini file in the system section. This is accomplished through the judicious usage of the .rhosts file in the home directory of the spmaster login account on each gateserver. For example, the file /home2/spmaster/.rhosts might look as follows:
This entry allows the spmaster user on the uOne system to perform the needed remote shell (rsh) functions as needed on this system.
Do not remove log files before the Data Extract Director component of uOne Manager can gather a full day of log extract files. LogRemover is the only method available for the systematic removal of excess and unneeded files created by the central logging server or UCM.
A rule is that uOne Manager's HOWMANY_DAYS (see "The oam.ini File") parameter must be configured less than the number of days that the used logfiles get removed (LogRemover.ini). Otherwise reports will show 0s for the first half of the day.
|
Note LogRemover configuration produced by the quickconfig tool will not remove central logging files (netlogs directory). You must manually add rules to LogRemover.ini for this. |
Configure the agents as well as uOne software components properly so that required information will be logged and available for use. The logged information will, in turn, be available to the uOne Manager for trending and reporting purposes.
The destination log files, if activated via configuration parameters, can be logged either to the local gateserver system or to one specifically designated elsewhere in the network. Local logging will write the various uOne and agent log files to $PARMLIB/logs/logfiles. Network logging allows the logs to be written across the network to a system configured as a central logging server. The central logging subsystem LOGSUB, a component of the agent, accomplishes central logging by its facility to be configured to operate as either a client, a server, or both. The LOGSUB program makes this determination as it initializes and obtains the value associated with the LogServer entry in the Attrib.Global file.
To instruct the agent and uOne software to activate resource and event logging and to configure the LOGSUB process properly for local or network logging, two configuration files must be edited as explained in the paragraphs below.
|
Note uOne Manager requires that the DateFormat BASE setting be LONGDATE. Additionally, the LogHeader BASE setting must be set to Yes. |
If you are configuring a gateserver as a single node for all UC processing—including uOne Manager (perhaps for training or demo purposes)—then you should add the following element to the $PARMLIB/parms/BASE/Attrib.Global configuration file.
DestBillResource LOCAL # Capture alloc/freeing SP resources details locally DestEvent LOCAL # Destination of customer event detail is local LogServer No # This system is not a server - perform local logging only
When coded as LOCAL, the associated log files are captured locally to the directory $PARMLIB/logs/logfiles.
The vast majority of deployments of gateservers require multiple systems to service the uOne user base. When this is the case, remote logging must be configured in order for the uOne Manager software to function in the consolidated management and reporting of activity within the domain.
The LOGSUB program is the central logging application for all UC software. Enhancements enable LOGSUB processes operating across all the gateserver hosts in a domain to work together to write Resource and Event log files and their contents in a near real-time manner. The destination "central" LOGSUB process operates on a designated gateserver host in the network. It is on this server that the uOne Manager software will reside. uOne Manager reporting functionality depends upon access to Resource and Event logs created by all the systems in a gateserver domain.
Since most gateservers are configured as LOGSUB clients, the administrator will have already determined the gateserver(s) designated as the LOGSUB server(s) of the domain. As such, to define to the client the specific system running the properly configured LOGSUB server, set the LogServer entry in the $PARMLIB/parms/BASE/Attrib.Global file to:
LogServer <serverhostname> # This GateServer's LOGSUB is a client logging to that server
Whether a gateserver has its LOGSUB process configured as a client, server, or both, log files are kept locally in the $PARMLIB/logs/logfiles directory. If it is configured as a server, then it monitors a TCP/IP socket for other client LOGSUB processes wishing to pass their log files to it. When it receives a log message, it inserts it into either the active Network Resource (.NetRes) or Network Event (.NetEve) file under the $PARMLIB/logs/netlogs directory on the LOGSUB server. Log records from all gateserver systems are co-mingled into these files.
On the LOGSUB client machine, a special file is placed in the $PARMLIB/logs/netlogs. This file is named LOG.Network.Data and contains special controlling information for synchronization between the client and the server. If either the client, server, or both are down, this file and the LOG.Network.Data file and associated structure are used by LOGSUB to recover and continue logging without loss (or duplication) of log records. This file should never be deleted or manipulated manually in any way.
If logging is to occur and be sent to a central logging server system, then make these configuration changes to the following elements in the $PARMLIB/parms/BASE/Attrib.Global configuration file:
DestBillResource LOCAL_NET # Capture alloc/freeing DAP Resources to Network Server DestEvent LOCAL_NET # Destination of customer event detail is Network Server LogServer <UCMServer> # This system logs to the Network Central Logging Server
When configured as LOCAL_NET, the associated log files are captured locally and transmitted across the network to the designated central logging server system. Log files are always written locally even when network logging is activated. The logging server parameter designates the name of a system in the domain configured as the central logging server.
|
Note Central LOGSUB logging uses TCP/IP port number 6001. If an X windows X server (display) is running on the LOGSUB Server, then you must first stop this X server in order to run LOGSUB. |
The following configuration of the UM.ini and FaxPrint.ini files is optional. These are controlling files for the uOne application and can be configured to instruct the application to write session-trace information into the log files as follows:
InformationalLogging=On
Changes to the Attrib.Global and the UM.ini files cause a gateserver to write the resource and event log files to the local disk drive in the $PARMLIB/logs/logfiles directory and to the $PARMLIB/logs/netlogs directory on the central logging server as appropriate. If all the desired logging is local, then the oam.ini file can be modified to instruct the UCM software to find the log files in the local directory.
At least one gateserver in the domain needs to be designated as the uOne Manager. The uOne Manager can also be, if desired, a fully functional gateserver system. Or, it may just have the minimal subset of gateserver DAP components installed for more efficiency (i.e., it may or may not need to run the TNTOBJECT and the uOne application). Again, the LOGSUB program is defined as a client or server through the log server parameter in the $PARMLIB/parms/BASE/Attrib.Global file. If the parameter is set as follows:
LogServer Yes # Make this system as server for all others that wish to log here
then this system acts as a server and LOGSUB accepts log files directed to it from other LOGSUB processes in the domain writing their log records into files within the directory $PARMLIB/logs/netlogs. It will, under this configuration, act as a client as well, supporting any logging activity required by other DAP components or application software running on the local system.
Ideally, only one gateserver system per domain should be configured as a LOGSUB server. However, any LOGSUB on any gateserver can be configured to function as a server, even if others are already providing the server function. Determining how many uOne Manager and central logging servers to configure is influenced by the scale of the operation and is left to the discretion of the administrator or uOne network designer.
Comma-separated value (csv) files can be readily downloaded and imported into popular desktop software packages for analysis. The capability to download comma-separated value (csv) files directly to the client (browser) system is provided by the uOne Manager software. Where it is possible to download data files for further analysis by an administrator, a DOWNLOAD button is provided. These buttons appear on selected UM Reports HTML pages.
The download functionality is provided via anonymous ftp. In order for anonymous ftp to function on a UNIX server, it must be provisioned. This involves the addition of information to key UNIX OS files. These additions are discussed below.
As root, add the following line to the end of the /etc/passwd file.
ftp:x:30000:30000:Anonymous FTP:/home2/spmaster/ADMIN/htdocs/download:/nosuchshell
As root, add the following line to the end of the /etc/shadow file.
ftp:NP:6445::::::
|
Note When editing the oam.ini file, be sure to use tabs instead of space for indentation and do not embed comments in the same line where variables are defined. These precautions prevent problems such as items being ignored. |
The oam.ini file is the repository for variable, parameter, and other uOne Manager control information. This information governs the operation of the uOne Manager software components. It also provides some freedom in terms of where the software expects to find its key components and allows the user to control the scope and actions of the uOne Manager. There are 4 categories of sections (Environment, Systems, Reports, and Operations) and currently six defined sections with these categories (websetup, system, hosts, UM_Application_Summary, Event_Log, and Community_String).
The websetup section specifies the fundamental path and environment variable setup.
oam.ini file is 0.25.
[websetup]
## Environment variable setup for OAM website
## Note: No space before and after '=' sign
## No comments on the same line where variables are
## defined
## For ex: HOMEDIR=/home2/spmaster ## homedir
## is not allowed
## The webserver has to run as this user, otherwise permission
## problems will be there
HOMEDIR=/home2/spmaster
HOME=/home2/spmaster
WEB_PATH=/home2/spmaster/ummgr/Web
WEB_SCRIPTS=/home2/spmaster/ummgr/Scripts
WEB_HTML=/home2/spmaster/ADMIN/htdocs/UMMgrWeb
WEB_CGI=/home2/spmaster/ADMIN/cgi-bin
WEB_LOGS=/home2/spmaster/ummgr/UMMgrLogs
WEB_REPORTS=/home2/spmaster/ummgr/CSVFiles
#date_min number of days back in drop down lists
DATE_MIN=15
#login timeout in days ex: 0.007 days = 10 mins, 0.25 days = 6 hrs
#default value is 6 Hours
TIME_OUT=0.25
#For DataExtractor,
HOWMANY_DAYS=2
System parameter entries contain the following information: category:type:name.
[system]
## Host:Tag
Host:HM:hostname1
Host:UNIX:hostname1
Host:APP:hostname1
Host:HM:hostname2
Host:UNIX:hostname2
Host:APP:hostname2
HostGroup:APP:allhosts=hostname1|hostname2
COI:APP:ou=Community1,o=Organization
COI:APP:ou=Community2,o=Organization
COIgroup:APP:allcois=ou=Community1,o=Organization|ou=Community2,o=Organization
This section instructs DataExtractorDirector in generating the .csv files. The entries contain the following information: name|tag|type|logfile path|logfiles.
[hosts] hostname1|APP|UMAPPSUM|/home2/spmaster/r410/logs/netlogs|*NetRes hostname1|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve hostname2|APP|UMAPPSUM|/home2/spmaster/r410/logs/netlogs|*NetRes hostname2|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve ou=Community1,o=Organization|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve ou=Community2,o=Organization|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve
This section contains parameters for creating application summary .csv files. Tag and type are used in connection with the contents in the Hosts section.
[UM_Application_Summary]
tag=APP
type=UMAPPSUM
This section contains parameters for creating application event .csv files. Tag and type attributes are used in connection with the contents in the Hosts section. Pattern is used to pattern match the types of events to extract from the log files.
[Event_Log]
tag=APP
type=APPEVE
pattern=Subscriber|PA|Caller|FaxPrint|SNR|MWI|TTS|H323
## Operations
This section contains the permissions for the SNMP agent to query a host's status and statistical information. Tag is APP to indicate an application.
[community_String]
tag=APP
communityString:hostname1:public:public
communityString:*:public:public
Log file contents can (and often do) change from release to release. When this happens, a report may not recognize the change, which would in turn cause inaccuracies in reporting. The purpose of versioning is to manage the usage of the uOne Manager software with previous releases of various uOne software components and their log files/records in order to isolate the format of the log files from that version.
To activate DataExtractDirector.pl, the version.ini file must exist in the $HOME/ummgr/Scripts/Extractor directory. The DataExtractDirector.pl reads in this version.ini file to identify the software version installed on the various remote systems and then executes the appropriate script to process the logs. You must copy up from Samples on first time installation.
If there is no entry found in the version.ini file, then a default script of <reportname>_csv.pl is executed to create the extract file. If this script is not found, then the Data Extract Director logs this as an error and no extract file is created.
This section is used for the application summary reports. The entries contain the following information: script name:package name:package version.
[UMAPPSUM]
UM_Application_Summary_csv_417.pl:uoneapp:4.1.0,REV=7
UM_Application_Summary_csv.418.pl:uoneapp:4.1.0,REV=8
UM_Application_Summary_csv.419.pl:uoneapp:4.1.0,REV=9
UM_Application_Summary_csv.pl:uoneapp:4.1.0,REV=10
This section is used for the application event reports. The entries contain the following information: script name:package name:package version.
[APPEVE]
Event_Log_csv4109.pl:uoneapp:4.1.0,REV=9
Event_Log_csv.pl:uoneapp:4.1.0,REV=10
The sample results below are based on a Sun Ultra E450 with 256 MB RAM.
A worst case DataExtractDirector collection period for a 24-hour loaded system with no call-inactivity time is approximately 45 MINUTES. The time doubles if two systems with the same criteria are "datacollected." The formula is approximately:
DataCollector Time to process 550 MB logfiles is approximately 1 HOUR.
|
Note Run DataExtractDirector sparingly to prevent the system from degrading very quickly. Remember that the HOWMANY_DAYS parameter comes into effect here, as it will tell DataCollector how many days back to go reprocess. |
The factor in determining how long DataExtractDirector will take is the total number of hosts to collect data for, the "how many" parameter, and the size of the logs to process.
WebDirector—A worst case single report for a 24-hour loaded system with no call-inactivity time will take approximately 45 SECONDS. This time starts the instant the Generate Report or Download CSV is selected. If two hosts are selected with this criteria then it would take 90 seconds. The uOne Summary Report is the only instantaneous report because it is already processed.
This parameter ensures menu selections have consistent times in date pull-downs. It is advisable (though not required) that date and time are synchronized between the uOne Manager server and the uOne hosts it manages. NTP is a network time protocol that should be used for this purpose since the uOne Manager is now operating as part of the underlying architecture.
## Filename: oam.ini
##
## Each sysfile name must be listed as '[sysfile]'
## Its contents must start with a 'tab'
[websetup]
## Environment variable setup for OAM website
## Note: No space before and after '=' sign
## No comments on the same line where variables are
## defined
## For ex: HOMEDIR=/home2/spmaster ## homedir
## is not allowed
## The webserver has to run as this user, otherwise permission
## problems will be there
HOMEDIR=/home2/spmaster
HOME=/home2/spmaster
WEB_PATH=/home2/spmaster/ummgr/Web
WEB_SCRIPTS=/home2/spmaster/ummgr/Scripts
WEB_HTML=/home2/spmaster/ADMIN/htdocs/UMMgrWeb
WEB_CGI=/home2/spmaster/ADMIN/cgi-bin
WEB_LOGS=/home2/spmaster/ummgr/UMMgrLogs
WEB_REPORTS=/home2/spmaster/ummgr/CSVFiles
#date_min number of days back in drop down lists
DATE_MIN=15
#login timeout in days ex: 0.007 days = 10 mins, 0.25 days = 6 hrs
#default value is 6 Hours
TIME_OUT=0.25
#For DataExtractor,
HOWMANY_DAYS=2
[system]
## Host:Tag
Host:HM:hostname1
Host:UNIX:hostname1
Host:APP:hostname1
Host:HM:hostname2
Host:UNIX:hostname2
Host:APP:hostname2
HostGroup:APP:allhosts=hostname1|hostname2
COI:APP:ou=Community1,o=Organization
COI:APP:ou=Community2,o=Organization
COIgroup:APP:allcois=ou=Community1,o=Organization|ou=Community2,o=Organization
## Note: The Host should be either ipaddress or system name
## in both [system] and [hosts] sections
[hosts]
hostname1|APP|UMAPPSUM|/home2/spmaster/r410/logs/netlogs|*NetRes
hostname1|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve
hostname2|APP|UMAPPSUM|/home2/spmaster/r410/logs/netlogs|*NetRes
hostname2|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve
ou=Community1,o=Organization|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve
ou=Community2,o=Organization|APP|APPEVE|/home2/spmaster/r410/logs/netlogs|*NetEve
## Reports
[UM_Application_Summary]
tag=APP
type=UMAPPSUM
[Event_Log]
tag=APP
type=APPEVE
pattern=Subscriber|PA|Caller|FaxPrint|SNR|MWI|TTS|H323
## Operations
[community_String]
tag=APP
communityString:hostname1:public:public
communityString:*:public:public
##
## File Name: version.ini
##
## @(#)version.ini 120.1.1.1
##
## Each section is identified by the report type
## Entries under each section will have three fields
## separated by ':'. The fields are:
## 1 - Script Name
## 2 - Parameter to pkginfo ex: pkginfo -x field2
## 3 - Output returned from pkginfo on the 2nd line 2nd word
## Note: Entries under each section must start with a 'tab'
## default scriptName would be "<reportName>_csv.awk"
[UMAPPSUM]
UM_Application_Summary_csv_417.pl:uoneapp:4.1.0,REV=7
UM_Application_Summary_csv.418.pl:uoneapp:4.1.0,REV=8
UM_Application_Summary_csv.419.pl:uoneapp:4.1.0,REV=9
UM_Application_Summary_csv.pl:uoneapp:4.1.0,REV=10
[APPEVE]
Event_Log_csv4109.pl:uoneapp:4.1.0,REV=9
Event_Log_csv.pl:uoneapp:4.1.0,REV=10
Posted: Mon Sep 25 20:22:21 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.