Note: The recommended procedure to install and customize the EPAgent is to use the setup wizard provided in Solution Manager Diagnostics. If you do not have Solution Manager Diagnostics available follow the manual procedure described below.
The “Environment Performance Agent” (EPAgent) is used to collect performance metrics from different sources that do not require bytecode instrumentation. The agent runs as a stand-alone Java process which requires at least a Java 1.4 VM. SAP currently provides plugins to monitor the operating system based on saposcol, monitor GC data in detail, and to collect TREX performance data. The setup procedure includes the following steps:
• Customize the EPAgent connection parameters
• Select plugins that should be activated
• Customize the individual plugins
• Launch the agent and check proper operation
Extract the Files
Extract the files from the archive ISEPA71.SAR with the command below. All extracted files will go to a subdirectory epagent. The recommended location for extracting the files is the directory /usr/sap/ccms, such that all files will go to directory /usr/sap/ccms/epagent. sapcar –xvf ISEPA71.SAR
Configure the EPAgent
Configuration of the Epagent is done via the configuration file
IntroscopeEPAgent.properties in the subdirectory config. All of the configuration steps in this section apply to this file, unless stated otherwise.
Customize Connection Properties
At the bottom of the configuration file, set the two connection properties for the Enterprise Manager connection to the same values that you used for the “normal” agents in Chapter 4.
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=emhost introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=6001
Select Plugins to Run
Plugins are activated by listing their names in one of the two properties below. By default, SAPOSCOL and SAP_GC are active. Make sure you list the plugins in the correct category (stateful or stateless).
introscope.epagent.plugins.stateful.names=SAPOSCOL,SAP_GC introscope.epagent.plugins.stateless.names=
Customize the Plugin SAPOSCOL
The SAPOSCOL plugin periodically polls performance data from the saposcol process. To allow communication to saposcol, the plugin needs the path to saposcol. Either pass it as parameter to the plugin class, as below, or include saposcol in the PATH for the user that runs the EPAgent.
introscope.epagent.stateful.SAPOSCOL.class=com.sap.sup.wily.epa.oscol.OsCol ControllerXml /usr/sap/SID/SYS/exe/run/saposcol
The plugin is calling saposcol with the path you specify above to retrieve monitoring data, so the user running the EPAgent needs permission to execute saposcol.
Additional info on saposcol can be found on the Service Marketplace:
http://service.sap.com/monitoring -> System Monitoring and Alert Management -> Media Library -> Documentation -> SAPOSCOL: Properties, Installation, and Operation.
Customize the Plugin SAP_GC
The SAP_GC plugin monitors log files from J2EE nodes and periodically reports data about garbage collection activity. The plugin is controlled via a separate configuration file SapGcScanner.properties, located in the subdirectory epaplugins/sap.
For SAP J2EE 6.40 and 7.00, monitoring of the files std_servern.out is recommended and supported. For each monitored file, one line must be added to the
SapGcScanner.properties file in the following format: file.<agentname>=<full path to file>.
Agentname should be the name of the Introscope agent that monitors the J2EE node whose log file you want to monitor. The data will appear in two locations then: hostname|SAP EPAgent|SAP GC|agentname and hostname|SAP Netweaver|agentname|SAP GC. Example:
file.P40_server0=C:/usr/sap/P40/JC00/work/std_server0.out file.P40_server1=C:/usr/sap/P40/JC00/work/std_server1.out
Customize the Plugin SAP_TREX
The SAP_TREX plugin can retrieve performance counters from TREX servers. It needs two support files to be copied from epaplugins/sap to the TREX installation:
Windows:
Copy python_epa.bat to C:/usr/sap/SID/TRXxx/python_epa.bat; adapt the paths in this file.
Copy serviceLoad.py to C:/usr/sap/SID/TRXxx/exe/python_support and
C:/usr/sap/SID/SYS/exe/nuc/NTI386/python_support (backup the old files before). After copying the files, adapt the path to the python_epa.bat script in the agent config file: introscope.epagent.stateless.SAP_TREX.command=C:/usr/sap/SID/TRXxx/python_e pa.bat
Unix:
Copy python_epa.sh to /usr/sap/SID/TRXxx/python_epa.sh; adapt the paths in this file.
Copy serviceLoad.py to /usr/sap/SID/TRXxx/exe/python_support and
/usr/sap/SID/SYS/exe/nuc/NTI386/python_support (backup the old files before). After copying the files, adapt the path to the python_epa.sh script in the agent config file: introscope.epagent.stateless.SAP_TREX.command=/usr/sap/SID/TRXxx/python_epa .sh
Note that this plugin is not active by default. You have to add it to the stateless plugin list (see above).
Customize the Plugins for Windows Performance Counters
There are currently three plugins to collect Windows performance counters with Introscope:
Plugin Name Monitored Component
SAP_WMI_MSS MS SQL Server
SAP_WMI_DOTNET Dot Net
SAP_WMI_IIS IIS
Activate the plugins by listing them in the stateless category.
Run the EPAgent
Running the EPAgent on Windows
On Windows the EPAgent should be run as service. To create the service, start the script RegisterEPAService.bat. After creation, start the service via the services MMC plugin. If you do not have a java.exe (at least java 1.4) in your PATH, edit the property
Running the EPAgent on Unix
Use the supplied shell script epagent.sh to launch the agent in nohup mode: nohup ./epagent.sh &
You may have to adapt the path to a java 1.4 VM in the shell script before.
Check Proper Operation
If your setup was successful, the Investigator view of the Workstation should look similar to the screenshot below.