sap event stream processor: cockpit guide · pdf file5.4 project administration.....124 adding...

PUBLIC

SAP Event Stream Processor 5.1 SP 10Document Version: 1.0 – 2015-06-24

SAP Event Stream Processor: Cockpit Guide

Content

1 SAP Event Stream Processor Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.1 User Interface Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.2 Common Display Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.3 Keyboard Shortcuts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.4 Displaying the Versions of the SAP ESP Cockpit Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.5 Style and Syntax Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111.6 SAP ESP Cockpit Accessibility Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2 Get Started with SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.1 Start and Stop the SAP ESP Cockpit Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Starting and Stopping the SAP ESP Cockpit Server in Windows. . . . . . . . . . . . . . . . . . . . . . . . . 14Starting and Stopping the SAP ESP Cockpit Server in UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Configuring SAP ESP Cockpit Server as a Windows Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Configuring SAP ESP Cockpit Server as a UNIX Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18cockpit Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

2.2 Logging in to SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232.3 Logging Out of the SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.4 Viewing Overview Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.5 Node Statistics Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.6 Clustering Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

3 Configure SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293.1 Registering and Authenticating an SAP Cockpit Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Parameters Required for Starting a Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313.2 Configuring the E-mail Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.3 Configuring Retrieval Thresholds for SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333.4 Configuring the Automatic Logout Timer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.5 Changing the Screen Refresh Interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .343.6 Collection Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Executing and Stopping a Collection Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Resuming and Suspending a Collection Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Viewing Collection Job Schedule Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Viewing the Job Execution History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

3.7 Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Scheduling Backups of the Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39Suspending or Resuming a Scheduled Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Modifying the Backup Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

2P U B L I C© 2015 SAP SE or an SAP affiliate company. All rights reserved.

SAP Event Stream Processor: Cockpit GuideContent

Forcing an Immediate Backup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Restoring the Repository from Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42Configuring Repository Purging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

3.8 Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Log Files for Event Stream Processor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Viewing SAP ESP Cockpit Server Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48Viewing the SAP ESP Cockpit Client Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Changing the SAP ESP Cockpit Logging Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Changing SAP ESP Cockpit Logging Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

3.9 Shared-Disk Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Enabling and Disabling Shared-Disk Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Deploying an Instance from a Shared Disk Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54instance Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Starting and Stopping an Instance in Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Starting and Stopping an Instance in UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Refreshing or Converting an Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Removing an Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

3.10 Configuring Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653.11 Configuring Memory Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Changing a Memory Option on the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Changing a Memory Option for an SAP ESP Cockpit Windows Service. . . . . . . . . . . . . . . . . . . . 69Changing a Memory Option for an SAP ESP Cockpit UNIX Service. . . . . . . . . . . . . . . . . . . . . . . 70

3.12 SAP ESP Cockpit User Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Disabling and Enabling a User in SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71Deleting a User in SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Defining an E-mail Address in SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Updating User Information in SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

3.13 SAP ESP Cockpit Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Console Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

3.14 Changing the UAFADMIN or SCCADMIN Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Encrypting a Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

4 Monitor SAP Event Stream Processor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804.1 Viewing Overview Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .804.2 Viewing Cluster Overview Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824.3 Viewing All Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .844.4 Viewing Project Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854.5 Viewing Stream Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864.6 Viewing Connections Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874.7 Viewing Adapter Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .884.8 Viewing Publisher Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904.9 Viewing Subscriber Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91


P U B L I C© 2015 SAP SE or an SAP affiliate company. All rights reserved. 3

4.10 Viewing Bindings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

5 Administering SAP Event Stream Processor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945.1 Cluster Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Enabling External User-Defined Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Configuring Sandboxing for an Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Add an Authentication Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Configuring Macros. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Configuring System Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Configuring Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Configuring High Availability Project Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Configuring Project Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Configuring Cluster-Managed Adapter Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114Configuring Key Store Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Configuring Compiler Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116Configuring Discovery Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

5.2 Node Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Creating a Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Starting and Stopping a Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Configuring a Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Configuring a Multinode Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

5.3 Workspace Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Adding a Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123Removing a Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

5.4 Project Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124Adding a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125Removing a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Starting and Stopping a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

5.5 Adapter Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Starting and Stopping an Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Viewing File Activity for the SAP IQ Output Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5.6 Graphing Performance Counters: The Statistics Chart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1295.7 Event Stream Processor Data Collections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Key Performance Indicators for Event Stream Processor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325.8 Alerts in SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

SAP ESP Cockpit Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Monitor and Resolve Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Setting Alert Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143Managing Alert Notification Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Adjusting the Monitoring Interval of a KPA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Configuring Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147



6 Troubleshooting SAP ESP Cockpit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486.1 Browser Refresh (F5) Causes Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486.2 Out of Memory Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486.3 Cockpit Fails to Start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496.4 Data Collections Fail to Complete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496.5 Fatal Error #2035 Prevents Successful Log in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506.6 Performance Statistics Do Not Cover Enough Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506.7 Cannot Display the Online Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506.8 Statistics Do Not Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516.9 Troubleshooting Tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1526.10 Technical User is Not Defined. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1526.11 No Systems are Displayed on the Login Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153



1 SAP Event Stream Processor Cockpit

SAP® ESP Cockpit is a Web-based tool for managing and monitoring ESP cluster nodes, projects, adapters, and other components.

SAP ESP Cockpit provides overview and detailed information on overall system health statistics for the nodes within a specific cluster. In addition to statistics, SAP ESP Cockpit lets you configure alerts for the key performance areas of availability, performance, and capacity. Configure the alerts, and their thresholds, to provide you up-to-date, relevant information about the overall health of your system.

Use SAP ESP Cockpit to track a variety of performance metrics, gathering statistics that over time will give you powerful insight into patterns of use. You can display collected data as tables and graphs. By plotting results over any period of time you choose, from a minute to a year, you can both see the big picture and focus on the particulars. Detailed knowledge of how your Event Stream Processor environment has performed in the past helps you ensure that Event Stream Processor meets your needs in the future.

Related Information

User Interface Overview [page 6]Common Display Options [page 7]Keyboard Shortcuts [page 9]Displaying the Versions of the SAP ESP Cockpit Components [page 10]Style and Syntax Conventions [page 11]SAP ESP Cockpit Accessibility Information [page 12]

1.1 User Interface Overview

Important elements of the SAP ESP Cockpit user interface.


SAP Event Stream Processor: Cockpit GuideSAP Event Stream Processor Cockpit

1.2 Common Display Options

You can use options provided by the grid format to sort and organize displayed data.

NoteSorting is case sensitive. Descending sorts list numbers followed by uppercase, then lowercase.

Column Options

On the MONITOR and EXPLORE worksets, for data displayed in grid format, you can rearrange columns and sort and sub sort by column.

Table 1:

Sorting Option Description

Simple column-based sorting Click a column name to sort the table based on that column in ascending or descending order. The arrow in the column’s sorting tab (to the right of the column name) points up when data is sorted in ascending order or down when data is sorted in descending order.

Reversing the order of a column-based sort

Click a column’s sorting tab to reverse its sort from ascending to descending order or vice versa.



Sorting Option Description

Nested sorting based on multiple columns

Click the column name for the primary sort. For subsidiary sorts, click the column’s sorting tab. Choose the columns for subsidiary sorts in the order you want to apply them. After you click a sorting tab, it displays its sorting level (1 for the primary sort, 2 for the secondary sort, and so on). Click any column name to clear the nested sort.

Rearranging columns Move columns by dragging and dropping them.

Once sorted, the order is retained when you return to the item after selecting other items within the EXPLORE workset or changing tabs, until you return to the default sort order or exit SAP ESP Cockpit.

The figure below shows a table of statistics sorted first by name; within name by value; within value by unit; and within unit by description.

Filter by Column

There is a filtering field at the top of each column. Enter a filtering term to narrow the range of objects displayed. Delete the filtering terms to return to the original display. Filtering terms are not case sensitive. For example, enter the name of an owner at the top of the Owner column to display only the tables owned by that name. The display reacts as you enter each character, so you might not need to enter the entire name.

Maximize an Area on a Page

Some areas on a page have a square minimize/maximize icon ( ) in the upper-right corner. Click the icon to expand that area to its maximum size. Click the icon again to restore the area to its former size.

Once an area is maximized, it retains its maximized state, even when returning after selecting other items within the MONITOR workset or changing tabs, until you restore it to its former size or exit SAP ESP Cockpit.



Changing the Font Size

To change the size of fonts in Cockpit screens:

● Enter Ctrl-Alt + to enlarge display fonts.● Enter Ctrl-Alt - to shrink display fonts.

The font change applies to the SAP ESP Cockpit interface, and persists regardless of the SAP ESP Cockpit system selected at login.

1.3 Keyboard Shortcuts

Frequently used key sequences for the SAP ESP Cockpit web interface.

Table 2:

Key Sequence Action

Space bar ● After pressing Tab to navigate to menu item or button with a drop-down list, space bar opens and closes the list.

● In a tree hierarchy, space bar expands and collapses a node.● In a wizard or property window, after navigating to a check box, space bar se

lects or deselects the item.● In a wizard or dialog box, space bar applies the highlighted button (for exam

ple, Yes, No, Back, Next, Apply, Finish, or Cancel).

Escape ● Release a drop-down list.● On the MONITOR tab, click the errors link at the bottom right of the window.

Escape closes the window.● Closes most, but not all wizards before completion.

Arrow keys ● Highlight the next item in a list or menu in the indicated direction.● Highlight the next radio button in a list in the indicated direction.● In a tree hierarchy, left and right arrows expand and collapse a node.● In a table with column searching, position the cursor in the first row and press

up arrow twice to access the Column Search row. Press left and right arrows to move between columns. Press the down arrow twice to return to the list.

Tab ● Highlight the next item in the tab order. (Tab order progresses through the accessible fields in a left-to-right, top-to-bottom fashion, starting at the upper left.)

● In a two-pane window, move from the tree hierarchy in the left pane to the right pane.

● In a window that includes a table or grid display, press Tab twice to highlight the table, then press the down-arrow to enter it.



Key Sequence Action

Shift-Tab ● Highlight the previous item in the tab order. (Tab order progresses through the accessible fields in a bottom-to-top, right-to-left, fashion, starting at the bottom right.)

● In a two-pane window, move from the right pane back to the tree hierarchy in the left pane.

Home ● Highlight the first item in the active window (or the active section of a window). For example, the first row in a list.

● In a tree hierarchy, highlight the first node in the tree.

End ● Highlight the last item in the active window (or the active section of a window). For example, the last row in a list.

● In a tree hierarchy, highlight the last node in the tree.

Ctrl-Alt + Increase the size of displayed text. Change persists to future sessions.

Ctrl-Alt - Decrease the size of displayed text. Change persists to future sessions.

Ctrl-Alt-L Open the event log for the current session of your Cockpit browser client.

F11 (Internet Explorer only) Enable or disable the browser’s full-screen mode.

SAP ESP Cockpit is built on Adobe Flex. For complete information about Adobe Flex keyboard shortcuts, see http://livedocs.adobe.com/flex/3/html/help.html?content=accessible_5.html .

1.4 Displaying the Versions of the SAP ESP Cockpit Components

View a list of components installed in SAP ESP Cockpit and their versions.

Context

Check the versions of the components in your SAP ESP Cockpit installation to determine whether your installation is up to date. Refer to online release information for the specific supported product component versions.

Procedure

1. Log in to SAP ESP Cockpit and select About.2. Compare the installed component versions against the versions published in the online release

information.



http://help.sap.com/disclaimer?site=http://livedocs.adobe.com/flex/3/html/help.html?content=accessible_5.html

1.5 Style and Syntax Conventions

A reference for the fonts and special characters used to represent elements of system output and user input.

A placeholder represents a system- or environment-specific value that you supply. For example:

%SYBASE%\start.bat

where %SYBASE% is the path to where the application is installed.

Table 3: Style Conventions

Key Definition

monospaced (fixed-width) ● SQL and program code● Commands names● File names● Directory names

<italic monospaced> In SQL or program code snippets, placeholders for user-specified values.

<italic> ● File and variable names● Cross-references to other topics or documents● In text, placeholders for user-specified values

bold ● Command, function, stored procedure, utility, class, and method names● Menu option paths● In numbered task or procedure steps, user-interface (UI) elements that you

click, such as buttons, check boxes, icons, and so on

Table 4: Syntax Conventions

Key Definition

{ } Curly braces indicates you must choose at least one of the enclosed options. Do not type the braces when you enter the command.

[ ] Brackets indicate that choosing one or more of the enclosed options is optional. Do not type the brackets when you enter the command.

( ) Parentheses are to be typed as part of the command.

| The vertical bar indicates you can only select one of the options shown.

, The comma indicates you can include as many of the options shown as needed, separating your choices with commas within the command.

... An ellipsis (three dots) indicates you may repeat the last unit as many times as needed in the command. Do not include ellipses in the command.



1.6 SAP ESP Cockpit Accessibility Information

SAP ESP Cockpit uses the Adobe Flex application.

For the most current information about Adobe Flex keyboard shortcuts, see http://livedocs.adobe.com/flex/3/html/help.html?content=accessible_5.html .

NoteTo use SAP ESP Cockpit effectively with versions of JAWS for Windows screen reading software before version 11, download and install the appropriate Adobe scripts. See http://www.adobe.com/accessibility/products/flex/jaws.html .





http://help.sap.com/disclaimer?site=http://www.adobe.com/accessibility/products/flex/jaws.html

http://help.sap.com/disclaimer?site=http://www.adobe.com/accessibility/products/flex/jaws.html

2 Get Started with SAP ESP Cockpit

Before starting the SAP ESP Cockpit and logging in for the first time, perform the post installation tasks described in the installation documenation.

For example, you must grant users or roles admin permission on the Cockpit system to enable them to edit SAP ESP Cockpit settings and configure alerts.

You must also grant read or read and admin permissions to users or roles based on the tasks users need to perform in ESP Cockpit.

NoteIf you wish to edit ESP Cockpit settings or the cluster configuration before you have granted admin or all permissions to users or roles, you can log on to ESP Cockpit using the SYS_STREAMING credentials.

It is critical that you perform the post installation tasks outlined in the installation documentation before starting SAP ESP Cockpit and logging in for the first time.

Related Information

Start and Stop the SAP ESP Cockpit Server [page 13]Logging in to SAP ESP Cockpit [page 23]Logging Out of the SAP ESP Cockpit [page 24]Viewing Overview Statistics [page 24]Node Statistics Reference [page 26]Clustering Architecture [page 27]

2.1 Start and Stop the SAP ESP Cockpit Server

You can start SAP ESP Cockpit server manually or set the service to start automatically and to restart in case of failure.

If you elect to run the SAP ESP Cockpit server manually, you must issue a command every time you want to start or shut down the server. If you elect to run as a service (recommended), you can configure the service to start and restart automatically.

When you install the SAP ESP Cockpit in Windows, the installer offers you the option to set up the cockpit to run as a service. If you want the cockpit to run as a service (daemon) in UNIX, you must set up the service yourself.

SAP Event Stream Processor: Cockpit GuideGet Started with SAP ESP Cockpit


Regardless of the start method used, wait at least five minutes after startup to log in to the SAP ESP Cockpit. Startup triggers automatic discovery, technical user verification, and collection jobs. Competing with these processes may cause unexpected behavior.

Related Information

Starting and Stopping the SAP ESP Cockpit Server in Windows [page 14]Starting and Stopping the SAP ESP Cockpit Server in UNIX [page 15]Configuring SAP ESP Cockpit Server as a Windows Service [page 17]Configuring SAP ESP Cockpit Server as a UNIX Service [page 18]cockpit Command [page 20]

2.1.1 Starting and Stopping the SAP ESP Cockpit Server in Windows

When you run SAP ESP Cockpit server manually, issue a command every time you start or shut down.

Prerequisites

Before starting the SAP ESP Cockpit, start the cluster database and ESP node. See the SAP Event Stream Processor: Configuration and Administration Guide for more information on cluster configuration.

Ensure that your home directory—that is, the home directory of the user who starts SAP ESP Cockpit—is writable from the SAP ESP Cockpit host. If the starting user cannot write to the home directory, SAP ESP Cockpit logs an error and fails to launch. Resetting the user’s HOME environment variable to a writable directory does not solve the problem.

Context

NoteIf you are starting SAP ESP Cockpit server for the first time in Windows 2008, Windows 7, or Windows 8, use the Run as Administrator option so that SAP ESP Cockpit can register its ODBC driver. (This is necessary even if you are logged in as an administrator.)



Procedure

1. To start the SAP ESP Cockpit server, execute:

%SYBASE%\COCKPIT-4\bin\cockpit.bat 2. To stop SAP ESP Cockpit, at the cockpit> prompt, execute:

shutdown

At the prompt, enter a text reason for the shutdown.

CautionDo not enter shutdown at a Windows prompt; it shuts down the operating system.

2.1.2 Starting and Stopping the SAP ESP Cockpit Server in UNIX


Prerequisites

Before starting the SAP ESP Cockpit, start the cluster database and ESP node. See the SAP Event Stream Processor: Configuration and Administration Guide for more information on cluster configuration.


Context

You can start the SAP ESP Cockpit server in the foreground or background. When you run SAP ESP Cockpit server in the background, you can use nohup, &, and > to redirect output and system error to a file, and suppress the Cockpit server console.

Procedure

1. Set the environment variables. Do this only once.



a. Change to the parent of the SAP ESP Cockpit installation directory.b. Execute one of the following to set environment variables.

Bourne shell:

. SYBASE.sh

C shell:

source SYBASE.csh

2. To start the SAP ESP Cockpit server, do one of:

Option Description

In the foreground

Execute:

$SYBASE/COCKPIT-4/bin/cockpit.sh

In the background

Execute a command similar to the sample below that matches your shell. The sample command directs output to the file cockpit-console.out. If the output file already exists, you might need to use additional shell operators to append to or truncate the file.

Bourne shell (sh) or Bash

nohup ./cockpit.sh 2>&1 > cockpit-console.out &

C shell

nohup ./cockpit.sh >& cockpit-console.out &

3. To stop the SAP ESP Cockpit server:

Option Description

Running in the foreground

At the cockpit> prompt, execute:

shutdown

At the prompt, enter a text reason for the shutdown.

CautionDo not enter shutdown at a UNIX prompt; it shuts down the operating system.

Running in the background

At the UNIX command line, execute:

$SYBASE/COCKPIT-4/bin/cockpit.sh --stop



2.1.3 Configuring SAP ESP Cockpit Server as a Windows Service

You can set the service to start automatically and to restart in case of failure. SAP recommends running SAP ESP Cockpit as a service.

Prerequisites


Context

If you run Cockpit server as a service, you can still manually start and stop the service, as needed. By default, if you install Cockpit to run as a service, the service is configured to automatically start, but not automatically restart. You must configure this manually.

Procedure

1. To configure automatic restart:

a. In Windows Control Panel, open System and Security Administrative Tools Services .b. Locate “Cockpit” in the Services list. It may be followed by a release number; if the service is for an

instance, it is also followed by the instance name. Service names do not distinguish between agents and servers. If the service is running, the Status column displays “Started.”

c. Click the Recovery tab and change the First, Second, and Subsequent failures to Restart the Service.d. Click OK.

2. To manually start the service:

Option Description

In the Services window

Select the cockpit service and click Start.

At a command line

Execute:

net start "Cockpit 4"

The Cockpit 4 service is starting...... The Cockpit 4 service was started successfully.



3. To manually stop the service:

Option Description

In the Services window Select the cockpit service and click Stop.

At a command line Execute:

net stop "Cockpit 4"

The Cockpit 4 service is stopping...... The Cockpit 4 service was stopped successfully.

2.1.4 Configuring SAP ESP Cockpit Server as a UNIX Service

You can set the service to start automatically and to restart in case of failure. SAP recommends running SAP ESP Cockpit as a service.

Prerequisites


Context

A UNIX service is a daemon process that starts automatically after the machine is started and runs in the background. UNIX installations of Cockpit server include a shell script, cockpitd, located at <sap_install_directory>/COCKPIT-4/bin, which you can use to configure the Cockpit service. (Some UNIX platforms supply tools that make service configuration easier; Linux chkconfig is an example.)

NoteSAP recommends that if you are not familiar with setting up services in UNIX, you delegate this task to a system administrator or consult the system administration documentation for your UNIX platform.

Procedure

1. Open cockpitd and make these changes:



○ Change the line that sets the SYBASE variable to the location of your SAP installation (that is, the parent directory of COCKPIT-4, the SAP ESP Cockpit installation directory). By default, this directory is called /opt/Sybase if you installed Cockpit on a machine with an existing Sybase or SAP Sybase product or environment variable; otherwise the default parent directory is /opt/sap.

○ Set the COCKPIT_HOME environment variable to <sap_install_directory>/COCKPIT-4.○ Copy cockpitd to /etc/init.d.○ If you are using shared-disk mode to run a single instance whose name is not the host name, or to run

multiple instances on the same host, add the instance name to the script name. Change:

SCRIPT_NAME=cockpit.sh

to:

SCRIPT_NAME="cockpit.sh -instance <instance-name>"

2. In Linux:a. Discover the location of chkconfig by running one of these commands:

whereis chkconfig

or

which chkconfig

b. In Linux, configure the service to run in run levels 2, 3, 4, and 5. Execute:

