KB 085 – SAP PowerConnect Java installation instructions v1.2

SAP PowerConnect Java Installation Instructions

Introduction

This document details the installation instructions for the SAP PowerConnect Java monitoring agent.

Prerequisites

SAP PowerConnect Java has the following requirements:

  • SAP NetWeaver 7.3 and above
  • 100 MB free disk space
  • Administrator access to the SAP NetWeaver system

Installation

The installation has the following high level steps:

  1. Installation of the software
    1. Sap PowerConnect Java monitoring agent
    2. Sap PowerConnect configuration GUI
  2. Configuration of Splunk
  3. Initialization of database table to store configuration
  4. Granting JMX security permissions
  5. Configuration of Sap PowerConnect Agent

Installing the Sap PowerConnect Java monitoring agent

To install the Sap PowerConnect Java monitoring agent perform the following steps:

  1. Acquire the PowerConnect agent from file from sap-powerconnect-java-X.X.sca BNW
    Consulting
  2. Deploy the .SCA using SAP Software Update Manager (SUM)and ensure its listening
    on port 1129

Open a browser and connect to theJava SUM control page
https://<host>:1129/lmsl/sumjava/P75/index.html

Enter <sid>adm credentials

SAP PowerConnect Java installation instructions v1.1

Point SUM to the directory containing the PowerConnect for Java code

Enter J2EE administrator credentials

3. Once deployed the application should be visible in the SAP Netweaver console:
http://<host>:5###00/nwa

Search for bbramley

And start the service

Configuration of Splunk

The SAP PowerConnect monitoring agent sends its metrics and events to Splunk using the
Splunk HTTP Event Collector.

To configure the Splunk HTTP Event Collector (HEC) follow the documentation on the Splunk
website here:

http://docs.splunk.com/Documentation/SplunkCloud/6.6.0/Data/UsetheHTTPEventCollector

This should result in creating a HEC token for the SAP PowerConnect monitoring agent to
use in the next section.

Granting JMX security permissions to the Sap PowerConnect Agent (NetWeaver 7.5)

If you are using NetWeaver 7.5 the Guest user account needs to have read permissions to JMX in order to consume metrics from SAP specific JMX beans.

To do this use the User Management section in the SAP Netweaver UI:

In the Search Criteria dropdown choose Role then enter Guest and click Go:

Click on the Guest user in the table and click on the Assigned Actions tab:

Click Modify and in the Get text box enter “JmxManageAll” then click Go.

Select the JmxManageAll action at the top of the table and click Add, then Save.

Create JMXManageAll role

1. Create a role called JMXManageAll

2. Add all the actions under jmxmanageall that you can find

3. Click Save

Create User


Make it a technical user *important*

Add the following 5 roles to the user

  • SAP_XI_API_DEVELOP_J2EE (PI only)
  • SAP_XI_API_DISPLAY_J2EE (PI only)
  • NWA_READONLY (all)
  • SAP_XI_MONITOR_J2EE (PI only)
  • JmxManageAll

Configuration of Sap PowerConnect Agent

The final step is to use the Sap PowerConnect UI to configure the agent.

The URL to view the UI is:

http://<server>:<port>/webdynpro/resources/com.powerconnect5/spcj_wd/SapPowerCon nectJava

The UI should look like this:

If you get ERROR returned check that the Java services are running

1. Restart the application

General Tab

The configuration under the General tab can normally be left as default options.

Splunk Tab

Click the Splunk tab and configure the Splunk HEC details:

Configuration KeyDescription
Splunk HEC KeyThe token that you generated when configuring Splunk
Splunk HEC URLThe host and port of where the Splunk HEC is listening e.g. http://localhost:8088/
Splunk IndexThe name of the index where you would like to store the SAP PowerConnect monitoring data
Splunk SourcetypeThe name you would like give to identify the SAP PowerConnect monitoring events (should usually be left as default)

Click the Save button.

Click the JMX tab to pick the events you would like to collect from the SAP Netweaver system. By default the java.lang domain beans are collected.

Once configured events should start to appear in the JVM tab of the SAP PowerConnect for
Splunk app:
JMX Tab
Here you can define the JMX beans you want to monitor, search for an select the bean in the top table,


and then use the down triangle to move it to the list of Enabled Mbeans

JMX Tab

To enable monitoring ofa specific JMX object simply search for the object and once you have it in the top table, click on the down triangle to move it to the list of monitored jmx objects and click save.

PI Monitoring Tab

To monitor a specific PI channel in the PI monitoring tab you can enter the following information

direction – “OUTBOUND,”INBOUND” or leave as NOT_CONFIGURED to monitor both directions
onlyFaultyMessages – <leave cleared>
recieverName – Enter the receiver name, or leave NOT_CONFIGURED to monitor all receivers
recieverParty – Enter the receiver party name, or leave NOT_CONFIGURED to monitor all receivers
senderName – Enter the sender name, or leave NOT_CONFIGURED to monitor all senders
senderParty – Enter the sender party name, or leave NOT_CONFIGURED to monitor all senders
status – Can be one of the following values “success”, “toBeDelivered”, “waiting”, “holding”, “delivering”, “systemError”, “canceled”, or leave NOT_CONFIGURED to monitor all statuses
messageType – Enter the message type name, or leave NOT_CONFIGURED to monitor all senders

