Beruflich Dokumente
Kultur Dokumente
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
You can use options provided by the grid format to sort and organize displayed data.
Note
Sorting 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 de
scending order. The arrow in the columns sorting tab (to the right of the col
umn 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 Click a columns sorting tab to reverse its sort from ascending to descending
sort order or vice versa.
Nested sorting based on multiple col Click the column name for the primary sort. For subsidiary sorts, click the col
umns umns 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.
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.
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.
The font change applies to the SAP ESP Cockpit interface, and persists regardless of the SAP ESP Cockpit
system selected at login.
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).
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 ac
cessible 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.
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 bot
tom 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 browsers 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 .
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
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
<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
{} 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.
| 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 com
mand. Do not include ellipses in the command.
For the most current information about Adobe Flex keyboard shortcuts, see http://livedocs.adobe.com/
flex/3/html/help.html?content=accessible_5.html .
Note
To 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 .
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.
Note
If 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]
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.
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]
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 directorythat is, the home directory of the user who starts SAP ESP Cockpitis
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 users HOME environment variable to a writable
directory does not solve the problem.
Context
Note
If 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.)
%SYBASE%\COCKPIT-4\bin\cockpit.bat
shutdown
Caution
Do not enter shutdown at a Windows prompt; it shuts down the operating system.
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 directorythat is, the home directory of the user who starts SAP ESP Cockpitis
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 users HOME environment variable to a writable
directory does not solve the problem.
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
Bourne shell:
. SYBASE.sh
C shell:
source SYBASE.csh
Option Description
In the back Execute a command similar to the sample below that matches your shell. The sample command
ground 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.
C shell
Option Description
Caution
Do not enter shutdown at a UNIX prompt; it shuts down the operating system.
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
Ensure that your home directorythat is, the home directory of the user who starts SAP ESP Cockpitis
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 users HOME environment variable to a writable
directory does not solve the problem.
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
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
At a Execute:
com
mand net start "Cockpit 4"
line
The Cockpit 4 service is starting...... The Cockpit 4 service was
started successfully.
Option Description
In the Services window Select the cockpit service and click Stop.
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
Ensure that your home directorythat is, the home directory of the user who starts SAP ESP Cockpitis
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 users HOME environment variable to a writable
directory does not solve the problem.
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.)
Note
SAP 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
SCRIPT_NAME=cockpit.sh
to:
2. In Linux:
a. Discover the location of chkconfig by running one of these commands:
whereis chkconfig
or
which chkconfig
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>.d
Where <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.
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
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 backgroundit 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 Cockpituse 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.
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 machines 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 Cockpituse a separate command to start the Cockpit.
Table 5:
Port Name Description Service Names Property Names Default Port
Messaging messaging.db.port
Alert alert.database.port
-start | --start Start the Cockpit. This is the default optionif 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
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:
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:
This command sets all three of the repository database ports (data server, messaging, and database alert)
to 3638:
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:
This command starts the Cockpit instance called kalamazoo. -start is optional because it is the default:
Permissions
None required.
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
Note
Ensure 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 .netfor example, enter fred@sap,
not fred@sap.com. 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.
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.
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.
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
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.
Table 7:
Page Tab Statistics
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.
The SAP ESP Cockpit provides a general overview of node availability, performance, capacity, and alerts.
Table 8:
Statistic Description
Availability
Location: MONITOR Overview > Node page tab
Displays the state of the node. Possible values are running and stop
ped.
Performance
Location: MONITOR Adapters > Common Statistics table
Capacity
Location: MONITOR Adapters > Adapters table
Alerts
Location: MONITOR Overview > Alerts workset
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.
Note
In a multinode clusterwhere there is more than one node with a manager roleany 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.
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 managers 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.
Note
These additional options are over and above the minimum configuration described in Get Started with SAP
ESP Cockpit.
Related Information
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.
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
Note
For 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 agents default uafadmin account, see the topic on
setting passwords in the SAP Event Stream Processor: Installation Guide
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 ..
If you do not provide values for these parameters, they default to these values:
Related Information
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
Tip
If 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.
Set limits on the time SAP ESP Cockpit waits for data to load or on the number of rows it loads.
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
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
Set SAP ESP Cockpit to end login sessions when users are inactive for too long.
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
Use the Settings page to modify the screen refresh interval, in seconds.
Procedure
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.
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.
Related Information
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
Tip
If 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.
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
Context
Caution
Data 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
Tip
If 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.
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
Context
You can only view schedule details; you cannot modify them.
Procedure
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
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.
SAP recommends that you periodically move backup files to a secondary storage location to prevent the
installation directory from becoming too large.
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
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.
Next Steps
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
Incremental Backup
Full Backup
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.
5. Click OK to update any changes and close the Cockpit Settings page.
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
Incremental Backup
Full Backup
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.
5. Click OK to update any changes and close the Cockpit Settings page.
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
Incremental Backup
Full Backup
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.
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
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:
%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.
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
Context
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.
Note
If you configure purging as part of a scheduled backup of the repository, disable automatic purging on the
Size Management tab.
Procedure
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.
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.
Event Stream Processor has log files which record messages about system and component events.
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]
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
Table 9:
Column Name Description
Date The date and time at which the event occurred and the message was log
ged.
Severity Severity levels span from zero to five and correspond to:
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.
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
Table 10:
Column Name Description
Date The date and time at which the event occurred and the message was log
ged.
Severity Severity levels span from zero to five and correspond to:
Message Displays the log entries. Each log entry displays descriptive text according
to the severity level to which it corresponds.
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.
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:
Column Name Description
Date The date and time at which the event occurred and the message was log
ged.
Severity Severity levels span from zero to seven, and display the scale of impor
tance. 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.
Message Displays the log entries. Each log entry displays descriptive text according
to the severity level to which it corresponds.
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.
Context
Procedure
1. Navigate to:
Table 12:
Log Platform Location
Unix $SYBASE/COCKPIT-4/log/agent.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.
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.
Note
If there have been no new warnings or errors since the last time the log was viewed, the icon does not
appear.
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
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 itfor example, if you set the logging level to
WARN, you log events for the WARN, ERROR, and FATAL levels.
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 op
eration (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 oper
ating. This level is recommended for troubleshooting.
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.
Example
These commands, which must be executed in the installation directory, start SAP ESP Cockpit with the
logging level set to DEBUG:
bin\cockpit -m DEBUG
UNIX Execute:
bin/cockpit -m DEBUG
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
Option Description
Windows %SYBASE%\COCKPIT-4\conf\log4j.properties
UNIX $SYBASE/COCKPIT-4/conf/log4j.properties
Change the maximum size that a log file Agent log log4j.appender.agent.MaxFileSize
can reach before SAP ESP Cockpit cre Repository log log4j.appender.repository.MaxFileSize
ates a new file 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 Agent log log4j.appender.agent.MaxBackupIndex
Cockpit backs up before deleting the Repository log log4j.appender.repository.MaxBackupIndex
oldest file Collection statistics log log4j.appender.collection-stats.MaxBacku
pIndex
Alert server log log4j.appender.alert.MaxBackupIndex
Gateway log log4j.appender.gateway.MaxBackupIndex
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 instances ports; and to
configure a Windows instance to run as a service. Perform other tasks, including configuring a UNIX instance
Related Information
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
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.
instance -enable
instance -disable
Create an SAP ESP Cockpit server or agent from an installation on a shared disk.
Prerequisites
Procedure
1. Log in to the host on which you plan to run the SAP ESP Cockpit server or agent.
Note
You 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.
2. Change to COCKPIT-4/bin.
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:
To create an SAP ESP Cockpit server called Boston and configure it to run as a Windows service:
This command changes the port assignments for an SAP ESP Cockpit server called myserver:
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
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>, ...}]
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 instances 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.
Table 16:
Port Name Description Service Names Property Names Default Port
Messaging messaging.db.port
Alert alert.database.port
-refresh recopy all the files that make up this instance (Windows) or all this instances 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
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)"
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 requiredthe command does exactly the same thing without it.
or
deploys the server on this host and configures nondefault RMI, HTTP, and HTTPS ports.
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.
Note
In 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.
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.
refreshes the instance named kalamazoo. If kalamazoo is a server, refreshing it as an SAP ESP Cockpit
agent converts it into an agent.
instance
displays a list of all SAP ESP Cockpit server and agent instances deployed from this SAP ESP Cockpit
installation:
instance -list
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 4992
Cockpit 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:
Use the -force option to override the error and force the removal of the second agent instance:
Permissions
instance uses the permissions of the user, except as noted for certain parameters.
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 instances name is the same as its host name (the default).
When you run SAP ESP Cockpit server manually, issue a command every time you start or shut down.
2. To stop the SAP ESP Cockpit server instance, at the cockpit console command prompt, execute:
shutdown
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.
Table 17:
In the Services Click Start.
window
Table 18:
In the Services Click Stop.
window
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 instances name is the same as its host name (the default).
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.
. SYBASE.sh
C shell:
source SYBASE.csh
Table 19:
In the foreground Execute:
C shell
Table 20:
Run in the fore At the cockpit-console> prompt, execute:
ground
shutdown <instance-name>
Caution
Do not enter shutdown at a UNIX prompt; it shuts down the operating system.
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.)
Note
SAP 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.
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.
You can omit the -instance option if the instances name is the same as its host name (the default).
to:
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:
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.
Refresh an SAP ESP Cockpit server or agent deployed from an installation on a shared disk, or convert
between server and agent.
Prerequisites
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 instances 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 instances services and plug-ins.
Refreshing an instance preserves configuration and logs but overwrites the repository, so historical
performance data is lost.
Converting from an agent to a server adds server-related files to the instance; converting from a server to an
agent removes files.
Procedure
1. Change to COCKPIT-4/bin.
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.
This command refreshes an SAP ESP Cockpit agent called kalamazoo. If kalamazoo is a server, it
becomes an agent after the refresh.
This command refreshes an SAP ESP Cockpit agent called kalamazoo and reassigns kalamazoos RMI
and TDS ports. If kalamazoo is a server, it becomes an agent after the refresh.
3. (Optional) Display the status of the refreshed instance. Replace the name in the sample command with
your instances name, or omit the -instance option to display the status of the instance on this host.
Delete an SAP ESP Cockpit server or agent deployed from an installation on a shared disk.
Prerequisites
Removing an SAP ESP Cockpit instance deletes the instances files and directories (COCKPIT-4/instances/
<instance-name> and its contents) from the installation.
Procedure
1. Change to COCKPIT-4/bin.
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.
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
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 services port or reconfigure SAP
ESP Cockpit as described here.
Messaging messaging.db.port
Alert alert.database.port
HTTP) port
Procedure
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.
Example
Set all three database services (data server, messaging, and database alert) to the same port, 4639. (The
database services belong to the internal repository.)
Set the main SAP ESP Cockpit messaging service to port 4994.
Note
cockpit 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.
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.
Maximum memory You need to prevent SAP ESP Cockpit On machines with less than 4GB of mem
jvmopt=-Xmx if you from using more than a given amount ory, set maximum memory to 256MB or
of memory.
are running SAP ESP more.
Cockpit as a Windows SAP ESP Cockpit fails to start and may
service display an error: Could not Default value: none. (On machines with
COCKPIT_MEM_MAX if create the Java Virtual 4GB or more of memory, maximum mem
you are running Cockpit as machine. ory is set dynamically and is effectively lim
a UNIX service An OutOfMemory error says SAP ESP ited only by the amount of system memory
COCKPIT_MEM_MAX if Cockpit is out of heap space. available.)
you are starting Cockpit A warning message about system
from the command line memory appears during the start
process.
The machine where SAP ESP Cockpit
is installed has less than 4GB of mem
ory. (Starting SAP ESP Cockpit on a
machine with less than 4GB of mem
ory triggers the startup warning mes
sage about system memory.)
Permanent memory An OutOfMemory error says SAP ESP Increase by 32MB increments. If you reach
jvmopt=- Cockpit is out of permanent generation a value equal to twice the default and still
XX:MaxPermSize if space. see the OutOfMemory error, contact SAP
you are running SAP ESP technical support.
Cockpit as a Windows
service Default value: 128MB
COCKPIT_MEM_PERM
if you are running Cockpit
as a UNIX service
COCKPIT_MEM_PERM
if you are starting Cockpit
from the command line
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 persistSAP ESP Cockpit uses them every time it starts as
a service.
Related Information
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
Windows example:
UNIX example:
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 permanentSAP ESP Cockpit uses them
every time it starts as a service.
jvmopt=-Xmx512m
4. Save the file and start the SAP ESP Cockpit Windows 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 permanentSAP ESP Cockpit uses them
every time it starts as a service.
Procedure
COCKPIT_MEM_MAX=512
4. Save the file and start the SAP ESP Cockpit UNIX service.
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
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
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
You cannot prevent a valid managed system user from initially logging into SAP ESP Cockpit, but you can
prevent subsequent access.
Tip
Do 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.
Remove a user from the list of registered SAP ESP Cockpit users.
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
Context
Note
Use 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
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
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
Add details such as name, phone, and e-mail address for a user who has successfully logged in to a managed
system.
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
Note
User information is stored in the SAP ESP Cockpit repository. It is not updated to the user account in the
managed system.
Procedure
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.
Note
The 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
Use the SAP ESP Cockpit console to get status information on SAP ESP Cockpit and its ports, plug-ins, and
services.
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
help status
Display information about specified parts of the SAP ESP Cockpit server.
If you enter info with no parameters, it returns information for every parameter.
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 servers 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
info -p
shutdown
Examples
Example 1
shutdown
Display the status of the SAP ESP Cockpit agent, plug-in, or service components of SAP ESP Cockpit.
Syntax
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.
Example 1
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
Option Description
Windows %SYBASE%\COCKPIT-4\conf\csi_config.xml
UNIX $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 thisbe sure
to paste inside the double quotes:
Related Information
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
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
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
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.
Table 24:
Page Tab Statistics
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.
Use the Cluster page to monitor overall statistics, alerts, and topology for the cluster to which the current node
you are monitoring belongs.
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
Table 25:
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 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.
Table 26:
Page Tab Statistics
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.
Node Includes a Nodes header table which contains information for all
nodes which belong to the cluster.
Topology Visual display of all nodes belonging to the cluster, including node
name and its role.
Use the All Statistics page to monitor overall statistics of the current ESP 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
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
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
Table 27:
Table Name Statistics
Projects This is the header table containing all projects within the current node you are monitor
ing.
Project Name
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.
Network Rows Transferred History - line graph displaying rows received and rows sent per sec
ond over time.
The data on the graph starts displaying from the time you open the Projects page.
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)
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
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
Table 29:
Table Name Stream Details
Streams This is the header table displaying information for all streams on the current ESP node.
Type - The type of the stream. Possible values are stream, keyed stream, window, or meta
data.
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:
Statistics Description
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.
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
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
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 sub
scribers 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.
Use the Adapters page to monitor the performance of adapters belonging to the current node. View statistics
such as numbers of rows processed.
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
Adapters This is the header table containing all adapters within the current node you are monitoring.
Status - adapter status. Valid values are initial, stopped, ready, continuous, idle, done, or
unknown.
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.
These statistics display for the adapter you select in the header table:
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 infor
mation is not available, then zzz is empty meaning it consists of no characters at
all.
yyyy is the year.
<Custom Statistic Name> If the adapter you select has custom statistics to report,
these display here. Note that not all adapters have custom
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
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
Table 35:
Table Name Publisher Details
Publishers This is the header table containing information for all publishers belonging to the current
ESP node.
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:
Statistics Description
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.
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
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
Table 37:
Table Name Subscriber Details
Subscribers This is the header table containing information for all subscribers on the current ESP
node.
Port - port number on the subscriber's machine used to receive published data from
Event Stream Processor.
These statistics display for the subscriber you select from the header table:
Table 38:
Statistics Description
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.
The data on the graph starts displaying from the time you you select the Subscribers
page.
View information for any bindings that are present on the node you are monitoring.
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
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.
Workspace - name of workspace on which the project to which the binding is attached
is running.
Status - the current status of the binding. Valid values are initial, stopped, ready, contin
uous, idle, done, or unknown.
Type - if the row is displaying a binding rather than an adapter, the value of this column
is Binding.
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.
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
For more information on planning and configuring a cluster, see the SAP Event Stream Processor:
Configuration and Administration Guide.
Related Information
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
Note
If 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.
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
Your user account has the required read and admin permissions in ESP.
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
Note
If 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.
To change the cluster authentication type post-installation, use the ESP Cockpit to create a new authenticator.
Related Information
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
Note
You can have multiple authenticators.
ServerType
ProviderURL
DefaultSearchBase
AuthenticationScope
Rolescope
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:
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:
ldap://<hostname>:<port>
dc=<domainname>,dc=<tld>
For example, a machine in the mycomnpany.com
domain would have a search base of dc=mycom
pany,dc=com.
o=<company name>,c=<country code>
For example, this might be o=mycompnay,c=us for
a machine within the Mycompany organization.
onelevel
subtree
onelevel
subtree
AuthenticationFilter For most LDAP servers: (Optional) The filter to use when looking up the user.
(&(uid={uid})
(objectclass=person) When performing a user name based lookup, this filter is
) used to determine the LDAP entry that matches the sup
plied user name.
or
The string "{uid}" in the filter is replaced with the sup
For Active Directory e-mail
plied user name.
lookups: (&
(userPrincipalName={
uid})
(objectclass=user))
[ActiveDirectory]
<options name="BindPassword"
encrypted="true"
value="1snjikfwregfqr43hu5io..."/>
<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: (Optional) The role search filter. This filter should, when
(&
combined with the role search base and role scope, re
(objectclass=ldapsub
turn a complete list of roles within the LDAP server.
entry)
There are several default values, depending on the
(objectclass=nsroled
chosen server type. If the server type is not chosen and
efinition))
this property is not initialized, no roles are available.
For Netscape Directory
Server: (|
(objectclass=groupof
names)
(objectclass=groupof
uniquenames))
For ActiveDirectory: (|
(objectclass=groupof
names)
(objectclass=group))
UserRoleMembershipAttributes For iPlanet/SunONE: nsRo (Optional) Defines a user attribute that contains the DNs
leDN
of all of the roles a user is a member of.
For Active Directory: mem
These comma-delimited values are cross-referenced
berOf
with the roles retrieved in the role search base and
For all others: none search filter to generate a list of user's roles.
Note
If you use nested groups with Active Directory, you
must set this property to tokenGroups.
SelfRegistrationSearchBase None (Optional) The search base to use when creating a new
user as part of self registration. If this value is not speci
fied, the default search base will be used. The authenti
cation search base is used for self update operations.
Prerequisites
Your user account has the required read and admin permissions in ESP.
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 systems built-in authentication
framework.
Procedure
Note
You can have multiple authenticators.
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.
8. Click Apply.
9. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
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
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:
Note
The 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.
Note
In 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_123
Automatic 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.
Example
Example: 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:
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
Note
You can have multiple authenticators.
cmsUri
authenticationMethod
Prerequisites
Your user account has the required read and admin permissions in ESP.
Note
You can have multiple authenticators.
Digester
Algorithm
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
Note
You can have multiple authenticators.
principal
keytab
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
Note
You can have multiple authenticators.
jdbcUrl
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
Note
You can have multiple authenticators.
username
password
8. Click Apply.
9. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Edit cluster-wide macros. Macros are configuration file shortcuts for centralizing a repeated configuration, or
for acquiring properties from the environment.
Prerequisites
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Select the Macros tab.
Table 43:
Property Description
4. Click Apply.
5. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Prerequisites
Procedure
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Select the System Properties tab.
4. Click Apply.
5. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Edit cluster-wide attributes, including secure sockets layer (SSL), application heartbeat interval, multicast
manager, and cluster persistence.
Prerequisites
Procedure
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Select the Attributes tab to edit the settings for the cluster:
Table 45:
Attribute Description
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.
Persistence Type (If Cluster Persistence is enabled) Specify the persistence type. Valid op
tions are directory and database.
Persistence Directory (If Cluster Persistence is enabled) Specify the path to the persistence di
rectory.
3. Click Apply.
4. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
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
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Applications folder and select ha_project.
Table 46:
Property Value
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.
Note
stdstreams.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.
5. Click Apply.
6. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
For more information, see High Availability in the SAP Event Stream Processor: Configuration and
Administration Guide.
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
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Applications folder and select project.
Table 47:
Property Value
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.
Note
stdstreams.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.
5. Click Apply.
6. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
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
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Applications folder and select toolkit_adapter.
Table 48:
Property Value
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.
Note
stdstreams.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.
5. Click Apply.
6. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Prerequisites
The SAP ESP cluster key store is a repository of security certificates for accessing Event Stream Processor.
Procedure
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Security folder and select Key Store.
3. Edit the Key Store settings:
Table 49:
Name Value
Set the filepath to the location of the key store file. For ex
ample, set it to $(STREAMING_SHARED)/
security/keystore_rsa.jks.
4. Click Apply.
5. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Prerequisites
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Services folder and select compiler.
3. (Optional) Edit the default values.
Table 50:
Property Value
4. Click Apply.
5. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
Prerequisites
Procedure
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Expand the Services folder and select discovery.
3. (Optional) Edit the default values.
Table 51:
Property Value
4. Click Apply.
5. Restart all running nodes for any changes to take effect. Changes are stored in the cluster database.
For more information on configuring a node, see the SAP Event Stream Processor: Configuration and
Administration Guide.
Related Information
Prerequisites
Your user account has the required read and admin permissions in ESP.
Procedure
ESP Node Name Specify the name of the node. This name must be unique
throughout the cluster.
Admin Port (Optional) Specify the admin port for the server. This al
lows you to distinguish between administrative and non-
administrative users.
Key Store File Specify the location of the key store file. For example, $
(STREAMING_SHARED)/security/
keystore_rsa.jks.
4. Click Done.
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.
Related Information
Prerequisites
Procedure
1. In ESP, select the EXPLORE workset, then select ESP Nodes, then select Actions Configure
Cluster .
2. Select the node you want to configure.
3. Select the Macros tab to view inherited cluster macros and node-specific macros.
Table 53:
Property Description
4. Select the System Properties tab to view inherited cluster system properties and configure node-specific
properties.
Table 54:
Parameter Description
Table 55:
Property Description
Admin Port (Optional) Specify the admin port for the server. This al
lows you to distinguish between administrative and non-
administrative users.
Cache Host Name Specify the host name of the cluster cache.
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.
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.
You are logged in to SAP ESP Cockpit.
Your user account has the required read and admin permissions in ESP.
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:
Property Description
ESP Node Name The name of the node. This name must be unique
throughout the cluster.
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-ad
ministrative users.
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.
Related Information
Prerequisites
Your user account has the required read and admin permissions in ESP.
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.
Prerequisites
Your user account has the required read and admin permissions in ESP.
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.
View project properties, and start, stop, add, and remove projects from a node.
Related Information
Prerequisites
Your user account has the required read and admin permissions in ESP.
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.
Prerequisites
Your user account has the required read and admin permissions in ESP.
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.
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
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.
Related Information
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.
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.
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.
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.
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.
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.
Tip
The 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.
Note
You 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
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
Note
SAP strongly recommends that you
leave this collection running for
each monitored ESP node.
Project
Stream
Publisher
Subscriber
Related Information
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.
Total CPU Usage (Percent) The sum of total CPU usage, since the last update, of all
projects which are running on the node.
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 publish
ers 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.
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 up
date.
Physical Memory Usage (KB) The physical memory usage for the project since the last up
date.
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.
Total CPU Usage (Percent) The total CPU usage for the stream since the last update.
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 up
date.
Rows per Sec (Count) The number of rows processed by the stream, in one second,
since the last update.
Stream Rows Stored (Count) The current number of records in the stream's store.
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.
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.
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.
Number of Rows Received per Sec (Count) The gateway client's performance, in data rows per second,
received since the last update.
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 includes various configurable alerts. All alerts are listed in the Configure page under the
ALERT workset.
Low PENDING
Medium UNKNOWN
High WARNING
ERROR
STOPPED
Low PENDING
Medium RUNNING
High STOPPED
UNKNOWN
WARNING
Low PENDING
Medium RUNNING
High STOPPED
UNKNOWN
WARNING
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 11 to 1000
Low 11 to 1000
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 11 to 1000
Low 11 to 10000000
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 11 to 1000
Low 11 to 1000
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 31 to 70
Medium 71 to 90
High 91 to100
Low 51 to 500
Low 51 to 500
Low 51 to 500
Low 51 to 500
Low 51 to 500
Low 51 to 500
Low 51 to 500
Low 51 to 500
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).
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.
Note
The 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.
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
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.
Note
An administrative SAP ESP Cockpit user can set additional notification parameters. See Managing Alert
Notification Settings.
Procedure
Note
When you click the ALERT workset for the first time in the current session, there may be a delay before
the NOTIFY option appears.
Option Description
An administrative SAP ESP Cockpit user can set his or her email address for notification and define additional
notification attributes for alerts.
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
The email server and port must be configured to enable email notification. See Configuring the E-mail
Server.
A technical user account exists.
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
Note
When you click the ALERT workset for the first time in the current session, there may be a delay before
the NOTIFY option appears.
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 semi
colons.
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 speci
fied, in minutes, if an alert continues to fire.
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
A technical user account exists.
Procedure
Note
When 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.
You can enable and disable alerts as well as configure the trigger thresholds for each alert.
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
A technical user account exists.
Context
Modifications to alert thresholds take effect the next time the monitoring interval is reached.
Note
If 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
Note
When 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.
Troubleshoot problems that occur in SAP ESP Cockpit when administering the SAP Event Stream Processor
environment.
Related Information
Problem: Pressing the F5 key to refresh your browser logs you out of SAP ESP Cockpit.
Browser refresh updates the loaded application or pages in the browserin this case, the Adobe Flash on
which SAP ESP Cockpit is built.
Consequently, pressing F5 logs you out of servers, including SAP ESP Cockpit.
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).
Solution: SAP ESP Cockpit might use a port that is used by another server or application. To check for port
conflicts:
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.
Increase the maximum memory setting if you see this error when you try to start: Could not create the
Java Virtual machine.
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?
Problem: When trying to connect to SAP ESP Cockpit in Firefox, fatal error #2035 appears before the login
screen appears.
Solution:
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.
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.
Note
This 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.
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-
Tip
In 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.
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
Note
If 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.
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.
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.
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.
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:
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.
Coding Samples
Any 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.
Accessibility
The 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 Language
As 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 Hyperlinks
The 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).