/sbin/chkconfig --add cockpitd /sbin/chkconfig cockpitd 2345

You can test the cockpitd script with /sbin/service cockpitd status. (The service command accepts these options: start | stop | status | restart.) For example, to start the Cockpit, enter /sbin/service cockpitd start.

3. In Solaris:a. Create soft links. Locate this directory:

○ /etc/rc<X>.dWhere <X> is the run level (for example, 3). Make two soft links in the directory for Solaris and set the links to point to:○ /etc/init.d/cockpitd: S90cockpitd, and○ /etc/init.d/cockpitd: K10cockpitd

The S90cockpitd link starts the service and the K10cockpitd link stops the service. The two-digit numbers in the links indicate the start and stop priorities of the service.

b. Use the S90cockpitd and K10cockpitd links to test starting and stopping the service. The links are called automatically when the machine is started or shut down.



2.1.5 cockpit Command

Use cockpit.bat (Windows) or cockpit.sh (UNIX) to manually start and stop SAP ESP Cockpit agents and servers and to perform administrative tasks like configuring ports and enabling and disabling services.

A single cockpit server can manage other SAP database products if they reside on the same host. The cockpit server shares ports and other resources, and the cockpit command enables all installed plugins.

Use the instance command to manage multiple server instances from the same Cockpit installation directory.

Syntax

cockpit[.bat | .sh] [-a | --address <RMI-service-address>] [-b | --bitwidth] [--dbpassword] [-disable | --disable <service-name,service-name...>] [-enable | --enable <service-name,service-name...>] [-h | --help] [-I | --info [<information-category>]] [-instance [<instance-name>]] [-m | --message <message-level>] [-password | --password <password>] [-p | --port {<port-name>=<port-number> | <service-name>:<property-name>=<port-number>}] [{-start | --start} | {-stop | --stop}] [-status | --status] [-user | --user <login-name>] [-v | -version | --version]

Parameters

● -a | --address RMI-service-address The address for the RMI service to use; must be an IP address on this machine or the name of this machine (which is the default).

● -b | --bitwidth Return an informational only string identifying the bit width (32 or 64) of the underlying platform. If you use this option, the cockpit command does not start the Cockpit.

● --dbpassword Change the password of the default dba account provided for the repository database. It prompts you for the new password, validates it, and starts the SAP ESP Cockpit server. This option does not work if you start the Cockpit in the background—it fails to start if there is no console.

● -disable | --disable service-name,service-name... Disable the specified services. This option does not work while SAP ESP Cockpit is running or as part of a command that starts the Cockpit. To use it, shut down the Cockpit, execute cockpit --disable, then restart. See under --ports for service names; separate each service from the next with a comma.

● -enable | --enable service-name,service-name... Enable the specified services. Separate each service from the next with a comma. When you use this option, cockpit does not start SAP ESP Cockpit—use a separate command to start the Cockpit.

● -h | --help Display help and usage information for the cockpit command. If you use this option, cockpit does not start SAP ESP Cockpit.



● -I | --info [information-category] Display the specified categories of information about SAP ESP Cockpit. Separate each category from the next with a comma. The information categories are:

all Returns all the information provided by the sys, ports, and services categories. Default option.sys Returns general information about this instance of SAP ESP Cockpit, including the version, the home (installation) directory, the host machine’s name and IP address, the RMI port number, the messaging level, and details about the platform and Java installation.ports Lists all the ports on which the Cockpit and its services listen, indicates whether each port is in use, and shows the service running on each port.services Lists all the services known to the Cockpit, indicates whether each service is enabled, and lists other services on which each service depends.sysprop Lists all the Java system properties known to the Java VM and their values.env Lists the complete Java VM process environment.

● -instance [instance-name] Use with other options (-start and -stop, for example) to specify an instance in a shared disk deployment. If you do not enter a name for the instance, it defaults to the host name.

● -m | --message message-level Set the amount of detail recorded in system logs; also known as the logging level. Valid values are OFF, FATAL, ERROR, WARN, INFO, DEBUG, and ALL. WARN is the default.

● -password | --password Specify the password of the user account SAP ESP Cockpit uses to stop servers or query them for status. Use this option with --user. When you enter a command with --user but without --password, the console prompts you to enter a password.

● -p | --port {port-name=port-number | service-name:property-name=port-number} Configure the specified service to run on the specified port. Changing ports is useful if you discover a port conflict between SAP ESP Cockpit and other software on the same system. When you use this option, cockpit does not start SAP ESP Cockpit—use a separate command to start the Cockpit.

Valid port names, service names and property names are:

Table 5:

Port Name Description Service Names Property Names Default Port

db Database port SccSADataserver

Messaging

Alert

com.sybase.asa.server.port

messaging.db.port

alert.database.port

4638

http Web HTTP port EmbeddedWebContainer http.port 4282

https Web HTTPS (secure HTTP) port

EmbeddedWebContainer https.port 4283

msg Messaging port Messaging messaging.port 4993

rmi RMI port RMI port 4992

tds Tabular Data Stream™ port (used to communicate with other SAP database products)

Tds tdsPort 4998



You can also execute cockpit --info ports to display service names and associated property names; they appear in the first two columns of the output.

● -start | --start Start the Cockpit. This is the default option—if you execute cockpit with no options, it starts the Cockpit. This option cannot be combined in the same command with options that set ports or enable or disable services; use a separate cockpit command to start the Cockpit.

● -status | --status Display a status message indicating whether the Cockpit is running.● -stop | --stop Shut down the Cockpit if it is running.● -user | --user [login-name] Specify the user account SAP ESP Cockpit uses to stop managed servers or

query them for status. Use this option with --password. If you do not enter a login name, the console prompts you to enter one.

● -v | -version | --version Display the version of SAP ESP Cockpit software running on this system. If you use this option, cockpit does not start SAP ESP Cockpit.

Examples

Set the RMI port

Each of these commands sets the RMI port to 5992. The first command demonstrates the port name syntax; the second demonstrates the service name:property name syntax:

cockpit --port rmi=5992 cockpit --port RMI:port=5992

Set the RMI port and start SAP ESP Cockpit

These commands set the RMI port to 9996, then start the Cockpit. Two commands (separated by a semicolon here) are needed because cockpit does not start the Cockpit when the command includes any of the port-setting options:

cockpit -p rmi=9996; cockpit

Set all database ports

This command sets all three of the repository database ports (data server, messaging, and database alert) to 3638:

cockpit --port db=3638 Set the TDS port

This command sets the TDS port to 9998:

cockpit --port Tds:tdsPort=9998 Enable a service and start the Cockpit

The first cockpit command enables the TDS service; the second starts the Cockpit. (The two commands are separated by a semicolon.) The second command is needed because cockpit does not start SAP ESP Cockpit when the command includes the -enable option:

cockpit -enable Tds; cockpit



Start an Cockpit instance

This command starts the Cockpit instance called kalamazoo. -start is optional because it is the default:

cockpit -start -instance kalamazoo

Permissions

None required.

2.2 Logging in to SAP ESP Cockpit

Connect to the SAP ESP Cockpit console using a Web browser. If you are using RSA or Kerberos authentication and are logging in to ESP Cockpit for the first time, see Logging in to SAP ESP Cockpit in the SAP Event Stream Processor: Installation Guide for important setup and authentication information.

Prerequisites

● Adobe Flash Player is installed in the browser you are using for SAP ESP Cockpit.● The SAP ESP Cockpit server is running.

Procedure

1. Open a Web browser and enter https://<hostname>:4283/cockpit.

2. At the login prompt, select the system to manage, and enter an Event Stream Processor user name and password valid for that system.

NoteEnsure the login credentials you specify have been granted read or read and admin permissions depending on the type of tasks you need to perform. See Setting Up SAP ESP Cockpit for First Time Use in the SAP Event Stream Processor: Installation Guide for more information.

If you use a Windows account to log in to SAP ESP Cockpit, enter your user name in the format username@domain. Omit top-level domain extensions such as .com or .net—for example, enter fred@sap, not [email protected]. If you do not include the domain, the <defaultDomain> option must be specified in the authenticator section of cluster configuration.

If you use a Windows account to log in, you must also grant permissions to the user name in the format username@domain.



Upon logging in, SAP ESP Cockpit automatically detects and registers the ESP nodes that are present on your machine. If you add additional ESP nodes while you are logged on, you do not need to log off and restart the SAP ESP Cockpit as it automatically detects newly added nodes.

2.3 Logging Out of the SAP ESP Cockpit

Click Log Out in the upper-right corner of the window to end the session.

Context

If an administrator has configured the automatic logout feature, SAP ESP Cockpit logs you out if your session is idle (no typing or mouse movement) for longer than the timeout period.

If no automatic logout period is configured,

● A login session left open on a screen that refreshes (a monitor screen or a data collection job screen, for example) remains open indefinitely.

● A login session left open on a screen that does not change expires after 30 minutes. The next time you make a request of the server, SAP ESP Cockpit logs you out.

2.4 Viewing Overview Statistics

Use the Overview page to monitor overall statistics and view alerts for the current node.

Prerequisites

● The time-granularity option is enabled on the node in the ESP project configuration (.ccr) file.● Your user account has the required read permission in ESP. Learn more about granting permissions in the

post-installation tasks of the installation documentation, and in the SAP Event Stream Processor: Configuration and Administration Guide

Procedure

1. Select the MONITOR workset, then the Overview page.Information and statistics display for the current node you are monitoring.



Table 6:

Statistics Description

CPU History Line graph displaying the percentage of total CPU usage over time. The data on the graph starts displaying from the time you select the Overview page.

Memory Usage History Line graph displaying total memory usage over time, in kilobytes (KB). The data on the graph starts displaying from the time you you select the Overview page.

Thread Usage History Line graph displaying number of threads used over time. The data on the graph starts displaying from the time you you select the Overview page.

2. Select either the Node or Alerts workset:

Table 7:

Page Tab Statistics

Node State - valid values are running or unknown.

Name - name of the ESP node.

Host - the host on which the ESP server is currently running.

Port - the port on which the ESP server is currently running.

Node type - whether node is a manager or controller.

Node version - the version of SAP Event Stream Processor. For example, version 5.1 SP08 displays as 5.1.08.00.

Platform - platform of the machine that the node is on.



Page Tab Statistics

Alerts The following statistics display above this table:○ Rows - number of rows belonging to the node.○ Criticals - the number of critical alerts triggered for

the node.○ Warnings - the number of warning alerts triggered for

the node.

This is the header table containing all alerts that have fired for the ESP node after you select the Overview page.

Time - when the alert is triggered.

Alert Name - name of the alert. This is based on the KPI.

Resource - the resource for which the alert is triggered.

Severity - alert severity rating. Possible severity ratings are Normal, Warning, or Critical, and are based on ranges of values you specified when setting the alert threshold.

Value - the KPI value. The alert is triggered when the KPI value falls within the range of values you specified when setting the alert threshold.

Threshold - the range of values you assigned to alert severity ratings. For example, if the low value for the Normal rating is 0 and the high value 100, the threshold is the range of 0 to 100.

2.5 Node Statistics Reference

The SAP ESP Cockpit provides a general overview of node availability, performance, capacity, and alerts.

Table 8:

Statistic Description

AvailabilityLocation: MONITOR Overview > Node page tab

Displays the state of the node. Possible values are running and stopped.

PerformanceLocation: MONITOR Adapters > Common Statistics table

Displays adapter performance information. While your adapter is running, you can measure its performance by comparing the AdapterBadRows and the AdapterTotalRows statistics, as well as looking at AdapterLatency.



Statistic Description

CapacityLocation: MONITOR Adapters > Adapters table

Displays adapter status. Possible values are running and stopped. If an adapter is stopped, capacity degrades since the node cannot receive or send data.

AlertsLocation: MONITOR Overview > Alerts workset

Displays a table of alerts generated by problems with availability, performance, and capacity.

2.6 Clustering Architecture

Event Stream Processor clusters are designed for simplicity and minimal need for interaction from administrators once started.

A cluster consists of one or more nodes. Single-node clusters provide a convenient starting point from which to build and refine multinode clusters.

Nodes are processes that run on hosts. There are two functional types of nodes: managers and controllers. A manager is an external access point to a cluster. Managers maintain and monitor cluster and application state. A controller is responsible for starting and monitoring the processes that run projects (project servers).

Clusters can include manager-only nodes, controller-only nodes, and manager-and-controller nodes. The smallest clusters consist of a single node that serves as both manager and controller.

NoteIn a multinode cluster—where there is more than one node with a manager role—any nodes residing on Windows machines must be either managers or controllers, but not both. (Windows also supports single-node clusters, where the one node must serve both roles.)

A cluster launches project servers on demand and manages the project life cycle. This diagram shows projects running in a cluster.



Figure 1: Cluster Architecture

In development and test environments, a single node cluster may be sufficient. You can deploy several projects to a single-node cluster that monitors project status and, if the project deployed has failover configured, restarts failed projects. However, as you develop and refine your Event Stream Processor environment, the demands on your cluster grow. You can therefore expand your cluster to include additional nodes and, if necessary, expand your environment to include additional clusters.

In a multinode cluster, all manager nodes are considered primary, so there is no single point of failure in the cluster. However, if you configure only one controller for multiple managers, the controller can become a single point of failure.

Every deployed project maintains a heartbeat with one of the managers in the cluster. If the manager node detects missed heartbeats from a project for too long, it assumes project failure and issues a STOP command. If the project has failover configured, the manager restarts the project. For example, if your CPU utilization is operating at 100 percent, the project server may not be able to send heartbeats to the cluster manager, which stops the project. In multinode clusters, the manager responsible for monitoring a project might not be the manager through which the project is deployed.

All the manager nodes in a cluster store project information in a shared cache. If a manager node starts a project and subsequently fails, the shared cache enables any other manager in the cluster to take over management of the failed manager’s projects. This shared cache is stored in the cluster database. The cluster database maintains configuration information for all nodes in the cluster. It also holds policy configuration, data services (formerly stored in the service.xml file), and persists cluster cache data. There is one logical instance of the database per cluster.



3 Configure SAP ESP Cockpit

There are several options available to configure SAP ESP Cockpit.

NoteThese additional options are over and above the minimum configuration described in Get Started with SAP ESP Cockpit.

Related Information

Registering and Authenticating an SAP Cockpit Agent [page 29]Configuring the E-mail Server [page 32]Configuring Retrieval Thresholds for SAP ESP Cockpit [page 33]Configuring the Automatic Logout Timer [page 34]Changing the Screen Refresh Interval [page 34]Collection Jobs [page 35]Repository [page 38]Logging [page 44]Shared-Disk Mode [page 52]Configuring Ports [page 65]Configuring Memory Usage [page 67]SAP ESP Cockpit User Management [page 71]SAP ESP Cockpit Console [page 74]Changing the UAFADMIN or SCCADMIN Password [page 78]

3.1 Registering and Authenticating an SAP Cockpit Agent

Register and authenticate the SAP ESP Cockpit agent for an ESP node to be able to perform certain administrative tasks, including starting an ESP node.

Prerequisites

Start the SAP ESP Cockpit server on the host where the ESP node is installed. This starts the Cockpit agent.

SAP Event Stream Processor: Cockpit GuideConfigure SAP ESP Cockpit


Context

The SAP ESP Cockpit (Cockpit) agent runs on the same host as an ESP node and enables SAP ESP Cockpit to manage the ESP node. The Cockpit agent is installed automatically as part of the ESP server.

For multi-node clusters that are installed on separate hosts, you can install SAP ESP Cockpit on the same host as the manager and controller node (cluster) and have only the Cockpit agent on each of the remote machines that host the controller nodes belonging to that cluster. You can use a custom ESP installation to install only the ESP server and Cockpit agent.

Procedure

1. Select the EXPLORE workset, then in the left pane, select ESP Nodes.2. In the right pane of the ESP Nodes page, select an ESP node, click the arrow and select Register Agent.3. (Optional) Set the ESP node configuration file path, ESP node startup folder path, the ESP node cluster log

configuration file path, and the ESP node cluster log file path.If you do not set values for these fields, they default to the following values:○ ESP cluster bootstrap file path - $STREAMING_HOME/cluster/config/<cluster name>/

cluster.cfg ○ ESP node working directory - $STREAMING_HOME/cluster/config/<cluster name>/<node

name>○ ESP cluster log properties file path - $STREAMING_HOME/cluster/config/<cluster name>/

cluster.log.properties○ ESP node log file path - $STREAMING_HOME/cluster/config/<cluster name>/<node

name>.log

NoteFor a typical ESP installation, the cluster name is esp1 and the node name is node1.

4. Enter the Cockpit agent port (the default port is 4992) and click OK.The Cockpit agent host name is automatically set as the ESP node's host name and cannot be changed.

5. In the right pane of the ESP Nodes page, select an ESP node, click the arrow and select Authenticate Agent.

6. Enter the Cockpit agent user (the default is uafadmin) and password.

Next Steps

For instructions on changing the password for the Cockpit agent’s default uafadmin account, see the topic on setting passwords in the SAP Event Stream Processor: Installation Guide



Related Information

Parameters Required for Starting a Node [page 31]

3.1.1 Parameters Required for Starting a Node

When registering a Cockpit agent for an ESP node, there are four optional parameters that you can specify: node configuration file path, node startup folder path, node cluster log configuration file path, and node cluster log file path.

The node configuration file path is the path to the node configuration file that the agent should use to start the ESP node. This is the equivalent to the --config parameter for the streamingclusternode command.

The log configuration file path is the path to the log configuration file. This is the equivalent to the –p parameter for the streamingclusternode command.

The log file path is the path to the cluster log file. This is the equivalent to the --f parameter for the streamingclusternode command.

The startup folder path is the path to the folder from where the ESP node was started. The Cockpit agent looks for the startup folder because that is where the cluster log resides. Note that this is not necessarily the location of the streamingclusternode binary. For example, if the streamingclusternode binary is located under $STREAMING_HOME/bin, but your current directory is /myhome/myserverrun, you can enter:

> cd /myhome/myserverrun > $STREAMING_HOME/bin/streamingproject ..

In this example, /myhome/myserverrun would be the startup folder.

If you do not provide values for these parameters, they default to these values:

● ESP node configuration file path - $STREAMING_HOME/cluster/config/<cluster name>/cluster.cfg

● ESP node startup folder path - $STREAMING_HOME/cluster/config/<cluster name>● ESP node cluster log configuration file path - $STREAMING_HOME/cluster/config/<cluster name>/

cluster.log.properties● ESP node cluster log file path - $STREAMING_HOME/cluster/config/<cluster name>/<node

name>.log

Related Information

Starting and Stopping a Node [page 119]



3.2 Configuring the E-mail Server

Specify the e-mail server for SAP ESP Cockpit to use to send alert notifications.

Prerequisites

The account you use to log in has been granted admin permission on the ESP Cockpit system. Learn more about granting permissions in the post-installation tasks of the installation documentation, and in the SAP Event Stream Processor: Configuration and Administration Guide

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select General Settings.3. Click the E-mail tab.4. Enter the name of the e-mail server.5. Change the default e-mail server port only in consultation with your e-mail administrator.6. (Optional) Send a test e-mail to verify the e-mail server is correctly configured.7. (Optional) Click Customize e-mail settings to display options for setting the domain name and e-mail

sender for e-mail alert notifications.a. Enter your domain name (for example, mycompany.com).

Most e-mail servers do not require SAP ESP Cockpit to provide an explicit domain name. Try providing a domain name here if your first attempt to configure e-mail alerts fails.

b. Change the default e-mail sender name.This name appears in the "From" field of SAP ESP Cockpit e-mail alert messages. Do not use spaces; use hyphens or underscore characters instead.

TipIf you have multiple SAP ESP Cockpit servers, configure their sender names so you can identify which SAP ESP Cockpit an alert is coming from. For example, Cockpit_Boston or Cockpit_test11.

c. If you entered anything in the E-mail Domain name or E-mail sender name fields, click Apply to make the test e-mail option reappear.

d. To dispatch a test message, enter an e-mail address in the Test e-mail address field and click Send.If the test e-mail is received, you have properly configured the server for e-mail alert notifications.

8. Click OK to update any changes and close the Cockpit Settings page.



3.3 Configuring Retrieval Thresholds for SAP ESP Cockpit

Set limits on the time SAP ESP Cockpit waits for data to load or on the number of rows it loads.

Prerequisites


Context

Performing some tasks may cause the SAP ESP Cockpit to load a large amount of data, which can be time-consuming and can place a heavy load on your network. SAP ESP Cockpit mitigates this problem by displaying partial results and by displaying placeholders called message rows when data takes longer than a specified number of seconds to retrieve, or exceeds a specified number of rows. The data retrieval options let you specify those numbers.

This data retrieval scheme reduces network traffic, since result sets that exceed the specified row count are not transmitted unless you ask for them by expanding a message row. By displaying partial results and message rows for data from slow-responding systems, the scheme also minimizes the time you spend waiting.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select General Settings.3. Click the EXPLORE workset.4. Set the timeout for data retrieval in seconds.

When SAP ESP Cockpit is not able to return all requested data within this period of time, it displays any data it has received and generates message rows in place of the missing results. SAP ESP Cockpit replaces message rows with real data as soon as the data arrives.