Use the simple monitor for specifying a single filter (1 only). NOT_CONFIGURED means no filter and equals ‘*’ or match anything. The below filter matches all messages, as there is no filter. Enter a matching string for filtering by one of the below fields, wildcards are supported i.e. ReceiverName = “testReceiver*”.

Use the advanced filter for multiple filters.

The default format is below. For a single filter
<?xml version=”1.0″ encoding=”UTF-8″?> <PIFilters>
<PIFilter>
<direction></direction>
<interfacename></interfacename> <namespace></namespace> <messagetype></messagetype> <onlyfaultymessages>false</onlyfaultymessages> <receivername></receivername> <receiverparty></receiverparty> <sendername></sendername> <senderparty></senderparty>
<status></status>
</PIFilter>
</PIFilters>

For multiple filters you can repeat the <PIFilter> section multiple times.
<?xml version=”1.0″ <PIFilters>
encoding=”UTF-8″?>
<PIFilter> <direction></direction>
<interfacename></interfacename> <namespace></namespace> <messagetype>messageType</messagetype> <onlyfaultymessages>false</onlyfaultymessages> <receivername>receiverName</receivername> <receiverparty>receiverParty</receiverparty> <sendername>senderName</sendername> <senderparty>senderParty</senderparty> <status>statusText</status>
</PIFilter> <PIFilter>
<direction></direction> <interfacename></interfacename> <namespace></namespace> <messagetype></messagetype> <onlyfaultymessages>false</onlyfaultymessages> <receivername></receivername> <receiverparty></receiverparty> <sendername></sendername> <senderparty></senderparty>
<status></status> </PIFilter>
</PIFilters>

Edit this filter, and save it in a document as an .xml file and then upload it, once uploaded it will look like the screen capture below. Click on Choose File -> select the file -> click Import

Filters are inclusive – you can include anything in the filter, but you can not set a filter to exclude anything.

The configuration tab allows you to specify
Collect message logs – Collects the PI/PO processing logs connected to each message
Collect message payload – Collects the PI/PO message payload
Max number of messages per minutes – Maximum number of messages per server nodes (there may be more than 1 server node per SAP instance. If you have 2 instances, with 2 server nodes each, then this is 100 messages / min / node which in this case is 2 x 2 x 100 = 200 messages per minute.

Log Monitoring
This tab allows you to enable SAP Java log monitoring for
Portal Activity – This allows you to read and ingest the Portal Activity data which feeds the portal Page Hits/ and Page response time dashboards
Default Trace – This ingests the SAP Java defaultTrace logs
Application Trace – This ingests the SAP Java defaultTrace logs

These logs are read and any changes to these files (similar to a unix tail command) are identified and sent to Splunk.

The input for these is variable, these is generally no need to adjust these.
Log File Directory – The directory the log file is written to by SAP
Log Filename Filter – The filename mask for the log file written to by SAP
Log File Header – These are the headers to assign the columns that are contained in the
logfile. These are pre-mapped but you can change them, they are comma delimited, and are
mapped to the fields in the file in the sequence they appear in this field.

Portal Activity: TimeRequest,LoggedOnUser HASH,iView PCD HASH,Header of Request HSSH,HURL Query String HASH,Time to Process Request,ServerNode,TimeToProcessRequest,HTTPSessionID,NavigationPath,ObjectType,ServerHost,Un iqueID,URLQueryString

Default Trace:
Unknown1,Time,Timezone,Severity,SourceName,Unknown2,CSNComponent,DCComponent,Unknown3,Correla tionID,Application,Location,User,Session,Transaction,DSRRootContextID,DSRTransaction,DSRConne ction,DSRCounter,ThreadName,Unknown4,Unknown5,Text

Application Trace:
Unknown1,Time,Timezone,Severity,SourceName,Unknown2,CSNComponent,DCComponent,Unknown3,Correla tionID,Application,Location,User,Session,Transaction,DSRRootContextID,DSRTransaction,DSRConne ction,DSRCounter,ThreadName,Unknown4,Unknown5,Text

Admin Tab

This tab shows the license key, license validity volume of data sent to Splunk today. The 3 test buttons should be used to confirm these 3 functions can be successfully executed.

JMX – Checks that the user specified in the General tab has the necessary permissions to read the JMX data.
Splunk – Checks and confirms connectivity from SAP Java to Splunk.
PI – Checks that the user specified in the General tab has the necessary permissions to read the JMX data from the J2EE engine.

The Show Log button will display the powerconnect log which is written to the same directory as the defaultTrace/applicationTrace directory, and there is 1 log per server node.

Download PDF version here