5. Set the row count.When a request returns results that exceed the specified row count, SAP ESP Cockpit displays a message row in place of the expected results. You can expand the message row by selecting it, clicking the dropdown arrow, and selecting Expand.




3.4 Configuring the Automatic Logout Timer

Set SAP ESP Cockpit to end login sessions when users are inactive for too long.

Prerequisites


Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select General Settings.3. Click the Auto-Logout tab.4. Enter the number of minutes after which an idle user will be automatically logged out.

Enter 0 or leave the box empty to disable automatic logout.5. Click OK to update any changes and close the Cockpit Settings page.

3.5 Changing the Screen Refresh Interval

Use the Settings page to modify the screen refresh interval, in seconds.

Procedure

1. Under the Monitor workset, select the Settings page.2. Change the value in the Screen refresh interval (Seconds) field. The number must be an integer, floating

points are not allowed.

The minimum value is 5, maximum value is 999999, and default value is 30 seconds. Setting the value too low can have a negative performance impact, and setting the value too high means you do not get system performance updates in a timely manner.

3. Click Apply.The screen refresh interval is updated.



3.6 Collection Jobs

Statistics collection jobs provide the data that appears on the Statistics Chart on the MONITOR workset. Some collection jobs are also used to manage and monitor alerts on the ALERTS workset.

Data gathered by collection jobs appears on the Statistics Chart page on the MONITOR workset. If you attempt to view data for a collection job that has not been created, No data was found for statistic appears.

The Availability Statistics, Performance Statistics, and Capacity Statistics collection jobs are scheduled by default. Additional collection jobs can be created and scheduled as needed.

You can define job schedules as one-time or repeating, and modify the schedule for a job based on a number of attributes such as repeat interval, date and time. Statistics gathering consumes system resources intensively; the more collection jobs you run, the greater the burden on your server. The data is stored in the repository. The job history displays the status of jobs executed each day.

All collections jobs run using the technical user account.

Related Information

Executing and Stopping a Collection Job [page 35]Resuming and Suspending a Collection Job [page 36]Viewing Collection Job Schedule Details [page 37]Viewing the Job Execution History [page 38]

Graphing Performance Counters: The Statistics Chart [page 129]

3.6.1 Executing and Stopping a Collection Job

You can run or stop a data collection job.

Prerequisites


Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).



2. In the left pane, select Collection Jobs.3. Select a job in the Job Name column.4. On the General tab:

○ To execute a job immediately, click Execute.○ To stop a job, click Stop, then click Yes to confirm.

TipIf the General tab is grayed out, you have selected a schedule (child) rather than a job (parent) in the Collection Jobs table. Select the parent job to enable the General tab.

3.6.2 Resuming and Suspending a Collection Job

You can resume or suspend a data collection job.

Prerequisites


Context

CautionData gathered by the Availability Statistics, Performance Statistics, and Capacity Statistics collections is used to trigger alerts. If you suspend one of these collection jobs, no new collection data is gathered on which to trigger new alerts until you resume the collection job.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select Collection Jobs.3. Select a job in the Job Name column.4. On the General tab:

○ To resume a job, click Resume.



○ To suspend a job, click Suspend, then click Yes to confirm the suspension.

TipIf the General tab is grayed out, you have selected a schedule (child) rather than a job (parent) in the Collection Jobs table. Select the parent job to enable the General tab.

3.6.3 Viewing Collection Job Schedule Details

Display schedule details from a data collection job.

Prerequisites


Context

You can only view schedule details; you cannot modify them.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select Collection Jobs.3. Expand a job in the Job Name column.

If there is no arrow to the left of the job’s name, this job has no schedules.4. Select a schedule in the Schedule Name column.

The name, description, start and end dates, and repeat interval appear on the Schedule tab.5. Click OK.



3.6.4 Viewing the Job Execution History

View a data collection job execution history.

Prerequisites


Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. Select Collection Jobs.3. Select a job in the Job Name column.4. Click the History tab.

3.7 Repository

The SAP ESP Cockpit embedded repository stores information related to the server being managed, as well as user preference data, operational data, statistics, and alert configuration.

You can back up the repository database on demand, schedule automatic backups, restore the repository from backups, and configure repository purging options. Full and incremental backups are available. A full backup copies the entire repository. An incremental backup copies the transaction log, capturing any changes since the last full or incremental backup.

By default, SAP ESP Cockpit saves backups as follows:

● Each full backup is stored in its own subdirectory in %SYBASE%\backup.● Each incremental backup is stored in a file in %SYBASE%\backup\incremental.

SAP recommends that you periodically move backup files to a secondary storage location to prevent the installation directory from becoming too large.

Scheduling Backups of the Repository [page 39]Configure full and incremental backups of the repository to occur automatically.

Suspending or Resuming a Scheduled Backup [page 40]Suspend or resume a scheduled backup of the repository.

Modifying the Backup Schedule [page 41]Change the backup schedule for the repository.



Forcing an Immediate Backup [page 41]Perform an unscheduled full or incremental backup of the repository.

Restoring the Repository from Backups [page 42]Load backup files into the repository database to revert undesirable changes or to recover from a catastrophic failure.

Configuring Repository Purging [page 43]Change repository purging options.

3.7.1 Scheduling Backups of the Repository

Configure full and incremental backups of the repository to occur automatically.

Prerequisites

● Determine your backup strategy, including when to perform full backups and incremental backups. For example, you might schedule incremental backups every day and a full backup every Saturday.

● The account you use to log in has been granted admin permission on the ESP Cockpit system. Learn more about granting permissions in the post-installation tasks of the installation documentation, and in the SAP Event Stream Processor: Configuration and Administration Guide

Context

A full backup copies the entire repository. An incremental backup copies the transaction log, capturing any changes since the last full or incremental backup.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select Repository.3. In the right pane, choose:

○ Incremental Backup○ Full Backup

4. To change the directory in which the backup is stored, click Browse, and navigate to the desired directory.5. Select Schedule a Regular Backup.6. Specify a Start date or click the calendar and select a date.7. Use the Time and AM/PM controls to specify the time to start the backup.



8. Use the Repeat interval control to specify how often the backup occurs.9. (Optional) To purge the repository after each backup, select Run a repository purge after the backup

completes.a. If you include purging in the backup schedule, select the Size Management tab and unselect

Automatically purge the repository periodically to disable automatic purging.10. Click Apply to save the schedule.

Next Steps

Set purging options on the Size Management tab.

3.7.2 Suspending or Resuming a Scheduled Backup

Suspend or resume a scheduled backup of the repository.

Prerequisites


Procedure



4. Select or unselect Schedule a Regular Backup.When you unselect this option, the scheduling area is grayed out and scheduled backups no longer occur. However, the schedule is preserved and you can reinstate it at any time.




3.7.3 Modifying the Backup Schedule

Change the backup schedule for the repository.

Prerequisites


Procedure



4. To change the backup schedule, edit the Start date, Time, Repeat interval, or units. You can also select or unselect Run a repository purge after the backup completes.


3.7.4 Forcing an Immediate Backup

Perform an unscheduled full or incremental backup of the repository.

Prerequisites


Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).



2. In the left pane, select Repository.3. In the right pane, choose:


4. Click Back up Now.5. Click Yes at the confirmation prompt to begin the backup.6. Click OK to acknowledge when the backup is complete.

3.7.5 Restoring the Repository from Backups

Load backup files into the repository database to revert undesirable changes or to recover from a catastrophic failure.

Context

If you configured SAP ESP Cockpit to store backups somewhere other than the default location, change the source directory in the copy commands in this procedure.

Procedure

1. Log out of the SAP ESP Cockpit console, if it is running.2. Shut down the SAP ESP Cockpit server.3. Copy the most recent full backup from \backup to \services\Repository\db.

○ Windows:

%SYBASE%\COCKPIT-4\backup

%SYBASE%\COCKPIT-4\services\Repository\db

○ UNIX:

$SYBASE/COCKPIT-4/backup

$SYBASE/COCKPIT-4/services/Repository/db

For example:4. If you have incremental backups to load:

a. Copy the log file from \backup\incremental\<generated_directory_name> to \services\Repository:



○ Windows:

%SYBASE%\COCKPIT-4\backup\incremental\<generated_directory_name>

%SYBASE%\COCKPIT-4\services\Repository

○ UNIX:

$SYBASE/COCKPIT-4/backup/incremental/<generated_directory_name>

$SYBASE/COCKPIT-4/services/Repository

For example:b. Skip to step 6 [page 43].

5. (Optional) To load incremental backups, start the repository database using the -ad option, which directs it to load transaction logs (incremental backups) from the incremental directory. (The database loads full backups automatically.)

For example:

The repository database loads the full backup and any subsequent incremental backups present in the incremental directory. Incremental backups are loaded in date order. After loading and saving, the database shuts down.

6. Start the SAP ESP Cockpit server.If you loaded incremental backups, SAP ESP Cockpit starts normally (that is, no further recovery occurs). If you copied a full backup to the Repository directory, the database recovers the repository from the full backup.

3.7.6 Configuring Repository Purging

Change repository purging options.

Prerequisites


Context

As you decide how to purge your repository, consider that:

● Purging keeps the repository from absorbing too much disk space.● By default, purging is enabled. It occurs once a day and purges data older than one day.



● Statistics and alert history can help you detect trends in server performance and user behavior. The SAP ESP Cockpit statistics chart can graph performance data over a period of a year or more if the data is available. If you have enough disk space, consider saving data for a longer period of time or disabling the purging of statistics or alert history.

● Changing the purge frequency and other options might affect SAP ESP Cockpit performance.

NoteIf you configure purging as part of a scheduled backup of the repository, disable automatic purging on the Size Management tab.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select Repository, and then click the Size Management tab in the right pane.3. To turn automatic purging on or off, click Automatically purge the repository periodically.

Turn this option off if purging is configured as part of your scheduled full or incremental backups.4. Click purge options to turn them on or off:

○ Purge statistics○ Purge alert history

5. In Purge data older than, enter the number of days after which to purge repository data.6. Click OK to update any changes and close the Cockpit Settings page.

3.8 Logging

Logging helps SAP ESP Cockpit administrators identify and track errors and other system events by recording messages about the events in log files.

SAP ESP Cockpit maintains these logs:

Client log captures messages about activities in the browser-based client components. These messages are generated by the component product modules to display information that is pertinent to the user but not critical enough to warrant a pop-up. SAP ESP Cockpit also uses the client log to trace client browser operations.Server logs capture messages about activities during the initialization sequence, such as starting services; auditing messages recording logins and logouts; errors such as missed scheduled events; and other events on the server. Server logs include:

● Component logs, which record only events concerning individual product modules.● The SAP ESP Cockpit agent log, which is a composite log. In an SAP ESP Cockpit server, the agent log

records events in all product modules and in the SAP ESP Cockpit framework. In an SAP ESP Cockpit agent, the agent log records events in the agent.



Repository log captures information about inserts and updates that have occurred in the SAP ESP Cockpit repository, a SQL Anywhere database. This log is in COCKPIT-4\log\repository.log.Alert services log captures information about alert service status and events, including execution of alert-triggered scripts (start time, end time, and status and exit codes). This log is in COCKPIT-4\log\alert-server.log.

Log Files for Event Stream Processor [page 45]Event Stream Processor has log files which record messages about system and component events.

Viewing SAP ESP Cockpit Server Logs [page 48]View event logs for the SAP ESP Cockpit server.

Viewing the SAP ESP Cockpit Client Log [page 49]Display the event log for the current session of your SAP ESP Cockpit browser client.

Changing the SAP ESP Cockpit Logging Level [page 50]Adjust the logging level that determines which events SAP ESP Cockpit records in the server logs. This task requires you to restart SAP ESP Cockpit.

Changing SAP ESP Cockpit Logging Configuration [page 51]Edit the logging configuration file, log4j.properties, to modify SAP ESP Cockpit logging.

3.8.1 Log Files for Event Stream Processor

Event Stream Processor has log files which record messages about system and component events.

Event Stream Processor maintains these logs:

● SAP ESP Cockpit (ESPMAP) log - captures messages about startup errors, tracks verification processes, and can help you diagnose connectivity issues.

● The SAP ESP Cockpit agent (ESPAP) log - captures messages about ESP Cockpit agent activities and can help you diagnose issues.

● The node log - captures messages about the cluster manager and controller activities and can help you diagnose issues.

● The project log - captures messages about the project activities and can help you diagnose issues.

Related Information

Viewing the SAP ESP Cockpit Agent Log File [page 46]Viewing the Node Log File [page 47]Viewing the Project Log File [page 48]



3.8.1.1 Viewing the SAP ESP Cockpit Agent Log File

View the log file for the SAP ESP Cockpit agent from the EXPLORE workset.

Context

The ESP Cockpit agent log records messages about ESP Cockpit agent activities and can help you diagnose issues.

Procedure

1. In the left pane of the EXPLORE workset, select ESP Nodes.2. In the right pane of the EXPLORE workset, select a node, click the arrow, and select View Agent Log.

A new window appears and displays the log file entries:

Table 9:

Column Name Description

Date The date and time at which the event occurred and the message was logged.

Severity Severity levels span from zero to five and correspond to:

○ FATAL - (0) Processing cannot continue.○ ERROR - (1) Processing can continue but a serious issue is encoun

tered. May require corrective action on your part.○ WARNING - (2) Bringing your attention to an unusual situation or

event. For example, you may see a warning when you have only 20 percent of memory left.

○ INFO - (3) Information about system activity. No action is required.○ DEBUG - (4) Provides details about the code to assist you in resolving

issues. This may have a negative impact on performance.○ TRACE - (5) Similar to DEBUG but with more details.

Message Displays the log entries. Each log entry displays descriptive text according to the severity level to which it corresponds.

3. (Optional) Select the Log View Settings icon from the top right corner of the dialog to select what lines you want to see from the log file, and select Apply Settings.You can choose to retrieve all the lines from the file, the last n lines, lines from the past n days, or lines from certain dates.



3.8.1.2 Viewing the Node Log File

View the log file for an ESP node from the EXPLORE workset.

Context

The node log file captures messages generated about the cluster manager and controller activities and can help you diagnose issues.

Procedure

1. In the left pane of the EXPLORE workset, select ESP Nodes.2. In the right pane of the EXPLORE workset, select a node, click the arrow, and select View Node Log.


Table 10:



Severity Severity levels span from zero to five and correspond to:

○ FATAL - (0) Processing cannot continue.○ ERROR - (1) Processing can continue but a serious issue is encoun

tered. May require corrective action on your part.○ WARNING - (2) Bringing your attention to an unusual situation or

event. For example, you may see a warning when you have only 20 percent of memory left.

○ INFO - (3) Information about system activity. No action is required.○ DEBUG - (4) Provides details about the code to assist you in resolving

issues. This may have a negative impact on performance.○ TRACE - (5) Similar to DEBUG but with more details.


3. (Optional) Select Log View Settings from the top right corner of the dialog to select what lines you want to see from the log file, and select Apply Settings.You can choose to retrieve all the lines from the file, the last n lines, lines from the past n days, or lines from certain dates.



3.8.1.3 Viewing the Project Log File

View the log file for a project from the EXPLORE workset.

Context

The project log file records messages about project activity and can help you diagnose issues.

Procedure

1. In the left pane of the EXPLORE workset, expand ESP Nodes and select Projects.2. In the right pane of the EXPLORE workset, select a project, click the arrow, and select View Project Log.


Table 11:



Severity Severity levels span from zero to seven, and display the scale of importance. Zero is the highest severity, and seven is the lowest severity.

For more information on severity levels, see the Logging topic in the SAP Event Stream Processor: Configuration and Administration Guide.


3. (Optional) Select Log View Settings from the top right corner of the window to select what lines you want to see from the log file, and select Apply Settings.You can choose to retrieve all the lines from the file, the last n lines, lines from the past n days, or lines from certain dates.

3.8.2 Viewing SAP ESP Cockpit Server Logs

View event logs for the SAP ESP Cockpit server.

Context

SAP ESP Cockpit logs events to:



● The SAP ESP Cockpit agent log: agent.log● The SAP ESP Cockpit repository log: repository.log

Procedure

1. Navigate to:

Table 12:

Log Platform Location

Agent log Windows %SYBASE%\COCKPIT-4\log\agent.log

Unix $SYBASE/COCKPIT-4/log/agent.log

Repository log Unix $SYBASE/COCKPIT-4/log/repository.log

Windows %SYBASE%\COCKPIT-4\log\repository.log

2. Display one of the log files using a log viewer or a method of your choice.3. Look for entries of interest such as login attempts or the failure of a service to start.

On the SAP ESP Cockpit console and in the agent log file, some components prepend the component name to log entries.

3.8.3 Viewing the SAP ESP Cockpit Client Log

Display the event log for the current session of your SAP ESP Cockpit browser client.

Context

In the SAP ESP Cockpit, do either of the following to display the client log:

● Enter Ctrl+Alt+L.● Open the MONITOR workset and click the warning or error icon in the bottom right of the window.

NoteIf there have been no new warnings or errors since the last time the log was viewed, the icon does not appear.

To exit the client log, press Esc.



3.8.4 Changing the SAP ESP Cockpit Logging Level

Adjust the logging level that determines which events SAP ESP Cockpit records in the server logs. This task requires you to restart SAP ESP Cockpit.

Context

If you are having a problem with SAP ESP Cockpit, you might be able to discover the cause of the problem by changing the server logging level so that more events are recorded.

Procedure

1. Shut down the SAP ESP Cockpit server.2. Restart the SAP ESP Cockpit server using the -m option to change the logging level. In COCKPIT-4/bin,

enter:

cockpit -m <logging-level>

These are the logging levels, from highest to lowest. The higher the level, the more serious an event must be to be logged. Each level includes all the levels above it—for example, if you set the logging level to WARN, you log events for the WARN, ERROR, and FATAL levels.

Table 13: Valid Logging Levels

OFF Nothing is logged. This is the highest level.

FATAL Logs only very severe error events that lead the server to abort. This is the highest level at which events are logged.

ERROR Logs error events that might allow the server to continue running.

WARN Logs potentially harmful situations. WARN is the default logging level during normal operation (that is, after system initialization).

INFO Logs informational messages that track the progress of the server in a coarse-grained fashion. INFO is the default logging level during the system initialization process.

DEBUG Logs a larger set of events that provides a finer-grained picture of how the server is operating. This level is recommended for troubleshooting.

ALL Logs all loggable events. This is the lowest level.

3. Examine the server log for clues about what might be causing the problem.4. When you have resolved the problem, set the logging level back to WARN, the default. Your log may

become unmanageably large if you leave it at the DEBUG or ALL level.

ExampleThese commands, which must be executed in the installation directory, start SAP ESP Cockpit with the logging level set to DEBUG:



Table 14:

Windows Execute:

bin\cockpit -m DEBUG

UNIX Execute:

bin/cockpit -m DEBUG

3.8.5 Changing SAP ESP Cockpit Logging Configuration

Edit the logging configuration file, log4j.properties, to modify SAP ESP Cockpit logging.

Context

You can change the names, locations, or maximum size of the log files as well as the number of log files backed up.

Options for the cockpit command let you change the overall SAP ESP Cockpit log message level when you start SAP ESP Cockpit, but if you choose the DEBUG level, the large volume of log messages generated may be inconvenient. Editing the log properties file gives you finer control; you can set logging levels for each SAP ESP Cockpit component separately. SAP recommends making such changes only if you are familiar with log4j and you are working with SAP technical support; DEBUG-level log messages are not likely to be meaningful to you. (If you have not used log4j before, a good place to start is http://logging.apache.org/log4j/1.2/manual.html .)

Procedure

1. Shut down the SAP ESP Cockpit server.2. Navigate to:

Option Description

Windows %SYBASE%\COCKPIT-4\conf\log4j.propertiesUNIX $SYBASE/COCKPIT-4/conf/log4j.properties

3. Make a backup copy of the log4j.properties file.

4. Open and modify the log4j.properties file as needed.



http://help.sap.com/disclaimer?site=http://logging.apache.org/log4j/1.2/manual.html

http://help.sap.com/disclaimer?site=http://logging.apache.org/log4j/1.2/manual.html

Table 15:

To Modify

Change the name or location of a log file ○ Agent log – log4j.appender.agent.File○ Repository log – log4j.appender.repository.File○ Collection statistics log – log4j.appender.collection-stats.File○ Alert server log – log4j.appender.alert.File○ Gateway log – log4j.appender.gateway.File

Change the maximum size that a log file can reach before SAP ESP Cockpit creates a new file

○ Agent log – log4j.appender.agent.MaxFileSize○ Repository log – log4j.appender.repository.MaxFileSize○ Collection statistics log – log4j.appender.collection-stats.MaxFileSize○ Alert server log – log4j.appender.alert.MaxFileSize○ Gateway log – log4j.appender.gateway.MaxFileSize

Change the number of log files SAP ESP Cockpit backs up before deleting the oldest file

○ Agent log – log4j.appender.agent.MaxBackupIndex○ Repository log – log4j.appender.repository.MaxBackupIndex○ Collection statistics log – log4j.appender.collection-stats.MaxBacku

pIndex○ Alert server log – log4j.appender.alert.MaxBackupIndex○ Gateway log – log4j.appender.gateway.MaxBackupIndex

5. Save and exit the file.6. Start the SAP ESP Cockpit server to make the logging changes take effect.

3.9 Shared-Disk ModeShared-disk mode lets you run multiple SAP ESP Cockpit instances—SAP ESP Cockpit servers, SAP ESP Cockpit agents, or a mixture of the two— from a single installation of the product.

The shared-disk capability enables SAP ESP Cockpit servers or agents on the installation host or on remote hosts to access and execute from the same installation. This feature is especially useful if you plan to use SAP ESP Cockpit to manage SAP® Adaptive Server Enterprise clusters, SAP Event Stream Processor clusters, or SAP® IQ multiplexes.

After installing SAP ESP Cockpit on a shared disk, use the instance command to enable shared-disk mode and deploy instances. instance copies the files needed for the instance into a new directory structure. The path takes the form <COCKPIT-4-install-directory>/instances/<instance-name> (for example, COCKPIT-4/instances/Cockpitserver-1).

You can specify a name for each instance. If you do not supply a name, the instance name defaults to the host name.

An instance runs on the host on which you start it. When shared-disk mode is enabled, SAP ESP Cockpit servers and agents run out of the COCKPIT-4/instances subdirectories, not from the base file system.

In shared-disk mode, changes made to configuration files in the base file system (everything under COCKPIT-4 except the COCKPIT-4/instances branch) are copied to any instance deployed thereafter. Previously deployed instances are not affected.

Use instance to deploy, remove, refresh, or convert an instance; and to configure an instance’s ports; and to configure a Windows instance to run as a service. Perform other tasks, including configuring a UNIX instance



to run as a service, and all other configuration, using the tools and procedures documented for all installations. Use tools provided by the UI wherever possible. When you must edit a file to change the configuration of an instance (for role mapping, for example), edit the copy of the file stored under <COCKPIT-4-install-directory>/instances/<instance-name>.

Related Information

Enabling and Disabling Shared-Disk Mode [page 53]Deploying an Instance from a Shared Disk Installation [page 54]instance Command [page 55]Starting and Stopping an Instance in Windows [page 59]Starting and Stopping an Instance in UNIX [page 61]Refreshing or Converting an Instance [page 63]Removing an Instance [page 64]

3.9.1 Enabling and Disabling Shared-Disk Mode

Turn on or turn off shared-disk mode, which allows you to run multiple SAP ESP Cockpit agents and servers from a single installation on a shared disk.

Prerequisites

Install SAP ESP Cockpit on a shared disk.

Context

Shared-disk mode affects the entire installation; do not enable or disable individual instances.

Disabling shared-disk mode leaves the instances’ file systems intact under <COCKPIT-4-install-directory>/instances, but the instances cannot run. If you reenable, the instances are able to run again.

Procedure

1. Change to COCKPIT-4/bin.

2. Enable or disable shared disk mode.



To enable shared disk mode:

instance -enable To disable shared disk mode:

instance -disable

3.9.2 Deploying an Instance from a Shared Disk Installation

Create an SAP ESP Cockpit server or agent from an installation on a shared disk.

Prerequisites

● Install SAP ESP Cockpit on a shared disk.● Enable shared-disk mode.

Procedure

1. Log in to the host on which you plan to run the SAP ESP Cockpit server or agent.

NoteYou can create an instance on one host and run it on another host, but doing so interferes with the predeployment checks run by instance. Such a deployment might generate errors (port conflicts, for example). If you are confident that the errors are caused by problems that will not be present on the host where you plan to run the instance, use the -force option to create the instance.


3. Create the instance as an SAP ESP Cockpit agent if you plan to run a managed server on this host, or create the instance as an SAP ESP Cockpit server if you plan to manage other SAP servers from this host.

To create an SAP ESP Cockpit agent called Boston-agent and configure it to run as a Windows service:

instance -create -agent -instance Boston-agent -service

To create an SAP ESP Cockpit server called Boston and configure it to run as a Windows service:

instance -create -server -instance Boston -service

On UNIX systems, omit the -service option.

4. If other SAP ESP Cockpit instances will run on this host, change the port assignments for the new instance. Change the instance names and port values in the sample commands to suit your environment, but take care to specify ports that are not in use by another SAP ESP Cockpit instance or any other application or server.



This command changes the port assignments for an SAP ESP Cockpit agent called myagent:

instance -refresh -instance myagent -portconfig rmi=8888,jiniHttp=9093,jiniRmi=9096,tds=9997

This command changes the port assignments for an SAP ESP Cockpit server called myserver:

instance -refresh -server -instance myserver -portconfig rmi=8889,db=3640, http=7072,https=7073,jiniHttp=9094,jiniRmi=9097,msg=2002,tds=9996 5. (Optional) List the instances deployed from this installation:

instance -list 6. (Optional) If you are setting up an instance in UNIX, configure it to run as a service. See Configuring SAP

ESP Cockpit Server as a Service in UNIX.

Next Steps

When you manage and maintain instances, keep in mind that the directory structure for instances is different from that of singleton installations. In file paths in SAP ESP Cockpit help, replace COCKPIT-4 or <COCKPIT-4-install-directory> with COCKPIT-4/instances/<instance-name>.

For example, the path to the log directory, COCKPIT-4/log, becomes this for an instance called kalamazoo:

COCKPIT-4/instances/kalamazoo/log

3.9.3 instance Command

Use instance.bat (Windows) or instance (UNIX) to deploy an instance of SAP ESP Cockpit from a shared-disk installation or to manage existing instances.

You can run multiple instances of SAP ESP Cockpit from a single installation on a shared disk.

Syntax

instance[.bat] [-agent] [-c | -create] [-d | -debug][-disable] [-enable][-f | -force][-h | -help] [-host <host-name>] [-i | -instance [<instance-name>]] [-l | -list] [-plugins {<plugin-ID,plugin-ID,...>}] [-portconfig {<port-name>=<port-number>,<port-name>=<port-number>, ...}]



[-refresh] [-r | -remove] [-s | -server] [-service] [-silent]

Parameters

● -agent use with -create or -refresh to create or refresh an SAP ESP Cockpit agent. In a -create or -refresh command, -agent is the default, so you can omit it.

● -create Deploy a new instance. Use alone or with -agent to create an agent instance, or with -server to create a server instance.

● -d | debug Display debugging messages with the output of this command.● -disable turn off shared-disk mode for this installation. Generates an error if any instance is running. ● -enable Turn on shared-disk mode for this installation. Shared-disk mode is required if you intend to run

more than one server or agent from a single installation of SAP ESP Cockpit.● -f | -force Execute instance even if there are potential conflicts, such as port clashes or a running SAP

ESP Cockpit process. SAP does not recommend using -force to remove or refresh a running instance in a Windows environment.

● -h | --help Display help and usage information for the instance command. ● -host host-name Specify the host for this instance. Use with -create; required only when the instance

name does not match the name of the host on which this instance will run. (The instance name defaults to the name of the current host unless you use -instance to specify another name.)

● -instance [instance-name] Specify an instance. Use with -create, -remove, or -refresh, or use alone to display the instance’s status. You can omit -instance when you are addressing the only SAP ESP Cockpit instance or the only instance of the specified type (server or agent) on the current host.

instance assumes that the host name is the same as the instance name unless you use -host to specify a different host name.

● -l | -list Display a list of all instances deployed from this SAP ESP Cockpit installation.● -plugins {plugin-ID,plugin-ID,...} Specify a product plug-in for this instance. An alternative to -agent and

-server, -plugins is primarily for use by the SAP ESP Cockpit installation program. Use with -create or -refresh.

● -portconfig {port-name=port-number, port-name=port-number, ...} Assign ports to services for this instance. Use only with -create or -refresh. For the <port-name> value, use a port name from the table below. If you plan to run more than one SAP ESP Cockpit instance on a host machine, you must reassign all the ports for every instance after the first.



Port information:

Table 16:



Messaging

Alert


messaging.db.port

alert.database.port

4638







Tds tdsPort 4998

● -refresh recopy all the files that make up this instance (Windows) or all this instance’s services and plug-ins (UNIX). Refreshing preserves any service or plug-in configuration in the deployed instance.

You can also use -refresh to convert a server to an agent or an agent to a server (see the examples). Files are removed or added to change the function of the instance. Use alone or with -agent to refresh an agent instance, or with -server to refresh a server instance. Generates an error if the instance is running.

● -r | -remove delete an instance. Use alone or with -instance. Generates an error if the instance is running. You cannot restore a removed instance.

● -s | -server use with -create or -refresh to create or refresh an SAP ESP Cockpit server, including any product modules available.

● -service use with -create or -remove to create or remove a Windows service for this instance. You must be logged in to Windows as an administrator to use this option.

● -silent suppress the output of instance.

Examples

Deploy an SAP ESP Cockpit server instance

enables shared-disk mode, deploys a server called Boston with a Windows service on the current host, and starts the Windows service:

instance -enable instance -create -server -instance Boston -service net start "Cockpit 4 (Boston)"



NoteTo create the service, you must log in to Windows as an administrator.

Deploy an SAP ESP Cockpit agent instance

deploys an SAP ESP Cockpit agent on this host and configures a Windows service for it. The -agent option, because it is the default, is not required—the command does exactly the same thing without it.

instance -create -agent -service

or

instance -create -service

Deploy a server instance and reassign ports

deploys the server on this host and configures nondefault RMI, HTTP, and HTTPS ports.

instance -create -server -portconfig rmi=8888,http=7070,https=7071

Deploy two instances on the same host

creates two agent instances on the host fireball. The first command does not need the -host option because the instance name is the same as the host name.

instance -create -agent -instance fireball -portconfig rmi=4993 instance -create -agent -instance fireball2 -host fireball -portconfig rmi=4994

NoteIn a production environment, SAP recommends that you deploy no more than one SAP ESP Cockpit instance of each type (one server and one agent) on the same host.

Refresh a server instance or convert an agent to a server

refreshes the server on this host. If the instance on this host is an SAP ESP Cockpit agent, refreshing it as an SAP ESP Cockpit server converts it into a server.

instance -refresh -server

Refresh an agent instance or convert a server to an agent

refreshes the instance named kalamazoo. If kalamazoo is a server, refreshing it as an SAP ESP Cockpit agent converts it into an agent.

instance -refresh -agent -instance kalamazoo

Remove a server instance

removes the instance named porcupine if it is not running:

instance -remove -instance porcupine



Display status

displays the status of the instance on this host:

instance

List all instances

displays a list of all SAP ESP Cockpit server and agent instances deployed from this SAP ESP Cockpit installation:

instance -list

Scenario: Remove an instance by force

suppose you have inadvertently deployed two SAP ESP Cockpit agent instances on the same host:

$ instance -list 2 instances deployed:Cockpit instance node1 deployed in agent mode for host node1 RMI port 4992Cockpit instance node2 deployed in agent mode for host node2 RMI port 4992

Both instances use the same RMI port. You must either reassign ports for one instance or remove it. But you get an error if you try remove an instance when another instance is running on the same host:

$ instance -instance node2 -remove [ERROR] Command execution failed.[ERROR] Cockpit instance node2 could not be removed because it is running. Shut down the Cockpit before removing the instance.

Use the -force option to override the error and force the removal of the second agent instance:

$ instance -instance node2 -remove -force Removing Cockpit instance node2 ... Cockpit instance node2 was successfully removed.

Permissions

instance uses the permissions of the user, except as noted for certain parameters.

3.9.4 Starting and Stopping an Instance in Windows

There are several ways to start and stop the SAP ESP Cockpit server instance. You can do it manually, or set the service to start automatically and to restart in case of failure.

You can omit the -instance option if the instance’s name is the same as its host name (the default).



Start and Stop the Server Instance Manually


1. To start the SAP ESP Cockpit server instance, execute:

%SYBASE%\COCKPIT-4\bin\cockpit.bat -instance <instance-name>

2. To stop the SAP ESP Cockpit server instance, at the cockpit console command prompt, execute:

shutdown

Start and Stop the Server Service Instance


1. To configure automatic restart of the service instance:

1. In Windows Control Panel, open System and Security Administrative Tools Services .2. Locate “Cockpit” in the Services list. It may be followed by a release number; if the service is for an

instance, it is also followed by the instance name. Service names do not distinguish between agents and servers. If the service is running, the Status column displays “Started.”

3. Click the Recovery tab and change the First, Second, and Subsequent failures to Restart the Service.4. Click OK.

2. To manually start the service instance:

Table 17:


Click Start.

At a command line

Including the instance name in parentheses, execute:

net start "Cockpit 4 (<instance-name>)"

The Cockpit 4 (<instance-name>) service is starting...... The Cockpit 4 (<instance-name>) service was started successfully.

3. To manually stop the service instance:

Table 18:


Click Stop.



At a command line

Including the instance name in parentheses, execute:

net stop "Cockpit 4 (<instance-name>)"

The Cockpit 4 (<instance-name>) service is stopping...... The Cockpit 4 (<instance-name>) service was stopped successfully.

3.9.5 Starting and Stopping an Instance in UNIX

There are several ways to start and stop the SAP ESP Cockpit server instance. You can do it manually, or set the service to start automatically and to restart in case of failure.


Start and Stop the Server Instance Manually

You can start the SAP ESP Cockpit server in the foreground or background. When you run SAP ESP Cockpit server in the background, you can use nohup, &, and > to redirect output and system error to a file, and suppress the Cockpit server console.

1. Set the environment variables. Do this only once.1. Execute one of the following to set environment variables.

Bourne shell:

. SYBASE.sh

C shell:

source SYBASE.csh

2. To start the SAP ESP Cockpit server, do one of:

Table 19:

In the foreground Execute:

$SYBASE/COCKPIT-4/bin/cockpit.sh -instance <instance-name>



In the background Execute a command similar to the sample below that matches your shell. The sample command directs output to the file cockpit-console.out. If the output file already exists, you might need to use additional shell operators to append to or truncate the file.

Bourne shell (sh) or Bash

nohup ./cockpit.sh -instance <instance-name> 2>&1 > cockpit-console-your-instance.out &

C shell

nohup ./cockpit.sh -instance <instance-name> >& cockpit-console.out &

3. To stop the SAP ESP Cockpit server:

Table 20:

Run in the foreground

At the cockpit-console> prompt, execute:

shutdown <instance-name>

CautionDo not enter shutdown at a UNIX prompt; it shuts down the operating system.

Run in the background

At the UNIX command line, execute:

$SYBASE/COCKPIT-4/bin/cockpit.sh --stop -instance <instance-name>

Start and Stop the Service for an Instance

A UNIX service is a daemon process that starts automatically after the machine is started and runs in the background. UNIX installations of Cockpit include a shell script, cockpitd, which you can use to configure the Cockpit service. (Some UNIX platforms supply tools that make service configuration easier; Linux chkconfig is an example.)

NoteSAP recommends that if you are not familiar with setting up services in UNIX, you delegate this task to a system administrator or consult the system administration documentation for your UNIX platform.



1. Open cockpit and make these changes:○ Change the line that sets the SYBASE variable to the location of your SAP installation (that is, the

parent directory of COCKPIT-4, the SAP ESP Cockpit installation directory). By default, this directory



is called /opt/Sybase if you installed Cockpit on a machine with an existing Sybase or SAP Sybase product or environment variable; otherwise the default parent directory is /opt/sap.

○ If you are using shared-disk mode to run multiple instances on the same host, append the instance name to the name of the output log file. Change:

./${SCRIPT_NAME} --start 2>&1 >> ${cockpit_HOME}/log/cockpit-service.out &

to:

./${SCRIPT_NAME} --start 2>&1 >> ${cockpit_HOME}/log/cockpit-service_<instance-name>.out &

○ If you are using shared-disk mode to run multiple instances on the same host, save a copy of the cockpitd script for each instance, giving each copy a unique name. In each copy, add the instance name to the script name and append the instance name to the output log file name as described above. Perform the remaining steps in this procedure for each copy of cockpitd.

2. In Linux, configure the service to run in run levels 2, 3, 4, and 5. Execute:

/sbin/chkconfig --add cockpitd /sbin/chkconfig cockpitd 2345

You can test the cockpitd script with /sbin/service cockpitd status. (The service command accepts these options: start | stop | status | restart.) For example, to start the Cockpit, enter /sbin/service cockpitd start.

3.9.6 Refreshing or Converting an Instance

Refresh an SAP ESP Cockpit server or agent deployed from an installation on a shared disk, or convert between server and agent.

Prerequisites

Shut down the instance.

Context

When you refresh an instance of an SAP ESP Cockpit server or agent, SAP ESP Cockpit recopies files from the main installation on the shared disk (COCKPIT-4/) into the instance’s subdirectories (COCKPIT-4/instances/<instance-name>). In Windows, SAP ESP Cockpit recopies all the files that make up this instance; in UNIX, it recopies all this instance’s services and plug-ins.

Refreshing an instance preserves configuration and logs but overwrites the repository, so historical performance data is lost.

As part of a refresh, you can:



● Convert a server to an agent● Convert an agent to a server● Reassign ports on the instance

Converting from an agent to a server adds server-related files to the instance; converting from a server to an agent removes files.

Procedure


2. Refresh the instance. Change the instance names and port values in the sample commands to suit your environment, but take care to specify ports that are not in use by another SAP ESP Cockpit instance or any other application or server.

This command refreshes an SAP ESP Cockpit server called boston. If boston is an agent, it becomes a server after the refresh.

instance -refresh -server -instance boston

This command refreshes an SAP ESP Cockpit agent called kalamazoo. If kalamazoo is a server, it becomes an agent after the refresh.

instance -refresh -agent -instance kalamazoo

This command refreshes an SAP ESP Cockpit agent called kalamazoo and reassigns kalamazoo’s RMI and TDS ports. If kalamazoo is a server, it becomes an agent after the refresh.

instance -refresh -agent -instance kalamazoo -portconfig rmi=7070,tds=7071

3. (Optional) Display the status of the refreshed instance. Replace the name in the sample command with your instance’s name, or omit the -instance option to display the status of the instance on this host.

instance -instance kalamazoo

3.9.7 Removing an Instance

Delete an SAP ESP Cockpit server or agent deployed from an installation on a shared disk.

Prerequisites

Shut down the instance.



Context

Removing an SAP ESP Cockpit instance deletes the instance’s files and directories (COCKPIT-4/instances/<instance-name> and its contents) from the installation.

You cannot restore a removed instance.

Procedure


2. Remove the instance. Change the instance name in the sample command to suit your environment.

This command removes the cockpit server porcupine if it is not running; if it is running, you see an error.

instance -remove -instance porcupine

This command removes the COCKPIT-4 agent on the current host if it is not running. If the agent is running, the command returns an error.

instance -remove

3.10 Configuring Ports

Use the cockpit --port command to assign SAP ESP Cockpit services to new ports.

Prerequisites

Check for port conflicts between SAP ESP Cockpit and other software running on the same host.

Context

SAP ESP Cockpit cannot function properly if other services use its ports. If you discover a conflict with any port listed in the right column below, you can either reconfigure the other service’s port or reconfigure SAP ESP Cockpit as described here.



Table 21:



Messaging

Alert


messaging.db.port

alert.database.port

4638







Tds tdsPort 4998

Procedure

1. Shut down SAP ESP Cockpit.2. Execute cockpit --info ports to display a list of SAP ESP Cockpit services, their properties, and their

assigned ports.3. To reassign a port, enter a command in one of these formats:

cockpit --port <port-name>=<port-number>cockpit --port <service-name>:<property-name>=<port-number>

Use the first, simpler format unless you want to configure the database services to use different ports. (By default, all the database services use the same port.)

4. Start SAP ESP Cockpit.5. Execute cockpit --info ports again to confirm that the port has been reassigned.

ExampleSet all three database services (data server, messaging, and database alert) to the same port, 4639. (The database services belong to the internal repository.)

cockpit --port db=4639

Set only the database messaging service to port 4639.

cockpit --port Messaging:messaging.db.port=4639



Set the HTTP port to 9292.

cockpit --port http=9292

Set the main SAP ESP Cockpit messaging service to port 4994.

cockpit --port msg=4994

Set the RMI port to 4993

cockpit --port rmi=4993

Set the Tabular Data Stream port to 4997.

cockpit --port tds=4997

Notecockpit commands that include a port-setting option (-p or --port) do not start SAP ESP Cockpit. To start SAP ESP Cockpit, execute a separate cockpit command.

3.11 Configuring Memory Usage

Determine whether you need to configure how much memory SAP ESP Cockpit uses, and if so which configuration method to use.

Context

It is not usually necessary to configure memory usage for SAP ESP Cockpit. This table lists memory options you can set and circumstances under which you should consider changing them.



Table 22: Memory Options

Value Modify When Guidelines

Maximum memory

● jvmopt=-Xmx – if you are running SAP ESP Cockpit as a Windows service

● COCKPIT_MEM_MAX – if you are running Cockpit as a UNIX service

● COCKPIT_MEM_MAX – if you are starting Cockpit from the command line

● You need to prevent SAP ESP Cockpit from using more than a given amount of memory.

● SAP ESP Cockpit fails to start and may display an error: Could not create the Java Virtual machine.

● An OutOfMemory error says SAP ESP Cockpit is out of heap space.

● A warning message about system memory appears during the start process.

● The machine where SAP ESP Cockpit is installed has less than 4GB of memory. (Starting SAP ESP Cockpit on a machine with less than 4GB of memory triggers the startup warning message about system memory.)

On machines with less than 4GB of memory, set maximum memory to 256MB or more.

Default value: none. (On machines with 4GB or more of memory, maximum memory is set dynamically and is effectively limited only by the amount of system memory available.)

Permanent memory

● jvmopt=-XX:MaxPermSize – if you are running SAP ESP Cockpit as a Windows service

● COCKPIT_MEM_PERM – if you are running Cockpit as a UNIX service

● COCKPIT_MEM_PERM – if you are starting Cockpit from the command line

An OutOfMemory error says SAP ESP Cockpit is out of permanent generation space.

Increase by 32MB increments. If you reach a value equal to twice the default and still see the OutOfMemory error, contact SAP technical support.

Default value: 128MB

You can change memory options in two ways:

● For SAP ESP Cockpit started from the command line – execute commands to set one or more environment variables before executing the cockpit command to start SAP ESP Cockpit. When you use this method, your changes to the memory options last only as long as the current login session. This method is useful for testing new option values.

● For the SAP ESP Cockpit service – modify a file used by the SAP ESP Cockpit service. When you use this method, your changes to the memory options persist—SAP ESP Cockpit uses them every time it starts as a service.

Related Information

Changing a Memory Option on the Command Line [page 69]Changing a Memory Option for an SAP ESP Cockpit Windows Service [page 69]Changing a Memory Option for an SAP ESP Cockpit UNIX Service [page 70]



3.11.1 Changing a Memory Option on the Command Line

Before you start SAP ESP Cockpit from the command line, you can issue a command to change the value of a memory option temporarily.

Context

Changes made using this method last only as long as the current login session. This method is useful for testing new option values.

Procedure

1. If SAP ESP Cockpit server is running, shut it down.2. Set the environment variable. Specify a size in megabytes, but do not indicate the units in the command.

Windows example:

> set COCKPIT_MEM_MAX=512

UNIX example:

bash$ export COCKPIT_MEM_MAX=512

3. Use the cockpit command to start SAP ESP Cockpit server.

3.11.2 Changing a Memory Option for an SAP ESP Cockpit Windows Service

Add a jvmopt command to the cockpit.properties file to change a memory option (-Xmx or -XX:MaxPermSize) for an SAP ESP Cockpit Windows service.

Context

When you use this method to set memory options, your changes are permanent—SAP ESP Cockpit uses them every time it starts as a service.



Procedure

1. If SAP ESP Cockpit server is running, shut it down.2. Open the SAP ESP Cockpit properties file:

%SYBASE%\COCKPIT-4\bin\cockpit.properties3. Add (or modify, if it already exists) a jvmopt line specifying the memory size in Java format. Use m for

megabytes or g for gigabytes.For example:

jvmopt=-Xmx512m

4. Save the file and start the SAP ESP Cockpit Windows service.

3.11.3 Changing a Memory Option for an SAP ESP Cockpit UNIX Service

To change a memory setting for an SAP ESP Cockpit UNIX service, add the appropriate environment variable (<COCKPIT_MEM_MAX> or <COCKPIT_MEM_PERM>) to the cockpit.sh script.

Context

When you use this method to set memory options, your changes are permanent—SAP ESP Cockpit uses them every time it starts as a service.

Procedure

1. If SAP ESP Cockpit is running, shut it down.2. Navigate to $SYBASE/COCKPIT-4/bin and open cockpitd.

3. Add the environment variable at the top of the file (after the comments). Specify a size in megabytes but do not indicate the units in the command.For example:

COCKPIT_MEM_MAX=512

4. Save the file and start the SAP ESP Cockpit UNIX service.



3.12 SAP ESP Cockpit User Management

Manage user information, such as name, phone, and email addresses, disable or enable users, or delete users.

Any valid user in the managed system can log in to SAP ESP Cockpit. You cannot prevent a valid user from initially logging in to a managed system, but you can disable subsequent access. You can also maintain e-mail addresses for alert notification.

Related Information

Disabling and Enabling a User in SAP ESP Cockpit [page 71]Deleting a User in SAP ESP Cockpit [page 72]Defining an E-mail Address in SAP ESP Cockpit [page 73]Updating User Information in SAP ESP Cockpit [page 73]

3.12.1 Disabling and Enabling a User in SAP ESP Cockpit

Prevent a valid user in a managed system from logging in to SAP ESP Cockpit or allow a previously disabled user to log in again.

Prerequisites


Context

You cannot prevent a valid managed system user from initially logging into SAP ESP Cockpit, but you can prevent subsequent access.

TipDo not use the technical user account to log in to SAP ESP Cockpit. To enforce this, SAP recommends that you disable this account in SAP ESP Cockpit. Disabling the technical user account has no impact on the account's ability to collect data.



Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select User Management, and then select the General tab.3. Select or clear Login disabled.4. Click OK.

3.12.2 Deleting a User in SAP ESP Cockpit

Remove a user from the list of registered SAP ESP Cockpit users.

Prerequisites


Context

NoteUse extreme care when deleting a user from SAP ESP Cockpit. Do not delete the technical user account.

There should be little need to delete users under User Management as doing so does not prevent access to SAP ESP Cockpit. To prevent a user from accessing SAP ESP Cockpit, disable the users.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select User Management.3. In the right pane, click Delete.4. At the confirmation prompt, click Yes.5. Click OK.



3.12.3 Defining an E-mail Address in SAP ESP Cockpit

Add a user's e-mail address to be used for alert notification.

Prerequisites


Context

If you enter an e-mail address under ALERT NOTIFY , the cockpit automatically updates the user record under User Management, and vice versa.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select User Management, and then select the User Info tab.3. Add a valid email address and click OK.

3.12.4 Updating User Information in SAP ESP Cockpit

Add details such as name, phone, and e-mail address for a user who has successfully logged in to a managed system.

Prerequisites




Context

NoteUser information is stored in the SAP ESP Cockpit repository. It is not updated to the user account in the managed system.

Procedure

1. In SAP ESP Cockpit, click the Cockpit Settings icon ( ).2. In the left pane, select User Management, and then select the User Info tab.3. Add the user information and click OK.

3.13 SAP ESP Cockpit Console

The console is a command-line interface for displaying details about the status of the SAP ESP Cockpit server, its ports, plug-ins, and services.

When you use the cockpit command to start SAP ESP Cockpit, it displays start-up messages and then displays the console prompt.

NoteThe console prompt does not appear if you start SAP ESP Cockpit as a service, if you direct the output of cockpit to a file, or if you start SAP ESP Cockpit in the background.

Related Information

Console Commands [page 74]

3.13.1 Console Commands

Use the SAP ESP Cockpit console to get status information on SAP ESP Cockpit and its ports, plug-ins, and services.

help Command [page 75]Display syntax information for one or more SAP ESP Cockpit console commands.



info Command [page 75]Display information about specified parts of the SAP ESP Cockpit server.

shutdown command [page 76]Stop the SAP ESP Cockpit server if it is running.

status Command [page 77]Display the status of the SAP ESP Cockpit agent, plug-in, or service components of SAP ESP Cockpit.

3.13.1.1 help Command

Display syntax information for one or more SAP ESP Cockpit console commands.

Syntax

help [<command_name>]

Parameters

● command_name (Optional) Use with status, info, or shutdown. If you omit <command_name>, help returns information on all the console commands.

Examples

Example 1

This help command returns information on the status command:

help status

3.13.1.2 info Command

Display information about specified parts of the SAP ESP Cockpit server.If you enter info with no parameters, it returns information for every parameter.



Syntax

info [-a | --sys] [-D | --sysprop [<system-property>]] [-e | --env [<environment-variable>]] [-h | --help][-m | --mem][-p | --ports][-s | --services]

Parameters

● -a | --sys (Optional) List all the services known to SAP ESP Cockpit, indicate whether each service is enabled, and list other services on which each service depends.

● -D | --sysprop [system-property] (Optional) Display information about the specified Java system property. Omit the system-property argument to return a list of all Java system properties and their values.

● -e | --env [environment-variable] (Optional) List all the environment variables in the SAP ESP Cockpit Java VM process environment. Omit the environment-variable argument to return a list of environment variables and their values.

● -h | --help (Optional) Display information about the info command. ● -m | --mem (Optional) Display information about the server’s memory resources. ● -p | --ports (Optional) List all the ports on which the SAP ESP Cockpit agent and its services listen,

indicate whether each port is in use, and show the service running on each port.● -s | --services (Optional) Llist all SAP ESP Cockpit services, indicate whether each service is enabled, and

list other services on which each service depends.

Examples

Example 1

Displays information about ports on this SAP ESP Cockpit server:

info -p

3.13.1.3 shutdown command

Stop the SAP ESP Cockpit server if it is running.



Syntax

shutdown

Examples

Example 1

Shuts down SAP ESP Cockpit:

shutdown

3.13.1.4 status Command

Display the status of the SAP ESP Cockpit agent, plug-in, or service components of SAP ESP Cockpit.

Syntax

status [-a | --agent] [-h | --help] [-p | --plugin [<plugin-name>]] [-s | --service [<service-name>]]

Parameters

● -a | --agent Display the status of the SAP ESP Cockpit agent component.● -h | --help Display information about the info command. ● -p | --plugin [plugin-name] Display the status of the specified SAP ESP Cockpit plug-in. Omit the plugin-

name argument to return a list of plug-ins.● -s | --service [service-name] Display the status of the specified SAP ESP Cockpit service (for example,

the Alert service or the Messaging service). Omit the service-name argument to return a list of services.



Examples

Example 1

Displays status information on the Repository service:

status --service Repository

3.14 Changing the UAFADMIN or SCCADMIN Password

You can change the password of the SCCADMIN and UAFADMIN (SAP ESP Cockpit agent) accounts.

Prerequisites

You have already encrypted the new password. See Encrypting a Password [page 79].

Procedure

1. In a text editor, open the csi_config.xml file:

Option Description

Windows %SYBASE%\COCKPIT-4\conf\csi_config.xmlUNIX $SYBASE/COCKPIT-4/conf/csi_config.xml

2. Search for the account name: Default SCC agent admin account: uafadmin or sccadmin.

3. Paste the new encrypted password into the value field of the password line. It looks similar to this—be sure to paste inside the double quotes:

<options name="password" value="{SHA-256:WNATpqw76zA=}GYeAKdTRiIh1VcqmWv1k/A2pcXSHfLUBr9boP03ArKE=" />

4. Save the file and exit.5. To make the new password take effect, restart the SAP ESP Cockpit server or agent on which the changes

were made.

Related Information

Encrypting a Password [page 79]



3.14.1 Encrypting a Password

Use the passencrypt utility to encrypt passwords and other values that must be kept secure while stored in text files.

Context

You can safely store an encrypted password in a configuration file. Enter the password in clear text (unencrypted) when you execute passencrypt and when you use the password to log in.

passencrypt, which is located in the COCKPIT-4\bin directory, uses the SHA-256 hash algorithm for passwords used in the PreConfiguredLoginModule in csi_config.xml.

Procedure

1. Open a command window and change to the COCKPIT-4\bin directory:

2. Type passencrypt -csi. Enter your new password at the resulting prompt.passencrypt encrypts the password you enter (which does not appear on the screen) and displays the password in encrypted form.

3. Copy the encrypted password.4. Paste the encrypted password where needed.



4 Monitor SAP Event Stream Processor

Use the SAP ESP Cockpit to monitor the SAP Event Stream Processor environment. Ensure you have the required read permission in ESP to be able to complete monitoring tasks using SAP ESP Cockpit.

Related Information

Viewing Overview Statistics [page 80]Viewing Cluster Overview Statistics [page 82]Viewing All Statistics [page 84]Viewing Project Statistics [page 85]Viewing Stream Statistics [page 86]Viewing Connections Statistics [page 87]Viewing Adapter Statistics [page 88]Viewing Publisher Statistics [page 90]Viewing Subscriber Statistics [page 91]Viewing Bindings [page 92]

4.1 Viewing Overview Statistics

Use the Overview page to monitor overall statistics and view alerts for the current node.

Prerequisites



Procedure

1. Select the MONITOR workset, then the Overview page.Information and statistics display for the current node you are monitoring.


SAP Event Stream Processor: Cockpit GuideMonitor SAP Event Stream Processor

Table 23:


CPU History Line graph displaying the percentage of total CPU usage over time. The data on the graph starts displaying from the time you select the Overview page.

Memory Usage History Line graph displaying total memory usage over time, in kilobytes (KB). The data on the graph starts displaying from the time you you select the Overview page.

Thread Usage History Line graph displaying number of threads used over time. The data on the graph starts displaying from the time you you select the Overview page.

2. Select either the Node or Alerts workset:

Table 24:

Page Tab Statistics

Node State - valid values are running or unknown.

Name - name of the ESP node.

Host - the host on which the ESP server is currently running.

Port - the port on which the ESP server is currently running.

Node type - whether node is a manager or controller.

Node version - the version of SAP Event Stream Processor. For example, version 5.1 SP08 displays as 5.1.08.00.

Platform - platform of the machine that the node is on.



Page Tab Statistics

Alerts The following statistics display above this table:○ Rows - number of rows belonging to the node.○ Criticals - the number of critical alerts triggered for

the node.○ Warnings - the number of warning alerts triggered for

the node.

This is the header table containing all alerts that have fired for the ESP node after you select the Overview page.







4.2 Viewing Cluster Overview Statistics

Use the Cluster page to monitor overall statistics, alerts, and topology for the cluster to which the current node you are monitoring belongs.

Prerequisites





Procedure

1. Select the MONITOR workset, then the Cluster page.Information and statistics display for the overall cluster to which the node you are monitoring belongs.

Table 25:


CPU History Line graph displaying the percentage of total CPU usage over time. The data on the graph starts displaying from the time you select the Cluster page.

Memory Usage History Line graph displaying total memory usage over time, in kilobytes (KB). The data on the graph starts displaying from the time you select the Cluster page.

Thread Usage History Line graph displaying number of threads used over time. The data on the graph starts displaying from the time you select the Cluster page.

2. Select the Overview, Nodes, or Topology page tab:

Table 26:

Page Tab Statistics

Overview The following statistics display above this table:○ Rows - number of rows belonging to the node.○ Criticals - the number of critical alerts triggered for the node.○ Warnings - the number of warning alerts triggered for the

node.

Includes an Alerts header table which contains information for all alerts that have fired on the cluster after you select the Cluster page:




Node - name of the ESP node.






Page Tab Statistics

Node Includes a Nodes header table which contains information for all nodes which belong to the cluster.

Node name of the ESP node.Host the host on which the ESP server is currently running.Port the port on which the ESP server is currently running.Role whether the node is a manager, controller, or manager and controller node.Status valid values are running or unknown.Authenticated whether node is authenticated. Valid values are true or false.

Also includes a Node Details table which specifies this information:

Node name of the ESP node.Version the version of SAP Event Stream Processor. For example, version 5.1 SP08 displays as 5.1.08.00.Build Information the build version of SAP Event Stream Processor.Platform platform of the machine that the node is on.

Topology Visual display of all nodes belonging to the cluster, including node name and its role.

4.3 Viewing All Statistics

Use the All Statistics page to monitor overall statistics of the current ESP node.

Prerequisites



Procedure

Select the MONITOR workset, then the All Statistics page.Information and statistics display for the projects, streams, connections, adapters, publishers, and subscribers on the node you are currently monitoring.



4.4 Viewing Project Statistics

Use the Projects page to monitor the performance of ESP projects belonging to the current node. View statistics such as CPU, memory, and thread usage, and rows received and sent.

Prerequisites



Procedure

1. Select the MONITOR workset, then the Projects page.

Table 27:

Table Name Statistics

Projects This is the header table containing all projects within the current node you are monitoring.

Workspace Name - name of workspace to which the project belongs.

Project Name

Status - project status. Valid values are running, stopped, or unknown.

These statistics display for the project you select in the header table:

Table 28:

Tab Statistics

System The data on the graph starts displaying from the time you open the Projects page.

CPU History - line graph displaying the percentage of total CPU usage over time.

Memory Usage History - line graph displaying total memory usage over time, in KB.

Thread Usage History - line graph displaying number of threads used over time.



Tab Statistics

Network Rows Transferred History - line graph displaying rows received and rows sent per second over time.

The data on the graph starts displaying from the time you open the Projects page.

Connections History - line graph displaying total number of publishers, subscribers, and connections over time.

2. In the table, select a project, click the arrow, and select Project Properties.A new window displays and contains the following statistics for the project you selected:○ Workspace (name of workspace to which the project belongs)○ Project○ Status (project status; valid values are running, stopped, or unknown)○ Command Host (physical host on which the project is running)○ Command Port (command port on which the project command control gateway is listening)○ Gateway Host○ Gateway Port○ SQL Port (port assigned to the project instance for serving SQL query requests)○ SSL Enabled○ Big Endian○ Address Size (the size, in bytes, of a memory address on the deployed architecture)○ Data Size (the size, in bytes, of the date datatype on the deployed architecture)○ Money Precision○ WS Enabled (whether the ESP project is enabled for Web service access)○ Timer Interval (the value in the ESP project "timer-granularity" option)○ Active-Active (whether the project is running in active-active or high availability mode)

4.5 Viewing Stream Statistics

Use the Stream page to monitor the performance of streams belonging to the current ESP node. View statistics such as CPU history and number of rows processed.

Prerequisites





Procedure

Select the MONITOR workset, then the Streams page.

Table 29:

Table Name Stream Details

Streams This is the header table displaying information for all streams on the current ESP node.

Workspace - name of workspace on which the stream is running.

Project - name of project to which the stream is attached.

Stream - name of stream attached to the project running on the node.

Type - The type of the stream. Possible values are stream, keyed stream, window, or metadata.

Queue Depth - the number of rows waiting to be processed.

Rows In Store - the current number of records in the stream's store.

Visibility - The visibility of the stream. Valid values are input, output, local, or intermediate.

These statistics display for the stream you select in the header table:

Table 30:


Rows Transferred History A line graph displaying the number of rows processed per second.

CPU History A line graph displaying the percentage of total CPU usage over time.

The data on the graph starts displaying from the time you select the Stream page.

4.6 Viewing Connections Statistics

Use the Connections page to monitor the performance of publishers and subscribers belonging to the current ESP node. View connection statistics such as number of rows received and sent.

Prerequisites





Procedure

Select the MONITOR workset, then the Connections page.

These statistics display in line graphs:

Table 31:

Line Graph Description

Connections History Line graph displaying the total number of connections to the node.

Publishers and Subscribers History Line graph displaying the number of publishers and number of subscribers of the node.

Rows Transferred History Line graph displaying rows received and rows sent per second.

The data on the graph starts displaying from the time you select the Connections page.

4.7 Viewing Adapter Statistics

Use the Adapters page to monitor the performance of adapters belonging to the current node. View statistics such as numbers of rows processed.

Prerequisites



Procedure

Select the MONITOR workset, then the Adapters page.



Table 32:

Table Name Adapter Details

Adapters This is the header table containing all adapters within the current node you are monitoring.

Workspace - name of workspace on which the project is running.

Project - name of project to which the adapter is attached.

Name - name of the adapter.

Status - adapter status. Valid values are initial, stopped, ready, continuous, idle, done, or unknown.

Stream - the stream in which the adapter operates.

Type - the unique adapter ID assigned to each adapter. For example, sybase_ase_out or sybase_iq_out. See the SAP Event Stream Processor: Adapters Guide for more information.

In/Out - displays whether the adapter is an input or output adapter.

Group - the adapter group to which the adapter belongs.

These statistics display for the adapter you select in the header table:

Table 33: Common Statistics

Name Value

AdapterTotalRows Total number of rows in the adapter.

AdapterGoodRows Number of good rows in the adapter.

AdapterBadRows Number of bad rows in the adapter.

AdapterLastErrDate The date of the last error. The format is dow mon dd hh:mm:ss zzz yyyy where:○ dow is the day of the week○ mon is the month (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep)○ dd is the day of the month (01 through 31)○ hh is the hour of the day (00 through 23)○ mm is the minute within the hour (00 through 59).○ ss is the second within the minute (00 through 61)○ zzz is the time zone (and may reflect daylight saving time). Standard time zone

abbreviations include those recognized by the method parse. If time zone information is not available, then zzz is empty meaning it consists of no characters at all.

○ yyyy is the year.

AdapterLastErrMsg The message of the last error.

AdapterLatency Time taken for data to be processed.

Table 34: Extended Statistics

Name Value

<Custom Statistic Name> If the adapter you select has custom statistics to report, these display here. Note that not all adapters have custom statistics.



4.8 Viewing Publisher Statistics

Use the Publishers page to monitor the performance of publishers belonging to the current ESP node. View statistics such as CPU history and number of rows sent.

Prerequisites



Procedure

Select the MONITOR workset, then the Publishers page.

Table 35:

Table Name Publisher Details

Publishers This is the header table containing information for all publishers belonging to the current ESP node.

Workspace - name of workspace to which the project belongs.

Project - name of the project to which the publisher is connected.

IP Address - IP address of the publisher.

Port - port number on the publisher's machine used to send subscribed data to Event Stream Processor.

These statistics display for the publisher you select from the header table:

Table 36:


CPU History Line graph displaying the percentage of total CPU usage over time. The user CPU usage and system CPU usage are also shown on this line graph.

The data on the graph starts displaying from the time you select the Publishers page.

Rows Transferred History Line graph displaying rows sent per second.

The data on the graph starts displaying from the time you select the Publishers page.



4.9 Viewing Subscriber Statistics

Use the Subscribers page to monitor the performance of subscribers belonging to the current ESP node. View statistics such as CPU and rows received history.

Prerequisites



Procedure

Select the MONITOR workset, then the Subscribers page.

Table 37:

Table Name Subscriber Details

Subscribers This is the header table containing information for all subscribers on the current ESP node.

Workspace - name of the workspace to which the subscriber is connected.

Project - name of the project to which the subscriber is connected.

Stream - name of the data stream to which the subscriber is subscribed.

IP Address - IP address of the subscriber.

Port - port number on the subscriber's machine used to receive published data from Event Stream Processor.

Queue Depth - number of rows waiting to be received by the subscriber.

Rows in Store - number of rows in the subscriber's data store.

These statistics display for the subscriber you select from the header table:

Table 38:


CPU History Line graph displaying the percentage of total CPU usage over time. The user CPU usage and system CPU usage are also shown on this line graph.

The data on the graph starts displaying from the time you select the Subscribers page.




Rows Received Line graph displaying rows received per second.

The data on the graph starts displaying from the time you you select the Subscribers page.

4.10 Viewing Bindings

View information for any bindings that are present on the node you are monitoring.

Prerequisites



Procedure

1. Select the MONITOR workset, and then the Adapters page.

Information for bindings is grouped into the same table that lists adapter information. If a row is displaying information for a binding rather than an adapter, the Type column will list Binding as the value.



Table 39:

Table Name Binding Details

Adapters If a row is displaying a binding:

Workspace - name of workspace on which the project to which the binding is attached is running.

Project - name of the project to which the binding is attached.

Name - name of the binding.

Status - the current status of the binding. Valid values are initial, stopped, ready, continuous, idle, done, or unknown.

Stream - stream name of the project to which the binding is attached.

Type - if the row is displaying a binding rather than an adapter, the value of this column is Binding.

In/Out - indicates whether the binding is input or output.

Group - this column is empty for bindings.

2. Select Binding Properties.

A dialog box displays the Binding Properties:

Table 40:

Property Description

Source Cluster Name Cluster related to the input or output stream from which the binding is connected.

Source Workspace Name Workspace related to the input or output stream from which the binding is connected.

Source Project Name Project related to the input or output stream from which the binding is connected.

Source Stream Name Input or output stream from which the binding is connected.

Target Cluster Name Cluster related to the stream to which the binding is connected.

Target Workspace Name Workspace related to the stream to which the binding is connected.

Target Project Name Project related to the stream to which the binding is connected.

Target Stream Name Stream to which the binding is connected.



5 Administering SAP Event Stream Processor

Use the SAP ESP Cockpit to administer the SAP Event Stream Processor environment. Ensure you have the required read and admin permissions in ESP to be able to complete administration tasks using SAP ESP Cockpit.

Related Information

Cluster Configuration [page 94]Node Administration [page 118]Workspace Administration [page 123]Project Administration [page 124]Adapter Administration [page 127]Graphing Performance Counters: The Statistics Chart [page 129]Event Stream Processor Data Collections [page 130]Alerts in SAP ESP Cockpit [page 135]

5.1 Cluster Configuration

Edit cluster configuration and configure cluster security.

For more information on planning and configuring a cluster, see the SAP Event Stream Processor: Configuration and Administration Guide.

Related Information

Enabling External User-Defined Functions [page 95]Configuring Sandboxing for an Adapter [page 95]Add an Authentication Type [page 96]Configuring Macros [page 109]Configuring System Properties [page 110]Configuring Attributes [page 111]Configuring High Availability Project Settings [page 112]Configuring Project Settings [page 113]Configuring Cluster-Managed Adapter Settings [page 114]


SAP Event Stream Processor: Cockpit GuideAdministering SAP Event Stream Processor

Configuring Key Store Settings [page 115]Configuring Compiler Services [page 116]Configuring Discovery Services [page 117]

5.1.1 Enabling External User-Defined Functions

By default, external user-defined functions (UDFs) are disabled in the cluster configuration through the enable-udfs property. To successfully run a project containing UDFs, set this property to true using the SAP ESP Cockpit.

Prerequisites

● Your user account has the required read and admin permissions in ESP.

Procedure

1. Select the EXPLORE workset, then select Actions Configure Cluster .2. Select ESP Cluster in the browser.3. Expand the Applications folder.4. Select either ha-project or project to edit that section of the cluster configuration.5. Edit the value of the enable-udfs property by selecting the cell and entering the new value.

NoteIf you remove this property from the cluster configuration, the ESP Server behaves the same way as when the property is set to false and any projects containing UDFs will fail to run successfully.

5.1.2 Configuring Sandboxing for an Adapter

To avoid overwriting files, enable sandboxing to restrict access for an adapter to read and write files in other directories. Sandboxed adapters will only read and write files in the sandbox base directory.

Prerequisites




Context

If you are running an adapter in managed mode, meaning that you are starting and stopping the adapter with the project, select either ha_project or project. If you are running an adapter in unmanaged mode, meaning that you are starting and stopping it with streamingclusteradmin, select toolkit_adapter.

Procedure

1. Select the EXPLORE workset, then select Actions Configure Cluster .2. Select ESP Cluster in the browser.3. Expand the Applications folder.4. Select either ha-project, project, or toolkit_adapter to edit that section of the cluster configuration.5. Edit the value of the enable-sandboxing property by selecting the cell and entering the new value. The

default value is false.6. (Optional) Edit the value of the sandboxing-base-directory property by selecting the cell and

entering the new value specifying the directory in which the adapter will read and write files. The default value is STREAMING_SHARED.

7. click Apply

NoteIf you remove these properties from the cluster configuration, ESP behaves the same way as when the property is set to false. The default directory becomes STREAMING_HOME.

5.1.3 Add an Authentication Type

To change the cluster authentication type post-installation, use the ESP Cockpit to create a new authenticator.

Related Information

Adding LDAP Authentication [page 97]Adding Native OS Authentication [page 103]Adding SAP BI Authentication [page 106]Adding RSA Authentication [page 106]Adding Kerberos Authentication [page 107]Adding SAP HANA Authentication [page 108]Adding Pre-Configured User Authentication [page 109]



5.1.3.1 Adding LDAP Authentication

Use ESP Cockpit to add an authenticator for LDAP.

Prerequisites


Procedure

1. Select the EXPLORE workset.

2. Select ESP Nodes, then select Actions Configure Cluster .3. (Optional) To remove any existing authenticators, select the authenticator, then select Remove

Authenticator, and then click Yes to save your changes.

NoteYou can have multiple authenticators.

4. Click Add Authenticator....5. Select the authenticator type LDAP from the drop-down menu, then click Done.6. Edit the values for the following options:

○ ServerType○ ProviderURL○ DefaultSearchBase○ AuthenticationScope○ Rolescope

The auth_ldap.xml file located in the STREAMING_HOME\cluster\config directory provides additional configuration information for LDAP authentication. See LDAP Configuration Properties [page 98] for a list of additional configuration options.

7. To add additional configuration options:a. Click Add Option.b. Under Option Name, click the New Option field and enter the name of the option.c. Set the value for the option.

8. Click Apply.9. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.



Related Information

LDAP Configuration Properties [page 98]

5.1.3.1.1 LDAP Configuration Properties

Use these properties to configure Event Stream Processor for LDAP authentication .

Table 41:

Property Default Value Description

ServerType None (Required) The type of LDAP server you are connecting to:

● sunone5 -- SunOne 5.x OR iPlanet 5.x

● msad2k -- Microsoft Active Directory, Windows 2000

● nsds4 -- Netscape Directory Server 4.x

● openldap -- OpenLDAP Directory Server 2.x

The value you choose establishes default values for these other authentication properties:

● RoleFilter● UserRoleMembership● RoleMemberAttributes● AuthenticationFilter● DigestMD5Authentication● UseUserAccountControl

ProviderURL ldap://localhost:389 (Required) The URL used to connect to the LDAP server. Use the default value if the server is:

● Located on the same machine as your product that is enabled with the common security infrastructure.

● Configured to use the default port (389).

Otherwise, use this syntax for setting the value:

ldap://<hostname>:<port>




DefaultSearchBase None (Required) The LDAP search base that is used if no other search base is specified for authentication, roles, attribution, and self registration:

● dc=<domainname>,dc=<tld>For example, a machine in the mycomnpany.com domain would have a search base of dc=mycompany,dc=com.

● o=<company name>,c=<country code>For example, this might be o=mycompnay,c=us for a machine within the Mycompany organization.

AuthenticationScope onelevel (Required) The authentication search scope. The supported values for this are:

● onelevel● subtree

If you do not specify a value or if you specify an invalid value, the default value is used.

RoleScope onelevel (Required) The role search scope. Supported values include:

● onelevel● subtree

If you do not specify a value or if you specify an invalid value, LDAP uses the default value.

SecurityProtocol None (Optional) The protocol to be used when connecting to the LDAP server.

To use an encrypted protocol, use ssl instead of ldaps in the URL.

AuthenticationMethod Simple (Optional) The authentication method to use for all authentication requests into LDAP. Legal values are generally the same as those of the java.naming.security.authentication JNDI property. Choose one of:

● simple — For clear-text password authentication.● DIGEST-MD5 — For more secure hashed password

authentication. This method requires that the server use plain text password storage and only works with JRE 1.4 or later.




AuthenticationFilter For most LDAP servers: (&(uid={uid})(objectclass=person))

or

For Active Directory e-mail lookups: (&(userPrincipalName={uid}) (objectclass=user)) [ActiveDirectory]

For Active Directory Windows user name lookups: (&(sAMAccountName={uid})(objectclass=user))

(Optional) The filter to use when looking up the user.

When performing a user name based lookup, this filter is used to determine the LDAP entry that matches the supplied user name.

The string "{uid}" in the filter is replaced with the supplied user name.

AuthenticationSearchBase None (Optional) The search base used to authenticate users. If this property is not configured, the value for DefaultSearchBase is used.

BindDN None (Optional) The user DN to bind against when building the initial LDAP connection.

In many cases, this user may need read permissions on all user records. If you do not set a value, anonymous binding is used. Anonymous binding works on most servers without additional configuration.

However, the LDAP attributer may use this DN to create users in the LDAP server. When the self-registration feature is used, this user may need permissions to create a user record. This behavior may occur if you do not set useUserCredentialsToBind to true. In this case, the LDAP attributer uses this DN to update the user attributes.




BindPassword None (Optional) The password for BindDN, which is used to authenticate any user. BindDN and BindPassword separate the LDAP connection into units.

The AuthenticationMethod property determines the bind method used for this initial connection.

SAP recommends that you encrypt passwords, and provides a password encryption utility. If you encrypt BindPassword, include encrypted=true in the line that sets the option. For example:

<options name="BindPassword" encrypted="true" value="1snjikfwregfqr43hu5io..."/>

If you do not encrypt BindPassword, the option might look like this:

<options name="BindPassword" value="s3cr3T"/>

RoleSearchBase None (Optional) The search base used to retrieve lists of roles. If this property is not configured, LDAP uses the value for DefaultSearchBase.

RoleFilter For SunONE/iPlanet: (&(objectclass=ldapsubentry) (objectclass=nsroledefinition))

For Netscape Directory Server: (|(objectclass=groupofnames) (objectclass=groupofuniquenames))

For ActiveDirectory: (|(objectclass=groupofnames) (objectclass=group))

(Optional) The role search filter. This filter should, when combined with the role search base and role scope, return a complete list of roles within the LDAP server. There are several default values, depending on the chosen server type. If the server type is not chosen and this property is not initialized, no roles are available.




RoleMemberAttributes For Netscape Directory Server and OpenLDAP Server: member,uniquemember

(Optional) A comma-separated list of role attributes from which LDAP derives the DNs of users who have this role.

These values are cross-referenced with the active user to determine the user's role list. One example of the use of this property is when using LDAP groups as placeholders for roles. This property has a default value only when the Netscape server type is chosen.

RoleNameAttribute cn (Optional) The attribute for retrieved roles that is the common name of the role.

UserRoleMembershipAttributes For iPlanet/SunONE: nsRoleDN

For Active Directory: memberOf

For all others: none

(Optional) Defines a user attribute that contains the DNs of all of the roles a user is a member of.

These comma-delimited values are cross-referenced with the roles retrieved in the role search base and search filter to generate a list of user's roles.

NoteIf you use nested groups with Active Directory, you must set this property to tokenGroups.

UserFreeformRoleMembershipAttributes

None (Optional) The free-form role membership attribute list. Users who have attributes in this comma-delimited list are automatically granted access to roles whose names are equal to the attribute value. For example, if the value of this property is department and the department attribute in the user's LDAP record has the values {sales, consulting}, the user is granted the roles sales and consulting.

Referral ignore (Optional) The behavior when a referral is encountered. Valid values are dictated by LdapContext, but might include follow, ignore, or throw.

InitialcontextFactory None (Optional) To use when connecting to the LDAP server.

SelfRegistrationSearchBase None (Optional) The search base to use when creating a new user as part of self registration. If this value is not specified, the default search base will be used. The authentication search base is used for self update operations.




CertificateAuthenticationFilter None (Optional) The certificate authentication search filter. The filter may contain the special strings "{certattr}" which is replaced with the certificate attribute or the mapped ldap attribute (if mapping between certificate attributes and ldap attributes is defined).

The value "{0}" is set to the encoded certificate or an attribute value from certificate. Example for Active Directory: "(&({certattr}={0})(objectclass=user))", for other server types: "(&({certattr}={0})(objectclass=person))"

Attributes None (Optional) Defines an attribute mapping from CSI attribute to LDAP attribute. For example, CSI.Email=mail

5.1.3.2 Adding Native OS Authentication

Use ESP Cockpit to add an authenticator for Native OS.

Prerequisites


Context

Native OS authentication requires the same username-password credentials that users enter to log in to their machines. Native OS authentication relies on the underlying operating system’s built-in authentication framework.

Procedure







4. Click Add Authenticator....5. Select an authenticator type from the drop-down menu:

○ For Windows, choose NT Proxy.○ For UNIX, choose Unix Proxy.

6. Click Done.7. Edit the value for the configuration option:

○ For Windows, the extractDomainFromUsername option. The default value is true. If set to true, the user name can contain the domain in the form of <username>@<domain>. If set to false, the default domain is always used, and the supplied user name is sent through to SSPI untouched.

The auth_native_nt.xml file for Windows, and the auth_native_unix.xml file for Unix are located in the STREAMING_HOME\cluster\config directory provide additional configuration information for Native OS authentication.


Next Steps

For Unix, see Configuring a Pluggable Authentication Module (PAM) for Unix [page 104] for additional configuration requirements for Native OS authentication.

Related Information

Configuring a Pluggable Authentication Module (PAM) for Unix [page 104]

5.1.3.2.1 Configuring a Pluggable Authentication Module (PAM) for Unix

If you selected the Native OS authentication option during installation, perform additional configuration to allow login using accounts on the host system.

Procedure

1. Using a login account with root privileges, configure the pluggable authentication module for your platform:



Table 42:

Platform Action

Solaris Append the contents of the <Install-dir>/ESP-5_1/security/pam/pam.conf file (provided with Event Stream Processor) to the /etc/pam.conf file on your Solaris platform.

Linux If you are installing on RHEL 6, copy the <Install-dir>/ESP-5_1/security/pam/rhel6/sybase-csi file (provided with Event Stream Processor) to the /etc/pam.d directory on your Linux platform.

For previous versions of RHEL, copy the <Install-dir>/ESP-5_1/security/pam/sybase-csi file (provided with Event Stream Processor) to the /etc/pam.d directory on your Linux platform.

If you are installing on SUSE 11 or later versions, copy the <Install-dir>/ESP-5_1/security/pam/suse11/sybase-csi file (provided with Event Stream Processor) to the /etc/pam.d directory on your Linux platform.

NoteThe sybase-csi file provided with Event Stream Processor is not compatible with the most recent SUSE Linux versions. For SUSE 11 and later, see the example at the end of this topic.

NoteIn the table above, the portion of the path that indicates the operating system might differ slightly from what is shown.

2. If the host UNIX system is not using a directory lookup for authentication (yp or NIS, for example) and authentication is carried out against the local /etc/passwd file, any user account that executes Event Stream Processor requires read access to /etc/shadow. To provide this access, use the usermod command to add the applicable user accounts to the shadow group.For example, for user account User_123 use: usermod -G shadow User_123Automatic processes may reset privileges on /etc/shadow. If you cannot log in to ESP, check the privileges on /etc/shadow and re-add user accounts to the shadow group as necessary.

ExampleExample: PAM for SUSE Linux 11 and later

For SUSE 11 and later, do not use the sybase-csi file provided with Event Stream Processor. Instead, in your /etc/pam.d directory, create an sybase-csi. file that contains:

# sybase-csi PAM Configuration (SUSE style) auth include common-authaccount include common-accountpassword include common-passwordsession include common-session



5.1.3.3 Adding SAP BI Authentication

Use ESP Cockpit to add an authenticator for SAP BI.

Prerequisites


Procedure





4. Click Add Authenticator...5. Select the authenticator type BOE from the drop-down menu, then click Done.6. Edit the values for the following options:

○ cmsUri○ authenticationMethod

The auth_boe.xml file located in the STREAMING_HOME\cluster\config directory provides additional configuration information for SAP BI authentication.


5.1.3.4 Adding RSA Authentication

Use ESP Cockpit to add an authenticator for RSA.

Prerequisites




Procedure





4. Click Add Authenticator...5. Select the authenticator type RSA from the drop-down menu, then click Done.6. Edit the values for the following options:

○ Digester○ Algorithm

The auth_rsa.xml file located in the STREAMING_HOME\cluster\config directory provides additional configuration information for RSA authentication.


5.1.3.5 Adding Kerberos Authentication

Use ESP Cockpit to add an authenticator for Kerberos.

Prerequisites


Procedure







4. Click Add Authenticator....5. Select the authenticator type Kerberos from the drop-down menu, then click Done.6. Edit the values for the following options:

○ principal○ keytab

The auth_kerberos.xml file located in the STREAMING_HOME\cluster\config directory provides additional configuration information for Kerberos authentication.


5.1.3.6 Adding SAP HANA Authentication

Use ESP Cockpit to add an authenticator for SAP HANA.

Prerequisites


Procedure





4. Click Add Authenticator....5. Select the authenticator type SAP HANA from the drop-down menu, then click Done.6. Edit the value for the following option:

○ jdbcUrl

The auth_hana.xml file located in the STREAMING_HOME\cluster\config directory provides additional configuration information for SAP HANA authentication.




5.1.3.7 Adding Pre-Configured User Authentication

Use ESP Cockpit to add an authenticator for Pre-Configured User.

Prerequisites


Procedure


2. Select ESP Nodes, then select Actions Configure Cluster .3. Expand the Security folder and then the Authenticators folder.4. (Optional) To remove any existing authenticators, select the authenticator, then select Remove



5. Click Add Authenticator....6. Select the authenticator type Pre-Configured User from the drop-down menu, then click Done.7. Edit the values for the following options:

○ username○ password


5.1.4 Configuring Macros

Edit cluster-wide macros. Macros are configuration file shortcuts for centralizing a repeated configuration, or for acquiring properties from the environment.

Prerequisites

● You are logged in to SAP ESP Cockpit.● Your user account has the required read and admin permissions in ESP.



Procedure

1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure Cluster .

2. Select the Macros tab.

○ (Optional) To create a new macro, click Create Macro.○ (Optional) To remove a macro, select the macro name and click Remove Macro.

3. Edit the properties for the macro:

Table 43:


Name Specify the name of the property.

Type Specify the property type.

Value Specify the value of the property.


5.1.5 Configuring System Properties

Edit cluster-wide system properties.

Prerequisites


Procedure


2. Select the System Properties tab.

○ (Optional) To add a new system property, click Create Property.○ (Optional) To remove a system property, select the system property name and click Remove

Property.3. Edit the parameters of the property:



Table 44:

Parameter Description



Expanded Specify if the property uses expansion.

Encrypted Specify if the property uses encryption.


5.1.6 Configuring Attributes

Edit cluster-wide attributes, including secure sockets layer (SSL), application heartbeat interval, multicast manager, and cluster persistence.

Prerequisites


Procedure


2. Select the Attributes tab to edit the settings for the cluster:

Table 45:

Attribute Description

SSL Specify whether the connection uses SSL.

Application Heartbeat Interval Specify the time, in milliseconds, between a node's heartbeat checks of a project for ESP.

Multicast Manager Specify whether this cluster uses multicast. If this option is not selected, nodes use direct connections.

Multicast Group (If Multicast Manager is enabled) Specify the multicast group.

Multicast Port (If Multicast Manager is enabled) Specify the multicast port.

Cluster Persistence Specify whether this cluster uses persistence.



Attribute Description

Persistence Type (If Cluster Persistence is enabled) Specify the persistence type. Valid options are directory and database.

Persistence Directory (If Cluster Persistence is enabled) Specify the path to the persistence directory.


5.1.7 Configuring High Availability Project Settings

Edit properties for the High Availability (HA) project application type, with definitions for the base directory, host name, library directory, and security directory that the application uses.

Prerequisites


Procedure


2. Expand the Applications folder and select ha_project.

○ (Optional) To add a property, click Add Property.○ (Optional) To remove a property, select the property name and click Remove Property.

3. Edit the property values.

Table 46:

Property Value

base-directory Default is ${STREAMING_SHARED}/cluster/projects/${STREAMING_CLUSTER_NAME}

hostname Default is ${STREAMING_HOSTNAME}

id-preload Default is ${STREAMING_HOME}/lib/libjsig.so

ssl-key-file Default is ${STREAMING_HOME}/cluster/keys/${STREAMING_CLUSTER_NAME}

ssl-key-file-encrypted Default is true



Property Value

streaming-home Default is ${STREAMING_HOME}

4. Enable or disable Standard Stream Logging by clicking the check-box.

A running project might attempt to write to the console, but the output is not visible because that operation runs in the background. When standard stream logging is enabled, the output is written to the project working directory, which defaults to $STREAMING_HOME/SybaseESP/5.1/workspace/<workspace_name>.<project_name>.<instance_number>. The standard stream logging output file is stdstreams.log.When standard stream logging is disabled, no output is written to the project working directory.

Notestdstreams.log receives all output written to stdout and stderr. This includes SySAM licensing information for Event Stream Processor, as well as messages from third party applications that write to stdout and stderr. For more information, see Project Logging in the SAP Event Stream Processor: Configuration and Administration Guide.


For more information, see High Availability in the SAP Event Stream Processor: Configuration and Administration Guide.

5.1.8 Configuring Project Settings

Edit properties for the project application type, with definitions for the base directory, host name, library directory, and security directory that the application uses.

Prerequisites


Procedure


2. Expand the Applications folder and select project.

○ (Optional) To add a property, click Add Property.



○ (Optional) To remove a property, select the property name and click Remove Property.3. Edit the property values.

Table 47:

Property Value

base-directory Default is ${STREAMING_SHARED}/cluster/projects/${STREAMING_CLUSTER_NAME}

hostname Default is ${STREAMING_HOSTNAME}

id-preload Default is ${STREAMING_HOME}/lib/libjsig.so

ssl-key-file Default is ${STREAMING_HOME}/cluster/keys/${STREAMING_CLUSTER_NAME}

ssl-key-file-encrypted Default is true






5.1.9 Configuring Cluster-Managed Adapter Settings

Edit properties for the toolkit adapter application type. Adapters that are cluster-managed are started and stopped independently of the project, and managed through the cluster.

Prerequisites




Procedure


2. Expand the Applications folder and select toolkit_adapter.

○ (Optional) To add a property, click Add Property.○ (Optional) To remove a property, select the property name and click Remove Property.

3. Edit the property values.

Table 48:

Property Value

base-directory Default is ${STREAMING_SHARED}/cluster/adapters/${STREAMING_CLUSTER_NAME}






5.1.10 Configuring Key Store Settings

Edit the key store settings for the cluster.

Prerequisites




Context

The SAP ESP cluster key store is a repository of security certificates for accessing Event Stream Processor.

Procedure


2. Expand the Security folder and select Key Store.3. Edit the Key Store settings:

Table 49:

Name Value

Key Store Type JKS

Key Store Algorithm Type RSA

Key Store File Location Default is ${STREAMING_CLUSTER_KEYSTORE}

Set the filepath to the location of the key store file. For example, set it to $(STREAMING_SHARED)/security/keystore_rsa.jks.

Key Store Password Specify the password

a. Enable or disable the Encryption option by clicking the check-box.


5.1.11 Configuring Compiler Services

If the node is a service provider, edit values for compiler.

Prerequisites




Procedure


2. Expand the Services folder and select compiler.3. (Optional) Edit the default values.

Table 50:

Property Value

base-directory Default is ${STREAMING_HOME}/cluster/examples/compiler



5.1.12 Configuring Discovery Services

If the node is a service provider, edit values for discovery.

Prerequisites


Procedure


2. Expand the Services folder and select discovery.3. (Optional) Edit the default values.

Table 51:

Property Value

base-directory Default is ${STREAMING_HOME}/cluster/examples/compiler

cnxml-path Default is ${STREAMING_HOME}/lib/adapters



Property Value



5.2 Node Administration

Manage ESP nodes.

For more information on configuring a node, see the SAP Event Stream Processor: Configuration and Administration Guide.

Related Information

Creating a Node [page 118]Starting and Stopping a Node [page 119]Configuring a Node [page 120]Configuring a Multinode Cluster [page 122]

5.2.1 Creating a Node

Add a new ESP node to a cluster.

Prerequisites


Procedure

1. Select the EXPLORE workset, then select Actions Configure Cluster .2. Click the Add Node... button.3. Enter the properties of the new node:



Table 52:


ESP Node Name Specify the name of the node. This name must be unique throughout the cluster.

Host Name Specify the host name of the server.

Connection Port Specify the connection port for the server.

Admin Port (Optional) Specify the admin port for the server. This allows you to distinguish between administrative and non-administrative users.

Cache Port Specify the port for the cluster cache.

Key Store File Specify the location of the key store file. For example, $(STREAMING_SHARED)/security/keystore_rsa.jks.

4. Click Done.

5.2.2 Starting and Stopping a Node

Start a node to be able to start one or more projects on the node. Stop a node after you have stopped the projects on the node.

Prerequisites

● The time-granularity option is enabled on the node in the ESP project configuration (.ccr) file.● Your user account has the required read and admin permissions in ESP.

Context

Stopping a node this way does not stop any high availability (HA) projects running on the node unless the node is the only manager node.

Procedure

1. In the left pane of the EXPLORE workset, open the Browse page tab and expand ESP Nodes.2. In the right pane of the EXPLORE workset, select the ESP node, click the arrow, and select Start Node or

Stop Node.

3. A window appears and asks you to confirm whether you want to start or stop the node. Click Yes to confirm.



A message appears in the Messages Pane, and reports whether the node was successfully stopped or started. The node status appears as "running" if the node is successfully started, and "stopped" if the node is successfully stopped. If the node is stopped, its status is marked in red.

Related Information

Parameters Required for Starting a Node [page 31]

5.2.3 Configuring a Node

Edit parameters of an existing ESP node.

Prerequisites


Procedure


2. Select the node you want to configure.3. Select the Macros tab to view inherited cluster macros and node-specific macros.

○ (Optional) To create a new node-specific macro, click Create Node Macro.○ (Optional) To remove a node-specific macro, select the macro name and click Remove Node Macro.

a. Edit the properties for the node-specific macro:

Table 53:



Type Specify the property type.


4. Select the System Properties tab to view inherited cluster system properties and configure node-specific properties.

○ (Optional) To create a new node-specific system property, click Create Property.



○ (Optional) To remove a node-specific system property, select the macro name and click Remove Property.

a. Edit the parameters of the property:

Table 54:

Parameter Description



Expanded Specify if the property uses expansion.

Encrypted Specify if the property uses encryption.

5. Select the Connectivity tab to edit connection settings:

Table 55:


Connection Host Name Specify the host name of the server.

Connection Port Specify the connection port for the server.

Admin Port (Optional) Specify the admin port for the server. This allows you to distinguish between administrative and non-administrative users.

Cache Host Name Specify the host name of the cluster cache.

Cache Port Specify the port for the cluster cache.

SSL Specify whether or not the connection uses SSL.

6. Select the Node Attributes tab to edit the settings for the node:a. Specify whether the node is a manager and/or controller.b. If the node is a controller, select applications for it to control.c. If the node is a service provider, select Service provider. Available services are compiler and

discovery.d. (Optional) To edit the default values for compiler and/or discovery, go to the left pane and expand the

Services folder, then select a service and edit the values in the Value column.e. Click Apply.

7. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.



5.2.4 Configuring a Multinode Cluster

Set shared locations and configure multiple nodes in a single cluster.

Prerequisites

● Files and directories which must be accessible to all nodes are in a shared location. For more information, see File and Directory Infrastructure in the SAP Event Stream Processor: Configuration and Administration Guide.


Procedure

1. In ESP Cockpit, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure Cluster .

2. For each existing node in the cluster:a. Select the node in the browser.b. Select the Macros tab.c. Set the STREAMING_CLUSTER_KEYSTORE macro to a shared location containing the key store file.

For example, set it to $(STREAMING_SHARED)/security/keystore_rsa.jks.

3. Add one or more nodes to the cluster:a. Click the Add Node... button.b. Enter the properties of the new node:

Table 56:


ESP Node Name The name of the node. This name must be unique throughout the cluster.

Host Name The host name of the server.

Connection Port The connection port for the server. Nodes on different hosts in a cluster can use the same connection ports.

Admin Port (Optional) The admin port for the server. This allows you to distinguish between administrative and non-administrative users.

Cache Port The port for the cluster cache.




Key Store File The location of the key store file. For example, $(STREAMING_SHARED)/security/keystore_rsa.jks.

c. Click Done.d. Click Create Node Macro.e. Set the <name> of the new macro to STREAMING_SHARED, and set its <value> to the location of

your shared files and directories.f. Select the Node Attributes tab.g. Specify whether the node is a manager, controller, and/or service provider.h. If the node is a controller, select applications for it to control.i. If the node is a service provider, select services to run on it.

4. Click Apply.

5.3 Workspace Administration

Add and remove workspaces for your cluster, as needed.

Related Information

Adding a Workspace [page 123]Removing a Workspace [page 124]

5.3.1 Adding a Workspace

Add a new workspace to a cluster.

Prerequisites




Procedure

1. In the right pane of the EXPLORE workset, select a node, click the arrow, and select Manage Workspaces....

2. Click Add Workspace.3. Enter a name for the new workspace at the prompt. Workspace names must be unique within an ESP

cluster. For example, production1.

4. Click Add to add the workspace to the node.

5.3.2 Removing a Workspace

Delete a workspace from a cluster.

Prerequisites


Procedure

1. In the right pane of the EXPLORE workset, select a node, click the arrow, and select Manage Workspaces....

2. Select the workspace to remove and click Remove Workspace.

5.4 Project Administration

View project properties, and start, stop, add, and remove projects from a node.

Related Information

Adding a Project [page 125]Removing a Project [page 125]Starting and Stopping a Project [page 126]



5.4.1 Adding a Project

Add a new ESP project to a workspace on your cluster.

Prerequisites


Procedure

1. In the right pane of the EXPLORE workset, select a node, click the arrow, and select Manage Projects....2. Click Add Project.3. Select a workspace for the project.4. Enter a name for the project.5. Click Select... to specify the filepath to the .ccx file for the project.6. (Optional) Click Select... to specify the filepath to the .ccr file for the project.7. Click Add to add the project to the workspace.

5.4.2 Removing a Project

Delete a project from a node.

Prerequisites


Procedure

1. In the right pane of the EXPLORE workset, select a node, click the arrow, and select Manage Projects....2. Select the project to remove and click Remove Project.



5.4.3 Starting and Stopping a Project

Start or stop a project on a node.

Prerequisites


Context

The steps below enable you to start a project which belongs to a specific node. To view and manage all projects belonging to a cluster rather than only a node, use the Manage Projects... command from a manager node in the Browse page tab.

Procedure

1. In the left pane of the EXPLORE workset, open the Browse page tab, expand ESP Nodes and select Projects.

2. In the right pane of the EXPLORE workset, select a project, click the arrow, and select Start Project... or Stop Project....

3. A message displays asking you to confirm whether you want to start the project. Click Yes to confirm.A dialog appears and reports whether the project was successfully started or stopped. The project status appears as "running" if the project is successfully started, and "stopped" if the project is successfully stopped. If the project is stopped, its status is marked in red.

4. (Required if starting a project) Set the performance monitor refresh interval to enable monitoring:a. In the Projects tab, right-click on the running project and select Set Performance Timer Interval from

the dropdown.b. Enter any positive number in the field to enable performance monitoring, or set the interval to 0 to

disable it. Click OK to save.

This option specifies, in seconds, how often the set of performance records — one per stream and one per gateway connection — is obtained from the running ESP project.



5.5 Adapter Administration

View, start, and stop adapters on a node.

Related Information

Starting and Stopping an Adapter [page 127]Viewing File Activity for the SAP IQ Output Adapter [page 128]

5.5.1 Starting and Stopping an Adapter

Start or stop an adapter on a node.

Prerequisites


Procedure

1. In the left pane of the EXPLORE workset, open the Browse page tab, expand ESP Nodes and select Adapters.

2. In the right pane of the EXPLORE workset, select an adapter, click the arrow, and select Start Adapter... or Stop Adapter....

3. A dialog appears and asks you to confirm whether you want to start or stop the adapter. Click Yes to confirm.A dialog appears and reports whether the adapter was successfully started or stopped. The adapter status appears as "running" if the adapter is successfully started, and "stopped" if the adapter is successfully stopped. If the adapter is stopped, its status is marked in red.



5.5.2 Viewing File Activity for the SAP IQ Output Adapter

View the file activity report for the SAP IQ Output Adapter to see its current state, as well as each file it processes.

Prerequisites

● Create a database user and table in the database into which the SAP IQ Output adapter is loading data. Run the $STREAMING_HOME/adapters/iqoutput/enableFileActivity.sql script on your SAP IQ database as a user with permissions to create a user, and create a table for that user. For full information on the table and user you need to create, see Enabling File Activity Monitoring for the SAP IQ Adapter in the SAP Event Stream Processor: Adapters Guide.


Procedure

1. In the left pane of the EXPLORE workset, open the Browse page tab, expand ESP Nodes and select Adapters.

2. In the right pane of the EXPLORE workset, select the SAP IQ Output adapter, click the arrow, and select File Activity.

3. A new window appears and displays the file activity report, which contains details about each of the files processed by the adapter, including their current state.

By default, the window displays records an hour ahead of the local time. If you want to display records from different periods of time, go to the window menu and select View Filter .

If the SAP IQ database cannot find the SAP IQ database username and password from the ESP Cockpit server, another window appears and asks for this information.



5.6 Graphing Performance Counters: The Statistics Chart

To show performance trends, generate a graph for any set of performance counters over a specified period of time.

Prerequisites

● Verify that statistical data to be graphed has been collected. To verify data collection, open the Cockpit Settings dialog, navigate to the Collection Jobs page, and check the History tab. You can also look at the graphs on the overview page: if data appears there, data is being collected.

● Your user account has the required read permission in ESP. Learn more about granting permissions in the post-installation tasks of the installation documentation, and in the SAP Event Stream Processor: Configuration and Administration Guide

Procedure

1. Select the MONITOR workset, and then the Statistics Chart page.2. Expand the folders in the Statistics page tab and select the key performance indicator (KPI) you want to

graph.3. Click Graph Statistic or drag the KPI onto the Chart page tab.

The Chart page tab displays the graphed data, while the KPI with its corresponding value, and the date and time it was collected, appear in the Data page tab.

4. (Optional) Repeat to add KPIs to the graph.5. (Optional) Use the slider at the bottom of the Chart page tab to control the amount of time covered by the

graph, ranging from a minute to a year.6. (Optional) Use <<, <, >, and >> to move the displayed graph to an earlier or later time. Increments depend

on how the slider is set.

TipThe statistics chart displays data covering a fixed period of time, and that period does not change automatically. If you are viewing the most recent statistics and want to keep the graph current, adjust the displayed time period as new statistics are collected.

7. (Optional) You can click the date/time labels that appear above the slider. Use these to change the start and end time and the chart time span.

8. (Optional) Click Clear Graph to remove all the graphed statistics and start anew.



Results

NoteYou can graph a maximum of five statistics with no more than two distinct units of measure. By default, only 24 hours of statistics are available; change the repository purge options to save statistics for a longer period.

Related Information

Collection Jobs [page 35]

5.7 Event Stream Processor Data Collections

Predefined data collections you can schedule for Event Stream Processor. Collected statistics appear on ESP Cockpit monitoring screens and trigger user-configured alerts.

Event Stream Processor provides several data collections (without overlap) to collect data using a fine granularity and reduce the data collection workload. These are:

● Monitoring Statistics● Collect_Overview_Project_Stream● Collect_Conn_Publisher_Subscriber● Collect_Adapter

The Monitoring Statistics collection is the default collection.

Table 57: ESP Node Data Collections

Collection Description KPIs

Monitoring Statistics Contains node availability statistics and total CPU usage displayed in the Heat Chart. This is the default collection; it is automatically scheduled when you authenticate an ESP node.

NoteSAP strongly recommends that you leave this collection running for each monitored ESP node.

● Resource State● Total CPU Usage




Collect_Overview_Project_Stream Schedule the collection to enable statistics and alerts for overall node activity, and projects and streams running on the node.

Overview

● Total CPU Usage● Total System CPU Usage● Total User CPU Usage● Physical Memory Usage● Virtual Memory Usage● Total Thread Number● Number of Rows Received per

Second● Number of Rows Sent per Second● Total Number of Connections● Number of Publishers● Number of Subscribers

Project

● Total CPU Usage● Total System CPU Usage● Total User CPU Usage● Physical Memory Usage● Virtual Memory Usage● Total Thread Number● Number of Publisher Rows Trans

ferred● Number of Subscriber Rows

Transferred● Number of Publisher Connections● Number of Subscriber Connec

tions

Stream

● Rows per Sec● Total CPU Usage● Total System CPU Usage● Total User CPU Usage● Stream Depth Queued● Stream Rows Stored




Collect_Conn_Publisher_Subscriber Schedule the collection to enable statistics and alerts for gateway connections, publishers, and subscribers.

Connection

● Number of Rows Sent per Sec● Number of Rows Received per Sec

Publisher

● Total CPU Usage● Total System CPU Usage● Total User CPU Usage● Number of Rows Sent per Sec

Subscriber

● Total CPU Usage● Total System CPU Usage● Total User CPU Usage● Stream Depth Queued● Stream Rows Stored● Number of Rows Received per Sec

Collect_Adapter Schedule the collection to enable statistics and alerts for adapters on projects which are running on the node.

Adapter

● Adapter Total Rows● Adapter Good Rows● Adapter Bad Rows● Adapter Latency

Related Information

Key Performance Indicators for Event Stream Processor [page 132]

5.7.1 Key Performance Indicators for Event Stream Processor

Key performance indicators (KPIs) provide the statistics that appear on the charts in the ESP Cockpit.

You can view these statistics from the All Statistics or the Statistics Chart page under the MONITOR workset.

Table 58: Overview Statistics

KPI Description

Total CPU Usage (Percent) The sum of total CPU usage, since the last update, of all projects which are running on the node.



KPI Description

Total System CPU Usage (Percent) The sum of total system (kernel on Windows) CPU usage, since the last update, of all projects which are running on the node.

Total User CPU Usage (Percent) The sum of total user CPU usage, since the last update, of all projects which are running on the node.

Physical Memory Usage (KB) The sum of physical memory usage, since the last update, of all projects which are running on the node.

Total Thread Number (Count) The sum of the thread number, since the last update, of all projects which are running on the node.

Virtual Memory Usage (KB) The sum of virtual memory usage, since the last update, of all projects which are running on the node.

Number of Total Connections (Count) Total number of connections on the node, including publishers and subscribers.

Number of Rows Sent per Second (Count) The number of rows output from the projects running on the node, per second.

Number of Rows Received per Second (Count) The number of rows input into the projects running on the node, per second.

Number of Publisher Connections (Count) The number of publishers running on the node.

Number of Subscriber Connections (Count) The number of subscribers running on the node.

Table 59: Project Statistics

KPI Description

Total CPU Usage (Percent) The total CPU usage of the project since the last update.

Total System CPU Usage (Percent) The total system CPU usage for the project since the last update.

Total User CPU Usage (Percent) The total user CPU usage for the project since the last update.

Physical Memory Usage (KB) The physical memory usage for the project since the last update.

Total Thread Number (Count) The thread number for the project since the last update.

Number of Publisher Rows Transferred (Count) The number of rows input into the project per second.

Number of Subscriber Rows Transferred (Count) The number of rows output from the project per second.

Virtual Memory Usage (KB) The virtual memory usage for the project since the last update.

Number of Publisher Connections (Count) The number of connections through which the publishers are running.

Number of Subscriber Connections (Count) The number of connections through which the subscribers are running.

Table 60: Stream Statistics

KPI Description

Total CPU Usage (Percent) The total CPU usage for the stream since the last update.



KPI Description

Total System CPU Usage (Percent) The total system CPU usage for the stream since the last update.

Total User CPU Usage (Percent) The total user CPU usage for the stream since the last update.

Rows per Sec (Count) The number of rows processed by the stream, in one second, since the last update.

Stream Depth Queued (Count) The number of rows waiting to be processed.

Stream Rows Stored (Count) The current number of records in the stream's store.

Table 61: Adapters Statistics

KPI Description

Adapter Total Rows Total number of rows in the adapter.

Adapter Good Rows The number of good rows in the adapter.

Adapter Bad Rows The number of bad rows in the adapter.

Adapter Latency The time taken, in microseconds, for data to be processed.

Table 62: Publishers Statistics

KPI Description

Total CPU Usage (Percent) Total CPU usage by the publisher's gateway thread.

Total System CPU Usage (Percent) Total system CPU usage by the publisher's gateway thread.

Total User CPU Usage (Percent) Total user CPU usage by the publisher's gateway thread.

Number of Rows Sent per Sec (Count) The number of data rows the client sent, per second, since the last update.

Table 63: Subscribers Statistics

KPI Description

Total CPU Usage (Percent) Total CPU usage by the subscriber's gateway thread.

Total System CPU Usage (Percent) Total system CPU usage by the subscriber's gateway thread.

Total User CPU Usage (Percent) Total user CPU usage by the subscriber's gateway thread.

Number of Rows Received per Sec (Count) The number of data rows the client received, per second, since the last update.

Stream Rows Stored (Count) The current number of records in the stream's store.

Stream Depth Queued (Count) Number of rows waiting to be processed.

Table 64: Connection Statistics

KPI Description

Number of Rows Sent per Sec (Count) The gateway client's performance, in data rows per second, sent by the client since the last update.



KPI Description

Number of Rows Received per Sec (Count) The gateway client's performance, in data rows per second, received since the last update.

5.8 Alerts in SAP ESP Cockpit

You can monitor and manage alerts in an Event Stream Processor environment.

Alerts in SAP ESP Cockpit are aggregated into three Key Performance Areas (KPA): Availability, Performance, and Capacity. Each represents a critical area to be measured.

Each KPA is composed of several key performance indicators (KPI), which are collected at defined intervals from the underlying system being monitored and compared to defined thresholds or states.

By default, all alerts are enabled. You can customize each alert threshold and disable any alert not required. However, you cannot add additional alerts to a KPA.

Related Information

SAP ESP Cockpit Alerts [page 136]Monitor and Resolve Alerts [page 142]Setting Alert Notification [page 143]Managing Alert Notification Settings [page 145]Adjusting the Monitoring Interval of a KPA [page 146]Configuring Alerts [page 147]



5.8.1 SAP ESP Cockpit Alerts

SAP ESP Cockpit includes various configurable alerts. All alerts are listed in the Configure page under the ALERT workset.

Table 65: AVAILABILITY

KPI Priority Threshold

(Project) State Normal

Low

Medium

High

RUNNING

PENDING

UNKNOWN

WARNING

ERROR

STOPPED

(Node) State Normal

Low

Medium

High

ERROR

PENDING

RUNNING

STOPPED

UNKNOWN

WARNING

(Adapter) State Normal

Low

Medium

High

ERROR

PENDING

RUNNING

STOPPED

UNKNOWN

WARNING

Table 66: PERFORMANCE


(Connection) Number of Rows Sent per Sec Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648




(Connection) Number of Rows Received per Sec Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Node) Total User CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Node) Number of Rows Sent per Second Normal

Low

Medium

High

0 to 1000

1001 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Node) Total CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Node) Total System CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Node) Number of Rows Received per Second Normal

Low

Medium

High

0 to 1000

1001 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Project) Total System CPU UsageNormal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100




(Project) Total CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Project) Number of Subscriber Rows Transferred Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Project) Number of Publisher Rows Transferred Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Project) Total User CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Adapter) Latency Normal

Low

Medium

High

0 to 100

101 to 10000

10001 to 50000

50001 to 2147483648

(Adapter) Bad Rows Normal

Low

Medium

High

0 to 10

11 to 1000

1001 to 5000

5001 to 2147483648

(Subscriber) Number of Rows Received per Sec Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648




(Subscriber) Stream Rows Stored Normal

Low

Medium

High

0 to 10

11 to 1000

1001 to 10000

10001 to 2147483648

(Subscriber) Total CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Subscriber) Total User CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Subscriber) Total System CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Subscriber) Stream Depth Queued Normal

Low

Medium

High

0 to 10

11 to 1000

1001 to 10000

10001 to 2147483648

(Publishers) Number of Rows Sent per Sec Normal

Low

Medium

High

0 to 10

11 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Publishers) Total CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100




(Publishers) Total System CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Publishers) Total User CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Stream) Rows per Sec Normal

Low

Medium

High

0 to 100

101 to 10000000

10000001 to 100000000

100000001 to 2147483648

(Stream) Depth Queued Normal

Low

Medium

High

0 to 10

11 to 1000

1001 to 10000

10001 to 2147483648

(Stream) Rows Stored Normal

Low

Medium

High

0 to 10

11 to 1000

1001 to 10000

10001 to 2147483648

(Stream) Total CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

(Stream) Total System CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100




(Stream) Total User CPU Usage Normal

Low

Medium

High

0 to 30

31 to 70

71 to 90

91 to100

Table 67: CAPACITY


(Node) Total Number of Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Node) Virtual Memory Usage Normal

Low

Medium

High

0 to 500

501 to 5000000

5000001 to 50000000

50000001 to 2147483648

(Node) Total Thread Number Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Node) Number of Publisher Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Node) Number of Subscriber Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Node) Physical Memory Usage Normal

Low

Medium

High

0 to 500

501 to 5000000

5000001 to 50000000

50000001 to 2147483648




(Project) Number of Total Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Project) Physical Memory Usage Normal

Low

Medium

High

0 to 500

501 to 5000000

5000001 to 50000000

50000001 to 2147483648

(Project) Virtual Memory Usage Normal

Low

Medium

High

0 to 500

501 to 5000000

5000001 to 50000000

50000001 to 2147483648

(Project) Total Thread Number Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Project) Number of Subscriber Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

(Project) Number of Publisher Connections Normal

Low

Medium

High

0 to 50

51 to 500

501 to 5000

5001 to 2147483648

5.8.2 Monitor and Resolve Alerts

The Alert Monitor page displays a dynamically updated list of active alerts, which can be resolved by entering a resolution description.

Active alerts for all priorities display by default, sorted by priority (high to low).

For the current session, you can:



● Display for all alerts or only those resolved● Filter by priority● Sort by various parameters in ascending or descending order. You cannot subsort the list.

Each alert remains on the Alert Monitor page until it has been resolved. The alert record indicates its original timestamp and the age field is updated to reflect the amount of time elapsed since the alert was initially triggered.

Active alerts appear in color, with a status of Active. When the condition that triggered the alert is resolved, and the KPI returns to the expected range, the system automatically changes the status of the alert to Resolved and creates a resolution record. Resolved alerts appear in grey. SAP ESP Cockpit stores details on the last 10 resolved alerts for each KPI. You can also manually change the status of an alert, but if the KPI has not returned to the expected range, the alert reappears.

To manually change an alert status, click Resolve, enter a mandatory description, and click Finish.

NoteThe Finish button is unavailable until a description is entered.

Once set to resolved, an alert status cannot be changed. The resolved alert disappears if Active Alerts Only is selected; otherwise, the alert turns grey, but remains visible.

Select Resolved Alerts Only or All Alerts to view resolved alerts.

5.8.3 Setting Alert Notification

A nonadministrative SAP ESP Cockpit user can set an email address for notification.

Prerequisites

● The email server and port must be configured to enable email notification. See Configuring the E-mail Server.

● At least one notification email address must be defined by an administrative user before a nonadministrative user can enter an email address.

● A technical user account exists.

Context

Once set, notification is sent when any enabled alert is triggered. You cannot select specific alerts for notification (for example, notification sent for a Resource State alert, but not a Total CPU Usage alert). You can also elect to be notified if an alert is not resolved before its escalation period has expired.

If a nonadministrative user modifies the email address, the modified address is appended to the notification list, but the original email address is not removed. It must be manually removed by an administrative user. If



only a notification check mark is changed, administrative user action is not required; the email address is automatically added to or removed from the notification list. It is the responsibility of the nonadministrative user to notify the administrative user of the change.

If an administrative user modifies a nonadministrative user email address, the notification check marks become deselected on the Notify page of the nonadministrative user, and the email address does not reflect the address change. However, the nonadministrative user does receive email notification using the modified address.

SAP ESP Cockpit validates the format of the email address but not the address itself. The Apply button is unavailable when the format of an address is invalid.

Each managed system must have its own notification email addresses defined; notification addresses are specific to the managed system, not SAP ESP Cockpit.

NoteAn administrative SAP ESP Cockpit user can set additional notification parameters. See Managing Alert Notification Settings.

Procedure

1. In SAP ESP Cockpit, click the ALERT workset.2. Click NOTIFY.

NoteWhen you click the ALERT workset for the first time in the current session, there may be a delay before the NOTIFY option appears.

3. Type an email address for alerts.4. Specify the type of notification to receive:

Option Description

Alert notifications Select to receive alert notifications.

Escalation notifications Select to receive escalation notifications.

5. Click Apply, and wait for notification changes to update.



5.8.4 Managing Alert Notification Settings

An administrative SAP ESP Cockpit user can set his or her email address for notification and define additional notification attributes for alerts.

Prerequisites


● The email server and port must be configured to enable email notification. See Configuring the E-mail Server.


Context

At least one notification email address must be defined by an administrative user before a nonadministrative user can enter an email address.

If a nonadministrative user modifies the email address, the modified address is appended to the notification list, but the original email address is not removed. It must be manually removed by an administrative user. If only a notification check mark is changed, administrative user action is not required; the email address is automatically added to or removed from the notification list.

If an administrative user modifies a nonadministrative user email address, the notification check marks become deselected on the Notify page of the nonadministrative user, and the email address does not reflect the address change. However, the nonadministrative user does receive email notification using the modified address.

SAP ESP Cockpit validates the format of the email address but not the address itself. The Apply button is unavailable when the format of an address is invalid.

Procedure

1. In SAP ESP Cockpit, click the ALERT workset.2. Click NOTIFY.

NoteWhen you click the ALERT workset for the first time in the current session, there may be a delay before the NOTIFY option appears.

3. Adjust the alert notification options, as needed:



Table 68:

Setting Description

Notification: Enabled Enable email notification when an alert is triggered.

Email Email addresses to receive notification when an alert is triggered. Separate multiple addresses by semicolons.

Escalation period The elapsed time period, in minutes, in which an alert must be resolved before an escalation email notification is sent.

Escalation email Email address to receive notification in the event an alert remains unresolved once the escalation period has elapsed. Separate multiple addresses by semicolons.

Script Execution: Enabled Associate a script file to the triggering of an alert.

Script path The path to a script to execute in the event an alert is raised, but controlled by suppression. For example, if suppression is 10 minutes and the alert is on a 1 minute interval, the script runs once every 10 minutes.

Storm Suppression Suppress email notifications and script execution for a period of time specified, in minutes, if an alert continues to fire.

4. Click Apply, and wait for notification changes to update.

5.8.5 Adjusting the Monitoring Interval of a KPA

Adjust the frequency at which a KPA alert is monitored.

Prerequisites



Procedure

1. In SAP ESP Cockpit, click the ALERT workset.2. Click CONFIGURE.

NoteWhen you click the ALERT workset for the first time in the current session, there may be a delay before the CONFIGURE option appears.

3. Click the up and down arrows to increase or decrease the monitoring interval (in minutes) for a specific KPA, or enter an integer in the field.



4. Click Apply.

5.8.6 Configuring Alerts

You can enable and disable alerts as well as configure the trigger thresholds for each alert.

Prerequisites



Context

Modifications to alert thresholds take effect the next time the monitoring interval is reached.

NoteIf a message appears indicating the technical user account does not exist, and it was created in the current session, log out and back in to the SAP ESP Cockpit console using the current user (not the technical user account).

Procedure

1. In SAP ESP Cockpit, click the ALERT workset.2. Click CONFIGURE.

NoteWhen you click the ALERT workset for the first time in the current session, there may be a delay before the CONFIGURE option appears.

3. To enable or disable an alert, select or unselect the box in the Enabled column.4. To modify the thresholds of an alert, click Edit and adjust the levels. Click Finish to save the changes.



6 Troubleshooting SAP ESP Cockpit

Troubleshoot problems that occur in SAP ESP Cockpit when administering the SAP Event Stream Processor environment.

Related Information

Browser Refresh (F5) Causes Logout [page 148]Out of Memory Errors [page 148]Cockpit Fails to Start [page 149]Data Collections Fail to Complete [page 149]Fatal Error #2035 Prevents Successful Log in [page 150]Performance Statistics Do Not Cover Enough Time [page 150]Cannot Display the Online Help [page 150]Statistics Do Not Display [page 151]Troubleshooting Tips [page 152]Technical User is Not Defined [page 152]No Systems are Displayed on the Login Page [page 153]

6.1 Browser Refresh (F5) Causes Logout

Problem: Pressing the F5 key to refresh your browser logs you out of SAP ESP Cockpit.

Solution: Avoid using F5 when logged into SAP ESP Cockpit.

Browser refresh updates the loaded application or pages in the browser—in this case, the Adobe Flash on which SAP ESP Cockpit is built.

Consequently, pressing F5 logs you out of servers, including SAP ESP Cockpit.

6.2 Out of Memory Errors

Problem: SAP ESP Cockpit generates OutOfMemory errors and might fail to start.

Solution:

● If the OutOfMemory error says that SAP ESP Cockpit is out of heap space, increase the maximum memory setting (<COCKPIT_MEM_MAX> or jvmopt=-Xmx).


SAP Event Stream Processor: Cockpit GuideTroubleshooting SAP ESP Cockpit

● If the OutOfMemory error says that SAP ESP Cockpit is out of permanent generation space, increase the permanent memory setting (<COCKPIT_MEM_PERM> or jvmopt=-XX:MaxPermSize).

● Repeated OutOfMemory errors may indicate a memory leak. OutOfMemory errors generate heap dumps. Heap dump files have a file extension of .hprof, in the COCKPIT-4\log directory.

Send the heap dump files to Technical Support for analysis.

6.3 Cockpit Fails to Start

Problem: SAP ESP Cockpit does not start.

Solution 1: Port conflict

Solution: SAP ESP Cockpit might use a port that is used by another server or application. To check for port conflicts:

1. Execute this command:

cockpit --info ports

The command lists all the ports on which SAP ESP Cockpit and its services listen, indicates whether each port is in use, and shows the service running on each port. If the Cockpit is not running, any port shown to be in use represents a conflict.

2. If you discover a conflict, use cockpit --port to change the port used by the Cockpit service.

Solution 2: Insufficient memory

Increase the maximum memory setting if you see this error when you try to start: Could not create the Java Virtual machine.

6.4 Data Collections Fail to Complete

Problem: A collection frequently times out or generates errors citing the REJECT_DUPLICATE_RESOURCE_AND_COLLECTION policy, but no problems with the monitored resources are evident.

The errors appear in the log and on the collection history screen.

Solution: Try to determine why the collection is taking so long. For example, are network delays slowing down traffic between SAP ESP Cockpit and the monitored server?



In the case of network delays and other resource-related problems, the interval between collections might be shorter than the time needed to finish the collection. To fix this problem, increase the time between collections.

6.5 Fatal Error #2035 Prevents Successful Log in

Problem: When trying to connect to SAP ESP Cockpit in Firefox, fatal error #2035 appears before the login screen appears.

Solution:

1. Clear the Firefox cache.2. Restart Firefox.3. Enter the SAP ESP Cockpit URL.

6.6 Performance Statistics Do Not Cover Enough Time

Problem: Instead of graphing performance counters over a long time period, the statistics chart shows only very recent data.

Solution: Ask your SAP ESP Cockpit administrator to change the repository purging options to keep statistical data available for as long as you need it. By default, statistics are purged frequently to conserve disk space.

6.7 Cannot Display the Online Help

Problem: SAP ESP Cockpit help is corrupted or cannot be found (404 error).

Solution: Clear online help files to force SAP ESP Cockpit to build new ones.

NoteThis task assumes that your SAP ESP Cockpit uses the default ports, 4282 and 4283. If you configured different port numbers at installation, use those numbers here.

1. Shut down SAP ESP Cockpit.2. Remove this directory:

Table 69:

Windows %SYBASE%\COCKPIT-4\services\EmbeddedWebContainer\container\Jetty-7.6.2.v20120308\work\jetty-0.0.0.0-4282-help.war-_help-any-



UNIX $SYBASE/COCKPIT-4/services/EmbeddedWebContainer/container/Jetty-7.6.2.v20120308/work/jetty-0.0.0.0-4282-help.war-_help-any-

TipIn Windows, you might see a deletion error. Regardless of what the error says, it might be caused by the length of the path. If deletion fails, rename the jetty-0.0.0.0-4282-help.war-_help-any- folder to something very short, such as J. Then delete the renamed folder.

3. Remove this file:

Table 70:

Windows %SYBASE%\COCKPIT-4\services\EmbeddedWebContainer\container\Jetty-7.6.2.v20120308\contexts\_help.xml

UNIX $SYBASE/COCKPIT-4/services/EmbeddedWebContainercontainerJetty-7.6.2.v20120308/contexts/_help.xml

4. Navigate to:

Table 71:

Windows %SYBASE%\COCKPIT-4\services\SybaseControlCenter\help

UNIX $SYBASE/COCKPIT-4/services/SybaseControlCenter/help

5. Remove these files:○ com.sybase.infocenter.scc.zip○ help.war○ help_info.xml

6. Start SAP ESP Cockpit. After Cockpit comes up it rebuilds the help, which takes a few minutes.7. To display the help, go to https://<your-cockpit-host>:4283/help/index.jsp .

NoteIf you try to display the help too soon after restarting, you get a file not found error. Wait a minute or two and try again.

6.8 Statistics Do Not Display

Problem: Some statistics do not display in SAP ESP Cockpit.

Solution: Check that you started the projects in Event Stream Processor with the time-granularity option. Set this option to a non-zero value in the project deployment configuration .ccr file. For example, <Option name="time-granularity" value=5"/>. See to the SAP Event Stream Processor: Configuration and Administration Guide for more information.



6.9 Troubleshooting Tips

Tips for troubleshooting issues with errors, and resetting your SAP ESP Cockpit configuration.

To obtain error information about any issues you encounter in SAP ESP Cockpit, refer to the COCKPIT-4/log directory.

If you need to reset your SAP ESP Cockpit configuration, stop SAP ESP Cockpit, and delete the repository.db and repository.log files in the COCKPIT-4\services\Repository\db directory.

6.10 Technical User is Not Defined

Problem: When you are attempting to configure alerts in SAP ESP Cockpit, a message displays stating that a technical user has not been defined and that alerts will be disabled until a technical user is specified.

You need to re-configure the SAP ESP Cockpit technical user.

Solution 1:

1. Run a fresh installation and choose the option to only install SAP ESP Cockpit. Make sure you specify a new installation directory, and when prompted, provide the same cluster name and cluster password as your original installation. If you originally ran a typical installation, specify esp1 as the cluster name.

2. After the installation completes, copy the <install dir>\COCKPIT-4\plugins\ESPMAP\tustore.xml file from the new installation to your existing installation.

3. Run the uninstall.bat or uninstall.sh script.

Solution 2:

1. Check that <install dir>\COCKPIT-4\plugins\ESPMAP\tustore.xml is present. If it is not present, follow the steps in Solution 1.

2. Open the tustore.xml file in a text editor.3. Verify that the resource element has its name attribute set correctly to the cluster name and the user

attribute set correctly to sys_streaming. For example:

<resource name="esp1" user="sys_streaming">

4. Re-encrypt and update the password value:1. Run the <install dir>\Sybase\COCKPIT-4\bin\passencrypt.bat or <install dir>/

Sybase/COCKPIT-4/bin/passencrypt.sh script and when prompted for the password to encrypt, provide the cluster password.

2. Update the value attribute of the credentials element in the tustore.xml file with the new encrypted password value returned by the passencrypt tool.



6.11 No Systems are Displayed on the Login Page

Problem: There are no systems displayed in the System drop-down list on the SAP ESP Cockpit login page.

SAP ESP Cockpit is running on Windows, which is set to a different locale than en-US, and there is no directory under %WINDIR%\system32\wbem that corresponds to the locale to which Windows is set. For example, if the locale is set to German - Germany, there should be a directory present named de-DE.

Solution: Copy the en-US directory and rename this copy to your locale. For example, rename en-US to de-DE.



Important Disclaimers and Legal Information

Coding SamplesAny software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.

AccessibilityThe information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet HyperlinksThe SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).


SAP Event Stream Processor: Cockpit GuideImportant Disclaimers and Legal Information

http://help.sap.com/disclaimer/

SAP Event Stream Processor: Cockpit GuideImportant Disclaimers and Legal Information


www.sap.com/contactsap

© 2015 SAP SE or an SAP affiliate company. All rights reserved.No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and notices.

http://www.sap.com/contactsap

http://www.sap.com/corporate-en/legal/copyright/index.epx

http://www.sap.com/corporate-en/legal/copyright/index.epx

sap event stream processor: cockpit guide · pdf file5.4 project administration.....124 adding...

Documents