CanaryCode UG 1705 - Datavardinfo.datavard.com/hubfs/Canary_Code_PDFS/CanaryCode_UG... · 2017-10-09 · BusinessObjects GRC Global Trade Services, SAP GTS are the trademarks or registered

DATAVARD CANARYCODE TM 1705

User Documentation

May 2017

Version 1705

© 2017 Datavard // 2

TABLE OF CONTENTS

Contents

TABLE OF CONTENTS ................................. ................................................................................ 2

Copyright 5

New in CanaryCodeTM 1705 6

New in CanaryCodeTM 2.03 6




New in CanaryCodeTM 1.64 (final) 10





Introduction ...................................... ........................................................................................... 12

About this documentation 12

What is CanaryCode? 12

CanaryCodeTM Summary 12

Installation ...................................... ............................................................................................. 13

Determine monitoring and monitored systems 13

Requirements 13

Getting SAP transport requests 14

Installation via SAP transport requests 14

Installation of license 16

License Check 19

User Manual ....................................... ......................................................................................... 20

CanaryCode TM monitoring ........................................ .................................................................. 21

Collector job 21

Profile 22

KPI 22

Collectors 22

CanaryCode TM setup ............................................. ...................................................................... 24

Add a new system 24

Delete system from monitoring pool 26


Create a Collector job (for monitoring) 27

Reporting of KPI chart 28

System settings maintenance 30

System maintenance: 30

System groups: ...................................................................................................................... 31

Configuration parameters:...................................................................................................... 32

Restriction in monitoring:........................................................................................................ 35

Time intervals: ....................................................................................................................... 36

Message groups: ................................................................................................................... 37

Message notification: ............................................................................................................. 37

User List ................................................................................................................................ 38

Monitoring settings maintenance 40

KPI Collectors: ....................................................................................................................... 40

Collector’s parameters: .......................................................................................................... 42

KPI Definitions: ...................................................................................................................... 43

Detail tables: .......................................................................................................................... 48

Profiles definition: .................................................................................................................. 49

Alert definition: ....................................................................................................................... 51

User settings 53

General settings: .................................................................................................................... 54

Search Tool bar for System Pool tree and KPI pool tree ........................................................ 55

CanaryCode TM Monitor ........................................... ..................................................................... 58

To run the Monitor, use the transaction: 58

GUI description 58

Menu buttons 59

System tree 61

KPI tree 64

Time interval 65

System info tab 67

Collector jobs tab 68

KPI tab 70

KPI mix tab 73

Messages tab 74

Details tab 75

Events tab 76

Benchmarking ...................................... ....................................................................................... 79

Benchmark Manager 79

Benchmark Results ................................................................................................................ 80


Monitoring Results ................................................................................................................. 80

Incident Management ............................... .................................................................................. 83

Incident Detail 84

Solution Detail 85

FIORI dashboard for CanaryCode..................... ......................................................................... 87

Setup of OData service 87

Prerequisites .......................................................................................................................... 87

Setup of OData service on CanaryCode Central system ........................................................ 87

Setup of FIORI dashboard for CanaryCode on different system (Optional) ............................ 89

Introduction ............................................................................................................................ 90

Prerequisites .......................................................................................................................... 90

Setup on target system .......................................................................................................... 90

Setup of UI5 web application ................................................................................................. 91

Prerequisites .......................................................................................................................... 91

Setup steps ............................................................................................................................ 91

Appendix 1: Glossary of Terms ..................... ............................................................................ 94

Appendix 2: List of Figures ....................... ............................................................................... 104

CONTACT .................................................................................................................................. 107

canarycode.com..................................... ................................................................................... 108


Copyright

Any redistribution or reproduction of part or all of the contents in any form is prohibited

other than the following:

You may print or download to a local hard disk extracts for your personal and non-

commercial use only.

You may copy the content to individual third parties for their personal use, but only if you

acknowledge this document as the source of the material.

You may not, except with our express written permission, distribute or commercially exploit

the content. Nor may you transmit it or store it in any website or other form of electronic

retrieval system.

SAP, ABAP, SAP Business Suite, SAP ERP, SAP Customer Relationship Management

(SAP CRM), SAP ERP Human Capital Management (SAP ERP HCM), SAP ERP

Operations, SAP ERP Financials, SAP Product Lifecycle Management (SAP PLM), SAP

Supplier Relationship Management (SAP SRM), SAP Supply Chain Management (SAP

SCM), SAP Business One, SAP Business All-in-One, SAP NetWeaver Business

Intelligence (SAP NetWeaver BI), SAP NetWeaver Master Data Management, SAP

NetWeaver, SAP Solution Manager, SAP Exchange Infrastructure (SAP NetWeaver XI)

SAP Business Information Warehouse (SAP BW), SAP Strategic Enterprise Management

(SAP SEM), SAP R/3, SAP R/3 Enterprise, SAP Business ByDesign, SAP

BusinessObjects GRC Global Trade Services, SAP GTS are the trademarks or registered

trademarks of SAP AG in Germany and in several other countries.


New in CanaryCode TM 1705

• Collector for monitoring of OS command evaluation

• Collector for monitoring system folders / aliases sizes

• Collector for monitoring RFC destination ping

• Rebuild authorization profiles for CC roles after upgrade

• HeatMap connection to CC

• Delegate DT to central colector

• Add Table Space calculation for DB6

• License is not addicted from HW key change

• Default ping wait from 4-10 seconds

• Detection of javastack monitoring area on satellite

• Remove BTC_JOB_GROUP and BTC_MAX_COUNT configuration parameters

• Fix RFC communication failure messages

• Fix email notification sending when no sender

• Fix list of collected KPI for system

• Fix for server restrictions

• Fix HW key with lowercase in licensing

• Fix for SYBASE DB

• Fix for NumberRange collector

• Fix SAPOSCOL monitoring for 7.10 and higher

• Fix server availability detection for sattelites in old releases

New in CanaryCode TM 2.03

• Store monitoring results to secondary storage via SM

• Support hadoop as secondary storage

• New concept of asynchronous check of sys. availability

• New notification HTML layout with detail tables and alert agregation

• Healt check report

• In point zooming in chart

• Fix missing NRIV KPIs for BW

• Fix for instalation number in license window


• Fix missing EDIT button for alert long description

• Fix often occuring of message 043

• Fix for interval save on first usage

• Fix issue with dependency on /DVD/MON_DUMPDEF and /DVD/MON_CUSREG

• Fix issue with table content for /DVD/MON_WATGRP

• Fix RFC resource consumption issue

• Fix multiple checking of KPI in KPI mixer

• Fix displaying of hidden fields for ALV grids

• Fix for displaying of last KPI value


• Display KPI values in chart with logarithmic axes

• New collector for checking auth. values in org. level fields of roles

• New collector for checking role comparison

• New collector for checking authorizations

• New collector for monitoring referenced users

• New collector for monitoring security notes

• Template for standard notification via e-mail changed to HTML

• Notification also with detail tables

• Timestamp is allowed in detail table structure

• Enhanced protection function in a case of high resource consumption

• Added progress notification for loading KPI charts

• Enhanced UI for saving time intervals of checked systems

• Fix for SID filtering when system was removed

• Fix for conversion exit of SID element

• Fix issue with input table containing semicolon

• Fix detail table compatibility with lower release of satellite

• Fix of PING of empty host name


• New collector and KPIs for monitoring mail service

• New collector and KPIs for monitoring oracle LOG


• New collector for monitoring oracle tablespaces

• Performance improvements of central cockpit

• Security improvements to be validated by VirtualForge CodeProfiler

• New configuration parameters for prioritizing of collecting job execution

• Hide not monitored servers for default user

• Unhide unused KPIs and groups for default user

• Search help for KPIs with authorization check

• Detail table for disk utilization

• Monitoring of external servers via Web Service CO_WSSAPOSCOL

• Extending server definition with field 'EXTERNAL'

• Solved problem with production system flag on non–productive systems

• KPIs for JAVASTAK was moved to new collector for better load balance

• Fix issue with displaying event details

• Fix issue with chart freezing

• Fix issue with retention cleansing on detail tables

• Fixed minor bugs and issues

• Fix duplicate error message

• Fix PING of servers with host name via OS level

• Fix for displaying of KPIs from no-selected systems

• Fix for displaying results in user and system time zone

• Fix retention deletion for detail tables

• Fix cleanup of hanging dialog work process

• Fix security findings from VirtualForge

• Fix dumping on remote system failure

• Fix detail table fields


• Extending System ID length from CHAR3 to CHAR10

• Conversion exit for System ID to display only 3 characters based on user setting

• Removing client field MANDT from all tables – CC is now client independent

• New licensing mechanism

• FIORI dashboard


• oData services for CanaryCode FIORI application load

• Naming restriction for KPI names, profiles, events and KPI groups to X* and Y*

• Storing detail tables in cluster, persistence of DB table on central monitoring

instance is not needed anymore

• Enhanced event notification with determining of notification BAdI via BADI_ID

filtering

• New event notification BAdI with HTML layout for sending alerts

• Tuned up performance for refresh in UI cockpit

• Introduced button for default monitoring

• User interface usability changes

• Introduced multiple monitoring areas like ERP, HANA, BW, GRC, ...(replacing

system type)

• English texts adoption to other languages

• Introduced CanaryCode Customer ID for better identification of customer and

cooperation with him

• Incident management

• System benchmarking

• Benchmarking collector, measuring performance of SQL operations

• Sending monitoring results for analyzing

• Popup for notification of new version

• Added recommended period and recommended retention for monitoring to KPI

definition

• Added default period and retention for monitoring to profile definition

• Re-customized default profiles

• Change log for all customizing tables

• Collector for HANA system parameter changes

• Tuned up BG job collector

• WP collector provide WP details only with no-zero time processes

• Enhanced authorization roles

• Storing of detail tables to specific DB tables is obsolete

• Detail table for BW Process chains which are in some error

• Collector for profile parameters was updated

© 2017 Datavard // 10

• New HANA collectors for HANA monitoring

• Fixes and performance optimizations

New in CanaryCode TM 1.64 (final)

• Event notification via customizable BAdI

• Remembering of expanded systems and servers

• Select systems with alerts via context menu

• Ability to add note and processor to event

• Period of restriction was enhanced to weekly

• Forced kill of active BG Job after stop

• New KPI BW_DURCOMPRESS - runtime of cube compression

• New BAdI implementation for notification for iDocs KPIs as HTML with detailed

results

• FIX of threshold in charts ONLY for the selected systems

• FIX in IDOC collector

• FIX of application statistic collector

• FIX of event output with relevance of monitoring restriction


• Support redirection via SAP shortcut

• Forced kill of BG Job after timeout of Collector Job

• User UI serialization works with refreshing period and expanded tree

• New KPIs for compliance

• New collector and KPIs for iDocs

• Cross-client copy of customizing tables

• FIX for KPI delay since last successful run on no response

• FIX for application server memory size on HANA nodes

• FIX for event evaluation for generic SID and PROFILE


• New logo

© 2017 Datavard // 11

• Enhanced monitoring restriction to EVENTs

• Performance enhancement of collector for buffers and SAP memory

• New KPIs for HANA

• New KPIs for GRC

• BUG fixes


• Context menu in system pool tree for select/deselect all systems/servers

• Event rule can be system specific now and valid for specific time

• Filter for systems, profiles and KPI groups for specific user

• Quick search bar in system pool tree and KPI tree

• Report generator for KPI charts with sending of e-mails

• Transaction for reset of user settings

• Enhanced customizing

• New KPI for measuring of delay since lust successful run


• System groups in system pool tree

• Configuration properties for monitoring

• Main screen upgrade

• Auto refresh of time interval

• KPI, profile and event customizing is unified under customizing of monitoring

• Change log for input tables

• Retention deletion performance upgraded

• Setup of timeout for Collector job run

• New work process KPIs

• New collector and KPIs for workload statistics

• BUG fixes

© 2017 Datavard // 12

Introduction

About this documentation

The purpose of this document is to explain to the end-user, the process of installing, using,

and updating Datavard’s CanaryCodeTM – a performance-monitoring tool for hardware,

operation systems and SAP systems on the application level.

This document is aimed primarily at SAP system administrators and SAP consultants

focusing on system monitoring and application performance monitoring.

What is CanaryCode?

CanaryCodeTM is software developed by Datavard as a performance, processes, security-

monitoring tool for SAP systems. On top of that, it is DB and OS independent.

CanaryCodeTM uses a universal and sophisticated approach for collecting information from

remote systems. You can monitor any system status, process and workload in real time

and do security checks. All values captured from the system, also called KPI (Key

Performance Indicator) are collected and processed by the monitor. You can adjust the

monitor to watch crucial KPIs by creating events. These events provide information in case

KPIs reach their critical values.

Additionally, the CanaryCodeTM offers an analysis of the monitored system with

appropriate recommendations and conclusions. This analysis describes system behavior

at the time of monitoring and determines what happened or could happen in the system.

For more information about CanaryCodeTM and other Datavard solutions, please visit

http://www.datavard.com/.

CanaryCode TM Summary

� It is a monitoring solution � Collect more than 300 predefined KPIs � Monitors system status, processes, applications, workload in real time � Executes security checks � Handles own events on monitored system � Provide notification mechanism for alerts � Gives conclusions and recommendations for the monitored system

© 2017 Datavard // 13

Installation

Determine monitoring and monitored systems

CanaryCodeTM is monitoring tool with capability to monitor SAP systems remotely . Before

installation you have to determine which system in your landscape will serve as

CanaryCode TM central (monitoring) instance and CanaryCode TM satellite (monitored)

instance. You can decide to monitor all SAP system from one central instance or each

SAP system will be monitored by self that means it will act like CanaryCode TM central and

satellite instance as well (also known as self-monitoring).

We highly recommend a monitoring solution with one central instance and

more satellite instances, due a better maintenance coming from centralized

principle of monitoring.

Requirements

• SAP system at least release 7.00 up to 7.40 . Please contact us in a case of installation for 6.20 and lower or 7.50 and higher.

• CanaryCode TM administrator user is created on the central monitoring system. An authorization role /DVD/MON_ADMIN (delivered in transport) has to be assigned to the user after installation. The role allow to run the following transactions:

� /DVD/MON – CanaryCodeTM Monitor � /DVD/MON_INC – CanaryCodeTM Incident Management

CanaryCode

central instance

CanaryCode

satellite instances

SAP system AB1

AB2

AB3

AB4

CanaryCode

central instances

with self-monitoring

AB1

AB2

AB3

AB4

Figure 1 Centralized monitoring Figure 2 Decentralized monitoring

© 2017 Datavard // 14

� /DVD/MON_SYS – CanaryCodeTM System Settings � /DVD/MON_KPI – CanaryCodeTM Monitoring Settings � /DVD/MON_REPORTING – CanaryCodeTM Reporting � /DVD/MON_INIT – CanaryCodeTM User Settings Reset � /DVD/MON_LOG – CanaryCodeTM Changelog � SM30 - Call View Maintenance � SM37 - Overview of job selection � SM59 - RFC Destinations (Display/Maintain) � SBWP – SAP Business Workplace � SO23 – SAPoffice: Distribution Lists � SCOT - SAPconnect – Administration

• CanaryCode TM Viewer User (OPTIONAL) is created on the central monitoring system. An authorization role /DVD/MON_VIEWER (delivered in transport) has to be assigned to the user after installation.

• Trusted RFC connections (ABAP R/3 connections) from CanaryCodeTM central monitoring system to each CanaryCodeTM satellite system. In a case of self-monitoring NONE transaction has to be used.

• RFC system user on all monitored system. An authorization role /DVD/MON_SATELLITE (delivered in transport) has to be assigned to the user.

Getting SAP transport requests

• Download SAP transport request in .ZIP file from official web page http://canarycode.com/en/download/

• Check if .ZIP file contains following folders: cofiles – contains SAP transport request co-files, data – contains SAP transport request data files.

• Check if .ZIP file contains following files: !README! - installation instructions.txt – installation instruction, Changelog.txt – changelog for current version and release, *.url – links to specific CanaryCode web pages.

Don’t use transport from other sources . Use only SAP transport requests

provided on official CanaryCode web page www.canarycode.com or from

Datavard consultants.

Official webpage provide always newest version and release of CanaryCode monitoring tool.

Installation via SAP transport requests

• Download CanaryCodeTM transport request package in .ZIP file from webpage http://canarycode.com/en/download/. Unzip package and add corresponding transport requests (co-files and data-files located in sub-folder COFILES and DATA) to transport directory of your system(s).

• Import mandatory CanaryCodeTM transports (1. and 2.) to central system first and then to satellite systems in right order :

© 2017 Datavard // 15

1. NSDK****** – Datavard Reuse Library *.** * release 20**. The library contains basic R3 objects needed for CanaryCode. The transport contains following packages:

� /DVD/AF_RESULT – analytical framework, � /DVD/HDP – HADOOP support, � /DVD/LIC_PUB – licensing, � /DVD/RL – base library of tools and utilities, � /DVD/RU - base library of tools and utilities for older releases, � /DVD/SAP_JAVA_CONN – JAVA support, � /DVD/SM – storage management, � /DVD/TH – task handler.

2. NSDK****** – CanaryCode v2.** (r.***) – The transport contains all CanaryCodeTM R3 objects for central and satellite instance. Transport contains following packages:

� /DVD/CC – main CanaryCode package, � /DVD/JSC – JavaScript support, � /DVD/MON – CanaryCode framework and central cockpit, � /DVD/MON_BAT – collectors for basis and technology monitoring, � /DVD/MON_BEN – benchmark manager, � /DVD/MON_BTC – collectors for background job monitoring, � /DVD/MON_BW – collectors for BW monitoring, � /DVD/MON_BWA – collectors for BWA monitoring, � /DVD/MON_COL – collectors for OS and SAP instance monitoring, � /DVD/MON_GRC – collectors for Governance, Risk and compliance

monitoring, � /DVD/MON_IDOC – collectors for iDocs monitoring, � /DVD/MON_INC – incident manager, � /DVD/MON_STAT – collector for workload statistic monitoring

Follow installation instruction located in .ZIP fil e! It contains specific transport request numbers for this CanaryCode relea se.

Install transport request in correct order!

Don’t import Datavard Reuse Library if you already have installed newer

version installed with other Datavard products. If you have older version

of Datavard Reuse Library then you have to import t he newest one.

Before upgrading to the new er version of CanaryCode , you have to stop monitoring all Collector jobs! After the upgrade is completed, you can

start the collector jobs.

• [OPTIONAL] On SAP system which is running on HANA database you can install collectors for HANA monitoring from following transport

3. HNAK****** - HANA collectors for CanaryCode 2.** (r .***) – transport contains following package: /DVD/MON_HDB – collectors for HANA monitoring.

© 2017 Datavard // 16

Don’t install transport for HANA collectors on SAP system which is not running on HANA database!

• [OPTIONAL] For using of CanaryCode FIORI dashboard you have to install two separate transports. First is for oData service which provides data from CanaryCode to FIORI dashboard. It has to be imported on CanaryCode central instance. A second is service for FIORI dashboard (web application) self. It can be installed also on system where no CanaryCode was installed before (depending on deployment options). The FIORI dashboard gets data remotely from oData service. Installations of both transports have special SAP system requirements. They are mentioned for each transport:

4. NSDK****** - oData connector for CanaryCode 2.** (r .***) – transport install oData service connector for CanaryCode FIORI dashboard. Import transport only on central system. Transport contains package /DVD/MON_ODATA. An ABAP Gateway has to be installed on releases 7.0 to 7.31 via SAP add-ons GW_CORE 200, IW_FND 250, IW_BEP 200. Supported releases are:

SAP NetWeaver 7.0 (from SPS25) SAP NetWeaver 7.01 (from SPS10) SAP NetWeaver 7.02 (from SPS07) SAP NetWeaver 7.03 (from SPS01) SAP NetWeaver 7.31 (from SPS01) SAP NetWeaver 7.40 (from SP01)

5. ED2K****** - FIORI dashboard for CanaryCode 2.** (r .***) – can be imported independently on CanaryCode transports. Install it on SAP system which serves or will serve for FIORI web access. SAP UI add-on 1.0 has to be installed on release 7.0 to 7.31. Supported releases are:

SAP NetWeaver 7.0 (from SPS25) SAP NetWeaver 7.01 (from SPS10) SAP NetWeaver 7.02 (from SPS07) SAP NetWeaver 7.03 (from SPS01) SAP NetWeaver 7.31 (from SPS01) SAP NetWeaver 7.40 (from SP01)

Installation procedures and configurations for SAP FIORI and oData services

can be found on official SAP pages SAP Fiori – isntallation and Installation

overview. You can also find specific step by step procedures for setup of FIORI

dashboard for CanaryCode at the end of this user guide.

Check if your system fulfills requirements and cont ains necessary add -ons before importing Fiori or oData transports!

Installation of license

• Run transaction /DVD/MON in the central monitoring system – first run of CanaryCodeTM Monitor

© 2017 Datavard // 17

• The system displays the License dialog window

Figure 3: License dialog window

• You have to fill following fields: � “CanaryCode customer ID” – You will get it after first registration. You have

to use this ID in each communication with DataVard. It serves as your unique identifier.

� “Customer name” – Your company name. Use same like you used when you register on web site or was send with license key.

� “SAP Customer number” – [OPTIONAL] Customer number provide by SAP. Use same like you used when you register on web site or was send with license key. Not all customers have such number. Field can be empty.

� “Contact person name” – Full name of person used in a communication to Datavard. Use same like you used when you register on web site or was send with license key.

� “Contact person email” – Email address of contact person used in a communication to Datavard. Use same like you used when you register on web site or was send with license key.

� “Contact person phone” – Phone number of contact person used in a communication to Datavard. Use same like you used when you register on web site or was send with license key.

� “License type” – Type of license for which you registered system. There are three type of license:

1. Community edition – License is for free for one central instance. You still have to register for getting license key. License is time unlimited but you have to prolong license key every year. License is limited only for number of monitored systems. From 1 central instance you can monitor 2 systems which one can productive.

2. Enterprise edition – License is payed and can be negotiated for specific time and number of monitored systems. For more details contact Datavard.

© 2017 Datavard // 18

3. Premium edition – License is payed and can be negotiated for specific time and number of monitored systems. For more details contact Datavard.

� “Total count of systems to be monitored” – Maximum count of system which you can monitor from central system (including self-monitoring). Use same count like you requested when you request for license key on web site or was send with license key. For community edition it can be only two.

� “Count of production systems to be monitored” – Maximum count of production system which you can monitor from central system (including self-monitoring). Count cannot be higher than total system count. Use same count like you requested when you request for license key on web site or was send with license key. For community edition it can be only one.

� “License valid till” – determines the time of license expiration. Use same date like you get with license key. For community edition it can be one year maximum.

� “License key” – 32 characters long key which you will get after registration and requesting license for monitoring.

• After filling all fields click on confirmation button to validate entered information and license key. A CanaryCode cockpit will start after successful validation. If validation will be unsuccessful, please double-check all fields value if are correctly written. Be sure that no unwanted space or digit mismatch is there. If all fields are filed correctly based on your license key request on web site or which you obtain with license key and validation still failed then please contact CanaryCode support via email [email protected] .

A button “Get license key” button will redirect you on CanaryCode web page http://canarycode.com/en/community-edition/ from where you can directly request for license key. Button “Copy to clipboard” serves for copying all license screen fields to clipboard of your computer. Then you can past it to like text to email or some document.

User can close opened window. The system displays i t each

time you fail to enter the proper license key.

© 2017 Datavard // 19

Figure 4: Filled license in dialog window

License Check

License to use CanaryCodeTM can be provided for a certain period of time or indefinitely

(until 31.12.9999) and for maximum 999 of monitored systems. Every license is bound to a

system ID where central monitor is run, so for every central instance you will need to

obtain a separate license. License is checked before each run of central monitor and

before adding new satellite system to the monitored system pool. If license is not installed

or if it is wrong (key is not valid or date is expired or maximum number of system is

reached), then the system displays a popup window for entering new license. Existing

running monitoring is stopped for time when license is not valid.

© 2017 Datavard // 20

User Manual

This manual provides information on how to use the CanaryCodeTM Monitor:

• How to add a new system to the pool of monitored systems • Creating configurations • Running and maintaining the monitoring of these systems

The CanaryCodeTM manual consists of three key parts:

1. CanaryCode TM monitoring – describes how the monitoring works from collecting KPI to processing and notifying

2. CanaryCode TM Monitor tool – main user interface for configuring, processing and displaying information. This part describes the GUI layout and explains Collector jobs, KPIs, charts, messages and events.

3. CanaryCode TM setup and customizing – explains how to add a new system, start monitoring Collector job and configure the monitoring profile, collectors, KPIs, messages, events and notifications.

© 2017 Datavard // 21

CanaryCode TM monitoring

CanaryCodeTM monitoring is based on a centralized location where information is collected

from remotely monitored systems called satellites. The information collected is known as

KPIs.

Figure 5: CanaryCodeTM monitoring model

The monitoring of remote systems and self-monitoring is started on monitoring system

known as the Central monitor . For each monitored system, Monitoring Collector jobs

are defined and each Collector job is periodically scheduled. During the Collector jobs,

runtime Collectors are called on monitored system. These Collectors are sending back

required information known as KPIs as well as additional detailed information for analyses.

All information is stored in the database in the central system. After the initial analyses for

benchmarking, a Collector job will then be able to notify about critical status and values

measured on monitored system. All collected information is represented in real-time from

Monitor User Interface (UI) from which all processes are controlled and the setup can be

changed via customizing.

Collector job

The Collector job represents a monitoring process for specific system with a specific setup.

The Setup of Collector jobs is described in their profiles. The Collector job can be

scheduled and run in different time period.

For each Collector job, only one-background job is there in the central system and the

statuses of the monitored system(s) and their servers are controlled within the background

© 2017 Datavard // 22

job. The system then collects and stores the necessary information for analyses to be

carried out centrally and to notify about critical status/values.

Profile

A profile is a simple set of customizing data, which determines which KPIs have to be

collected and in which way. For example, the “DB profile” is defined for monitoring of

database-specific KPIs or the “BW profile” can be configured for monitoring only KPIs

relevant for BW system performance.

CanaryCodeTM administrators can customize the creation of profiles and allows the

defining of customer specific monitoring with KPIs on which the monitoring should be

focused.

Standard profiles are delivered with CC installation and are ready for use.

KPI

KPIs, short for Key Performance Indicators, are the base unit information that the

CanaryCodeTM Monitor works with.

From an abstract level it can be any kind of measurable information, for example, CPU

utilization or CPU load, memory size, number of network packets, short dumps, active

users, speed of conversion, or time of DSO activation in NetWeaver BW.

A KPI is calculated in a satellite system or in the central monitor system by Collectors,

which are described in the next section.

Collectors

Collectors are responsible for the collection of data for KPIs.

Technically, a Collector is a specific implementation of logic designed for gathering data,

and this uses the same standardized communication interface like all other implemented

collectors.

Within each collector, the process of getting and measuring data for one or more KPIs is

implemented.

© 2017 Datavard // 23

As an additional functionality, collectors can receive certain parameters or inputs and send

detailed and structured information back.

© 2017 Datavard // 24

CanaryCodeTM

setup

This chapter describes the CanaryCodeTM setup and maintenance. When setting up

CanaryCodeTM to monitor the system landscape, start by adding the systems to the

monitoring pool and the setup of which KPIs are to be collected and what events are to be

alerted. These configurations will be saved in profiles, once the profiles have been

created, they can be assigned to each system and monitoring can be started. The first run

of the CanaryCodeTM Monitor will be with an empty monitored systems pool.

Figure 6: First start of the CanaryCodeTM Monitor

Add a new system

To add your systems into the Monitor, follow these steps:

1. In main, click on the Add new system for monitoring button or press (Shift + F1) . A popup for adding a new system will appear.

2. In the Destination field, type the name of the RFC destination. For creating a new RFC destination, click on the Maintain RFC button and the system opens Display and maintain RFC destinations transaction for this purpose.

For monitoring the central system in which the Monitor is

installed, type NONE in the RFC destination field.

© 2017 Datavard // 25

3. After typing in the RFC destination field, click on the Check RFC button. The system checks the connection to the remote system. If the connection is present, the system displays additional information about the remote system in the fields below. If there are connection problems or if the remote system does not have the CanaryCodeTM collectors package installed, the system displays an error message.

Figure 7: Adding a new system

4. If the connection is correct, then choose a System type. 5. In the Maximum time for RFC PING in seconds field, the user can set up a

maximum time for RFC PING. If the remote system does not respond after the maximum time that is set, then it is highlighted that the system is not accessible with a red light icon in monitoring pool.

Recommended value for RFC PING is at least 10 seconds also in

the case of fast connection.

The system automatically detects the system types available for

monitoring and displays it at the bottom.

6. Check whether all the information is correct. Finally, click on the green button Add system or press F8 function key. The new system will be added to the monitored systems pool.

© 2017 Datavard // 26

Figure 8: New system in the monitored systems pool

Once the system is added, you have to start the monitoring. You can start this by clicking

on the ‘Start default monitoring’.

Delete system from monitoring pool

Will remove monitored system from monitoring pool as well as all its Collector jobs and will

delete all collected data including saved intervals. Before deletion, you should stop the

Collector jobs linked to the monitored system.

Figure 9: Removing a monitored system from monitoring pool

Figure 10: Warning if Collector jobs are not stopped before deletion

© 2017 Datavard // 27

Figure 11: User confirmation before final removal

Create a Collector job (for monitoring)

For the monitoring of a remote system, it is necessary to run a Collector job for monitoring.

This Collector job is scheduled and periodically run as a background job. To create a

Collector job, do the following steps:

• In the main menu, click on the Create new Collector job button or press the function key F9.

The system displays a popup window known as Collector Job Manager. This will have two

sections namely Monitoring plan (for creating/ editing Collector jobs) and running Collector

jobs (providing an overview of already created/running Collector jobs).

Figure 12: Collector job Manager

To create a new Collector job, the user should define the following:

• Definition: Here the user provides the System ID to be monitored and assigns a KPI profile.

© 2017 Datavard // 28

• Execution: the user may choose to run the Collector job immediately after the Collector job is (re) started or choose a time and date indicating when to begin.

• Period: The User defines the time interval between runs of the Collector job. • Retention time: determines how long the Collector job will store collected monitoring

data. With older data, retention time is then automatically deleted with exception data that is collected during saved time intervals.

When the Collector job has been created/ edited, the user should click the (Re) Start

Collector job button. A notification will appear in the bottom right-hand corner.

Figure 13: Successfully started monitoring Collector job

Reporting of KPI chart

It is possible to generate an offline report of KPI charts. The report generator is accessible

from main menu or press Ctrl + F5 .

Figure 14: Accessing Report Generator

In the report generator, you can define the range of KPI’s and Systems that you want to

view in the report. The report is generated into HTML and this can be saved in frontend

PC, in application server or can be sent via email. The report generator can be scheduled

as background job to be run on regular basis and for providing a report status for occurred

events.

© 2017 Datavard // 29

Figure 15: Setting up scope of Report and Exporting options

Figure 16: Report Export Log

© 2017 Datavard // 30

System settings maintenance

When you click on the System settings button in the main

menu or press Shift + F5 , the system displays the systems definition maintenance screen.

In System maintenance category, you can change only RFC destination and response

time.

System maintenance:

Figure 17: System maintenance

Correct setup of response time is important in cases where there is a slow connection

between systems. If response time is exceeded, then system is marked as offline or

inaccessible.

Figure 18: Setup of response time

© 2017 Datavard // 31

Server list category is for displaying list of servers for selected system. Here, it is possible

to specify which server(s) are to be monitored.

Figure 19: Server list

System groups:

Allows you to group Systems, based on common attributes such as, production,

development systems, geographic location etc. Note that one system can be placed in

multiple groups.

If a system is allocated to multiple groups, when you check or uncheck the system in one

group, then this will also be reflected in the other groups to which the system is allocated.

Figure 20: System groups

In system group list category, it is possible to specify which system(s) will belong to group.

© 2017 Datavard // 32

Figure 21: System group list

Figure 22: Example of graphical distribution of groups in system tree

Configuration parameters:

Here, it is possible to customize the behaviour for some predefined properties:

Max. runtime for execution of collecting BG jobs in seconds

Determine maximum runtime for collector BG job execution. If BG job runtime reach

this limit then it is aborted. Each such Default value is 600 seconds (10 minutes).

Allow use KILL WP for long-running collecting BG jobs

Allow to use low level function KILL Work-Process to terminate collecting BG job

which cannot be aborted with standard functionality. Works only if previous configuration

parameter "Max. runtime for BG job agent..." is not initial. Set this parameter to 'X' to turn it

on. Default value is initial.

Max. limit for BG work-processes consumption in same time

Specify a limit as to how many background work-processes can be used for

collecting BG jobs in same time. Set number less then maximum of BG work-processes

defined on central system. Default value is initial which means no limit for BG WP.

Priority class for execution of collecting BG jobs

Set BG job priority class for execution of collecting BG jobs. Three priority classes

are allowed: 'C'-lowest priority, 'B'-medium priority, 'A'-highest priority. BG jobs with highest

© 2017 Datavard // 33

priority class are executed firstly if exist more BG jobs waiting for free BG work process.

Default value is 'C' or initial (has same meaning).

Server group for executing collecting BG jobs

Specify a name of server group for executing of collecting BG jobs. Server group

can be created in SAP transaction SM61 and determines specific list of application servers

where BG job can only run. Default value is initial (no specific server group is used).

WARNING: If server group name is set incorrectly (not exist in SM61) then

execution of collecting jobs will fail.

User ID used for execution of collecting BG jobs

Set user ID which will be used for executing of collecting jobs. Each execution of

collecting jobs and all actions of monitoring on central system are performed under this

user ID. If no user ID is defined (default value) then logon user who triggers execution of

collecting BG job will be used.

It is recommended to create such user of system type on central monitoring system

and setup it with limited authorizations defined in role /DVD/MON_ADMIN.

External storage ID in Datavard Storage Management

This setup allows to store monitoring results in different (external) transparent

storage via Datavard Storage Management [DVD SM]. Storage ID has to be defined in

DVD SM via transaction /DVD/SM_SETUP. Monitoring results stored on external storage

are protected against retention deletion. Only transparent storages are supported. For

more information about DVD SM contact Datavard's consultant. Default value is initial (no

external storage for monitoring results).

Maximum allowed percentage of used ARFC resources

CanaryCode checks system and server availability via asynchronous

processes [ARFC] as safety way against communication hanging issue. Each system has

limited number of dialog work processes (75% is system default value, check transaction

SARFC) to be used for ARFC. This setup determine maximum limit from those ARFC

resources which can be used by CanaryCode availability checks. If CanaryCode requests

ARFC resource which is out of setup limit then it waits when ARFC resources are available

again. Wait time is setup in next configuration parameter. If wait time is exceeded then

availability check is not performed and error message is written to log. This setting should

be applied only in case that CanaryCode central instance runs on system with limited

resources or system which uses ARFC by other transactions. Default value is initial.

Max. waiting time to check available ARFC resources

© 2017 Datavard // 34

Define waiting time in seconds to check if ARFC resources are available for

CanaryCode availability check. Parameter works only with previous configuration

parameter. Default value is initial (no waiting time, availability check and collecting job are

canceled when no ARFC resources are available, error message is written to log).

E-mail address used for sender of notification

Email address which will be used as sender in notification emails. Default value is

canarycode@do_not_reply.com (same email address is used in a case if initial value).

WARNING: Wrong address (against email address RFC standards) can lead to

dysfunctional of notification mechanism and no emails will be sent.

Display popup for user in different time zone.

Use a pop up for making user aware that there are differences between time zones

of system and user (default 'X' value). If parameter is initial then popup will not be

displayed. If parameter is set to 'Y' then popup is displayed and access to the

CanaryCodeTM monitoring cockpit is terminated.

Figure 23: Configuration setup

For each value of property, there is possibility to set up restriction for system and profile.

© 2017 Datavard // 35

Figure 24: Property configuration

Restriction in monitoring:

This enables the user to turn off the monitoring during a specific time interval, i.e. because

of system maintenance. Restriction is possible to set up for specific system, server or

profile.

Figure 25: Restriction in Monitoring Overview

When creating a new entry, the user should specify the following:

• The Restriction Name: Describes the reason for switching off monitoring. • Restriction rule is valid from: Here, the user can specify the time validity of the rule

(i.e. the date range in which this rule is valid for) • Time of occurrence: The user should specify the exact time in which this rule should

be enforced, and has the option to choose a repetition of this rule. • Apply restriction only on (combination allowed): Here, the user can specify the

System ID, Server name and monitoring profile. The user can utilize a combination of all of these. If all fields are empty by default, monitor for all systems will then be stopped during the specified restriction time.

© 2017 Datavard // 36

Figure 26: Restriction in Monitoring Input Screen

Time intervals:

The user may save time intervals in the CanaryCodeTM Monitor in order to maintain a

historical reference of issues that may have happened in the system landscape. If there

were any time intervals saved, then they would be displayed in this section. See Time

intervals in the CanaryCodeTM monitor for more information.

Figure 27: Time intervals

© 2017 Datavard // 37

Figure 28: Time intervals in monitoring main screen

Message groups:

In Message groups, the user can adjust or create categories of messages and with these

groups; the message list is adjusted or created. The user can view the messages

generated by CanaryCode’s monitoring activities and in the message tab.

Figure 29: Messages groups

Figure 30: Messages list

Message notification:

The user can create notifications to be sent to users/distribution lists whenever a

notification occurs.

© 2017 Datavard // 38

Figure 31: Message notification

User List

Here you can define what the user can view in the CanaryCodeTM monitor. It is possible to

define for each user, a filter on the level, system, the list of profiles that are accessible and

the KPIs that they can see.

Figure 32: User List settings

© 2017 Datavard // 39

Figure 33: Setting up User Filter for System ID’s

Figure 34: Setting up User Filter for KPI groups

© 2017 Datavard // 40

Figure 35: Customized view in CanaryCodeTM Monitor

Monitoring settings maintenance

When you click on Monitoring settings button in the main menu or

press Shift + F2 , the system displays the monitoring settings maintenance screen.

Figure 36: Monitoring settings

KPI Collectors:

Here the user can view the central list of collectors used. These are the collectors used by

CanaryCodeTM to monitor the central and remote systems. List of collectors that are

remote or on the system that can be called. Collectors delivered with CanaryCode, start

with the /DVD/MON prefix and are preconfigured. These could be adjusted by the user, by

adjusting KPI’s, parameters etc. Users can create their own collectors under the Z* Y*

namespace and it is mandatory to register each collector here before being used.

© 2017 Datavard // 41

Figure 37: Collectors maintenance

Collector’s KPI:

It is where the list of the KPIs associated to the selected collector, can be adjusted or new

ones created. The user may adjust or set up the additional parameters for these KPIs to

suit requirements. For more information, see Appendix 1: KPI Definitions.

Figure 38: Collector’s KPI

Collector’s setup:

Here, the user can change or define new behaviours of the collectors:

The user can determine the Destination of the collector whether it will be run on the central

or remote instance, to suit system differences, as not all behaviours may be required, or

the user can collate information and post processing, i.e. post processing of remote

systems in the central system.

Figure 39: Collector’s setup

© 2017 Datavard // 42

Other behaviours could be required in certain instances wherein Collectors are monitoring

systems on a regular basis, for example, every 5 minutes. In such instances, execute it in

a separate dialog and set a time limit in order to avoid an overlap of data collected.

This setup is not necessary in standard cases.

Collector’s parameters:

Some collectors are created to measure durations taken when a system or server are

performing certain operations, this is where the user could use the parameters to set/

adjust benchmarks for the KPI’s. In this case, values are deleted and the default values

provided with the collectors will be used. For more information, see Appendix 1: KPI

Definitions.

Figure 40: Collector’s parameters

Collector’s inputs:

These are customizing tables, which contains reference information for the collector, in

relation to the type of KPI’s that are needed to be collected. The user can customize

these tables to watch out for specific requirements.

Figure 41: Collector’s inputs

The user can change these inputs by pressing the edit button.

© 2017 Datavard // 43

Figure 42: Collector inputs edit

KPI Definitions:

A KPI is registered by creating the definition, setting parameters for this KPI and assigning

it to a collector, which will collect the KPI.

Figure 43: KPI Definitions

KPI Definitions include the following parameters:

© 2017 Datavard // 44

Figure 44: Maintenance KPI definition

• Definition o KPI name: unique name of a KPI o KPI description: description that will be used in charts and other outputs as

the KPI label • Properties

o Unit: % MB, KB dependent on KPI. For more information, refer to Appendix 1: KPI Definitions.

o Num. of decimals: how the value is displayed in the charts – KPIs are stored as integer numbers and not as real numbers

o Monitoring area: determines system type specific to KPI. The KPI will be collected only for a specific system type like ERP, BW, CRM, SRM and others

• Collection o KPI collector: determines which collector will collect the KPI o Collected on: states where the KPI will be collected or calculated. Possible

values are Remote system and Central system o Collected for: determines KPI orientation. Values are either system or server o Server specification: information can be collected on any server, only

application server, only database server, only external server • Calculate KPI from another KPI(s)

o See Automatic calculation for more info • Chart settings

o Lower/Upper limit mode: � Limit is calculated from minimum/maximum values � Limit is fixed value

© 2017 Datavard // 45

� Limit is calculated from fixed and minimum/maximum values o Lower/Upper limit value: value for displaying KPI series in charts o Chart line type: simple line, spline, discrete o Logarithmic Y scale: Y axis labels are values of common logarithm (decimal) o Don’t display KPI in charts: KPI won’t be displayed

Figure 45: Long description

Automatic calculation

In this block, it is possible to define the method in which the KPI will be calculated without

any coding. With customizing, the user can define a new KPI (e.g. new percentage value),

which will be calculated from already calculated KPIs defined in source fields. The

calculation is setup in “Calculation function” field and source KPIs are defined in three

fields below:

• “KPI source for calculation” • “2nd KPI source for calculation “ • ”3rd KPI source for calculation”.

© 2017 Datavard // 46

Figure 46: Automatic calculation

Usage of these fields depends on the chosen calculation function. It is possible to use

following calculation functions by default:

• Minimum from all servers – new system KPI will be calculated as minimum from KPI’s values of all servers defined by KPI name in first source field and are collected in current run.

• Maximum from all servers – new system KPI will be calculated as maximum from KPI’s values of all servers defined by KPI name in first source field and are collected in current run.

• Averages from all servers - new system KPI will be calculated as average from KPI’s values of all servers defined by KPI name in first source field and are collected in current run.

Figure 47: Example for average calculation for KPI DISK_RESPONS_SYS - Average disk response time (all servers)

• Sum from all servers - new system KPI will be calculated as sum of KPI’s values of all servers defined by KPI name in first source field and are collected in current run.

• Minimum from collected KPIs - new system/server KPI will be calculated as minimum from KPI’s values of all system/server defined by KPI name in first source field and are collected in current and previous runs.

• Maximum from collected KPIs - new system/server KPI will be calculated as maximum from KPI’s values of all system/server defined by KPI name in first source field and are collected in current and previous runs.

• Average from collected KPIs - new system/server KPI will be calculated as average from KPI’s values of all system/server defined by KPI name in first source field and are collected in current and previous runs.

• Percentage from all servers - new server KPI will be calculated as percentage from KPI’s values of all servers defined by KPI name in first source field and are

© 2017 Datavard // 47

collected in current run. Percentage is calculated from KPI’s value in server as base of sum of KPI’s values of all servers.

• Percentage of one KPI from other KPI - new system/server KPI will be calculated as percentage from KPI’s value of server/system defined by KPI name in first source field in current run and in base of KPI’s value of server/system defined by KPI name in second source field and which are collected in current run.

Figure 48: Example for percentage calculation for KPI ENQ_ENTR_P - Usage of SAP lock table

• Delta between last and current KPI value - new system/server KPI will be calculated as delta between KPI’s value of server/system, defined by KPI name in first source field and collected in current run and previous run.

• Absolute delta between last and current KPI value - new system/server KPI will be calculated as absolute value of delta between KPI’s value of server/system defined by KPI name in first source field and collected in current run and previous run. Result KPI’s value is always positive.

• Speed of increasing of KPI value from last run in m inutes - new system/server KPI will be calculated as delta between server/system KPI’s value of server/system defined by KPI name in first source field and collected in current run and previous run. Result value will be divided by time between both runs.

• Calculate difference between two KPIs - new system/server KPI will be calculated as difference between KPI’s value of server/system and defined by KPI name in first source field and server/system KPI’s value defined by KPI name in second source field.

The user can use the third field to facilitate the calculation of more complex KPI.

Allows the users to avoid coding and to create simple calculations of KPI by only

customizing/defining – how to interpret/compare values and for these to be displayed in

graphical format.

Next two subcategories namely KPI in profiles and Event for KPI in profile have same

meaning as they do in the previous section; for more information, refer to Profile definitions

maintenance.

© 2017 Datavard // 48

Figure 49: KPI Groups

KPI Groups category with KPI Group list subcategory defines only the categorizing and

displaying of KPI’s charts on KPI tab.

As of CanaryCodeTM 1.61, it is possible to customize the views so that you can adjust

which KPI groups are visible for you in the CanaryCodeTM Monitor; this can be done in the

“Filter for KPI” group as well as in the “Filter for Profile”.

Figure 50: Filter for KPI group

Detail tables:

This section displays the table names where the data from the collectors is collated/

stored. It is visible in the details tab of the CanaryCodeTM monitor. For more information,

refer the detail tab of the documentation.

© 2017 Datavard // 49

Figure 51: Detail tables

Profiles definition:

The user may create new profiles or maintain existing profiles. These profiles are required

before starting the monitoring of Collector jobs.

Figure 52: Profile definition

By selecting a profile, the user may customize KPIs, Alerts, Collector’s parameters and

Collector’s setups associated with the profile. Using these profiles, you can define the KPIs

which will be collected in the monitored system. Only existing KPIs can be associated with

specific profiles.

© 2017 Datavard // 50

Figure 53: Association of KPIs to profile

If you want to monitor a certain KPI for a specific profile, you can also set alerts. Only

created and KPI-specific alerts can be set up in this method.

Figure 54: Alerts created for profile-dependent KPI

In this subcategory, you can define a profile to determine which alert will be monitored with

specific setup for a specific KPI. For detailed information about alerts, refer the next

section Alert definition.

© 2017 Datavard // 51

Alert definition:

Figure 55: Alert definition

Here you can create new alert definition.

Figure 56: Created alert

This definition consists of:

• Alert type – describes the type of alert and determines the icon to be displayed if the alert occurs. Possible values are:

o Success – o Warning – o Issues – o Error -

• Period time – the frequency that specifies how often the alert is rechecked. • Alert description – this description will be used as the label in outputs.

© 2017 Datavard // 52

For every alert created, it is necessary to define associations to the KPI and to the Profile.

This can be done in the Alert association category of this screen. The following fields

should be filled:

• Monitoring profile – alert will be checked only for this profile under running Collector job.

• KPI name – alert will be checked only for the value of this KPI. • Comparison operator – determines in which case a KPI value causes an alert to

occur.

�

Figure 57: Comparison operator

• Threshold – determines the limit value for a KPI. This alert will occur if the KPI exceeds its defined threshold of associated alert.

• Unit – determines the unit of measurement to be used, i.e. %, MB etc. • Duration start – how long can a KPI value exceed the threshold (in grey area)

before an alert will occur (starting delay for alert). • Duration end – how long a KPI value has to be outside of the threshold area (in

grey area) before an alert will be stopped (ending delay for alert).

Figure 58: Event association

Each alert occurrence can be notified by email or by message in SAP Business

Workplace. That can be done in the Alert notification category of this screen. The

following fields should be filled:

• Monitoring profile. • Recipient address – the email address or username from SAP system can be

specified. • Type of notification – determines the notification method. Possible values are:

© 2017 Datavard // 53

o E-mail – notification will be sent to the email specified in “Recipient address” field.

o SAP Office message – notification will be sent to the SAP Business Workplace for user who is specified in “Recipient address” field.

o Private distribution list – notification will be sent to all addresses defined in SAP Private Distribution List (transaction SO15 or button "Distribution list" in CanaryCodeTM toolbar).

o Shared distribution list – notification will be sent to all addresses defined in SAP Private Distribution List (transaction SO15 or button "Distribution list" in CanaryCodeTM toolbar).

• BAdI ID – [optional] ID, which will be used for filtering of BAdI call. You can create your own BAdI for notification using BAdI implementation /DVD/MON_BADI_DEF_EVENT. Each BAdI implementation has to define the filter, which is also used for determining explicit call of the BAdI for processing of notification. Default BAdI implementation used for notification has initial BAdI ID.

• Alert notification – determines the period for sending of notifications. Possible values are:

o At first occurrence – notify when alert occurs first time o At next occurrence – notify each occurrence of alert o At end of alert – notify when alert is completed

Figure 59: Alert notification

User settings

Users could set up their own GUI of CanaryCodeTM Monitor by clicking on the

“User settings” button in the main menu. The system displays a pop

up window with two tabs:

© 2017 Datavard // 54

• “General” tab contain basic settings. • “Charts” tab contain settings related to customizing of charts.

Figure 60: General settings

General settings:

Ping system on refresh – The user may check this option and by doing so, on each

refresh of the Monitor, the connection to each monitored system in the system pool will be

tested. Checking of this option may slow down the response of GUI because all

connections will be tested; however, the system displays real time information about

statuses of the monitored systems.

Ping application server on refresh – similar to ‘ping system on refresh’ but it is carried

out on application server level; wherein on each refresh of the Monitor, the system will test

the connection to each application server in system pool. Checking of this option may slow

down the response of GUI because all connections will be tested; however, the system

displays real time information about statuses of the monitored application servers.

Set last time interval on startup – if you check this option, then on each run of Monitor,

the time interval from last run will be set.

© 2017 Datavard // 55

Do not use user’s local time zone – If this field is checked, then the user will view all

time fields in the monitor in the system time zone of the central monitoring instance.

Hide unused KPI from KPI groups/ KPI Groups – If these are checked, then all unused

KPIs/KPI groups will be hidden from the KPI Group tree view on the bottom left of the

monitor.

Hide non-monitored servers from pool tree – If this is checked, then all servers which

are marked as “Don’t monitor” will be hidden in the system pool tree view on the top left of

the monitor.

Search Tool bar for System Pool tree and KPI pool t ree

A new search bar has been introduced for System pool tree and KPI groups. This is

switched off by default; however, you can turn this on via the user settings. The Search bar

enables you to navigate to a node of the tree by entering the description/name, for

example, in the KPI “CPU” and this will display all KPIs that have CPU within the name.

Figure 61: Quick search for SIDs, SERVERs, KPIs

© 2017 Datavard // 56

Chart settings:

Figure 62: Chart settings

Use java script jqCharts – by checking this option, you will enable new powerful charts,

which are implemented via Java Scripts. Using new charts allow more interaction and

faster display of huge amount of data in charts. In addition, the charts are clearer and the

User can view detailed descriptions of KPIs.

Figure 63: JavaScript Charts

© 2017 Datavard // 57

You can use the new JavaScript charts only if you h ave installed Internet Explorer 9 on front end PC!

Stretch series – if you check this option, then all displayed charts will be stretched to

measured time intervals. This option is possible to use only with new Java Scripts charts.

Display legend in charts – if you check this option, then in all charts there will be

displayed legend. This option is possible to use only with new Java Scripts charts.

After changing of settings, the user should click on “Save setting (F8)” save button and

all changes will be immediately reflected. If the user closes the CanaryCodeTM Monitor,

then all settings with composition of layout, checked systems and selected KPIs will be

automatically saved for that particular user and it will be restored in next run of

CanaryCodeTM Monitor.

If saved settings are no longer suitable, then click on ”Reset to default settings (F2)”

button.

© 2017 Datavard // 58

CanaryCode TM Monitor

The CanaryCodeTM Monitor is the central cockpit of CanaryCodeTM for displaying all

information stored on the central server and collected from satellite systems, which notifies

occurred events by messages during monitoring.

In addition, the CanaryCodeTM Monitor is the control center for all operations on monitored

systems, such as collecting KPI and event behaviour.

To run the Monitor, use the transaction:

• /DVD/MON

GUI description

The main GUI layout is divided into four basic parts.

The menu bar is on the top of the screen with function buttons.

On the left side are two tree lists:

1. With the systems that are monitored. 2. KPI groups where all the KPIs are collected.

On the upper right side is a block for time selection, which defines the time interval for

displaying collected information and where the user can save specific time intervals.

The rest of the right part layout is a tab-list that is composed of the system information tab,

Collector jobs, KPI charts, the KPI mixer, the messages tab, the details tab and the events

tab. All these parts and tabs are described in the next sections of this manual.

© 2017 Datavard // 59

Figure 64: Main GUI layout

Menu buttons

The main menu of the Monitor has action buttons with a basic functionality.

Figure 65: Main menu buttons

These buttons are:

Refresh monitor (F5) – update information in the tree-list of systems, their servers and

in all tabs.

Add a new system for monitoring (Shift + F1) – displays a popup window for

adding a new system through the defined RFC R/3 connection. The process of adding a

new system for monitoring is described in the separate section “Add a new system”.

© 2017 Datavard // 60

Figure 66

Create new Collector job (F9) – with this button, you can create, assign a

profile and start Collector job for the monitoring of system. The process of starting the

monitoring is described in a separate section called “Start monitoring”.

Figure 67

Start report generator transaction (Ctrl + F5) - opens new transaction for

generating summary report from monitoring base on some selections of KPIs, areas

(system ID, server names, profiles), snapshot interval. Generator works with predefined

template and allows to use own template as well (created in W3 repository - transaction

SMW0). Generated HTML output is possible to compress as ZIP file and store it in

application server, frontend PC or to send it via e-mail.

Maintain RFC destinations (F6) - Run the transaction SM59 for maintaining

RFC destinations in the system.

Job view (Shift + F7) – Run the transaction SM27 for displaying background

jobs.

Distribution list (Shift + F8) – Run the transaction SO23 for maintaining list of

user emails, SAP user names, private distribution list and shared distribution list for

notification of events and messages.

Figure 68

© 2017 Datavard // 61

System settings (Shift + F5) – maintenance of parameters for monitored

systems, time intervals, groups of messages used in the messages tab, messages

notifications. The maintenance is described in the separate section “System definitions

maintenance”.

Monitoring settings (Shift + F2) - covers all these cases:

• KPI Definitions - maintenance of collectors and their setups, parameters and inputs. Continue with maintenance of KPI definitions, their association to the collector, to profiles, to events and to groups. In addition, KPI groups maintenance is here, which are used for displaying of KPI groups tree in the main GUI.

• KPI collectors and detail tables list • Profile definition - maintenance of profiles and association of KPIs, events,

collector’s parameters, collector’s setups, and collector’s inputs to the profile. • Event definition - maintenance of events and setup of their association to the KPI

and notification for these events.

The maintenance is described in the separate section “Monitoring settings maintenance”.

In User settings, you can adjust the settings for the monitor behaviour and

graph display on user’s level.

System tree

In the system tree, a list of systems and their servers are displayed.

Node in this tree represents a system with a system ID and lists below this node (system)

represent its servers with a server name.

For each system, there is additional information in three columns. The “Type” column

informs about system type. The event column notifies event occurrence by displaying

appropriate icon (meaning of icons is explained in later sections) and the “Last update”

column informs when a system was monitored the last time.

© 2017 Datavard // 62

Figure 69: Tree list of monitored systems without system groups

The systems could be divided into system groups (folders) wherein one system can be

placed in multiple groups.

Figure 70: Tree list of monitored systems with system groups

Each node of type system or server can be selected and checked. For the selected node,

(only one can be selected at a time), the relevant information is always displayed in the

first tab “System info”.

© 2017 Datavard // 63

For all checked nodes, all information is displayed for the appropriate/selected KPIs,

messages, events and detailed information in the other tabs.

If the node of this tree is greyed out, then this means that it is inactive. This status means

that for this system and server and for the selected time interval, no information is

collected. Inactive node can be selected but not checked.

Each node of system and the server has an information status icon, which informs about

the current state of monitoring.

This icon may have these statuses:

• - At least One Collector job is executed for the system, which indicates that a background job for this Collector job is currently running for collection of KPIs.

• - At least One Collector job is due to be executed on the system, so the background job for this Collector job is released and once a free process is available, it will be executed.

• - At least One Collector job failed in last run on the system, so the background job of this Collector job has been aborted or cancelled.

• - System is monitored by at least one scheduled Collector job and previous execution of Collector job was carried out successfully for this system.

• - System is not reachable through the RFC connection, this could because, for example, the system is down or RFC connection is not valid anymore.

• - System is not monitored because no monitoring of Collector job is started.

• - The server of monitored system is excluded from monitoring; therefore, the accessibility of this server is not checked.

• - The system/server is not monitored due to an existing restriction in monitoring which is setup for specific time range, system, server and profile.

© 2017 Datavard // 64

Groups in System Pool

It is now possible to organize your systems into groups and sub-groups, based on your

preferences.

Right clicking on a group enables you to select or de-select all systems associated with the

particular group or select only those systems on which some alerts occur.

Figure 71: Context menu for system pool tree (select all, deselect all, Select all in alert)

KPI tree

In the KPI tree, the list of KPIs is divided into logical groups and there are sub-groups in

each group. The user may make a specific KPI available in one or more groups and this

association can be done in the KPI group maintenance. The maintenance is described in a

separate section in this document called “KPI definitions maintenance”.

© 2017 Datavard // 65

The main group is called ‘All KPI’. This group contains all base groups and all KPIs, which

are not associated to any Groups.

Figure 72: KPI tree (without / with checkboxes)

Nodes in KPI tree have either an active or an inactive status. An inactive KPI node means

that KPI values were not measured in selected time interval for checked systems and

servers. Inactive KPI group node means that all KPIs are inactive in this group and their

sub-groups.

An active node of a KPI can be displayed as a checkbox, when KPI mixer is used. Only

checked KPIs are processed to this KPI mixer. More details about this functionality are

described in separate section “KPI mix tab”.

Time interval

In this section of the screen, the user can set a time interval, which should change the time

intervals, which will be used in the information that will display in the tabs. The user can

change the ‘From’ – ‘To’ dates and choose from several options available with the

button which changes the time intervals automatically.

After typing, an appropriate date and time, press enter and the system refreshes all data

from the current time.

© 2017 Datavard // 66

Figure 73: Time interval definition

When auto refresh is switched on, then the charts will refresh in the specified time interval.

The user can save predefined intervals to a list box on the right side by clicking on the

save button and providing a description. Description is automatically filled by first system

which is marked in system tree and time interval from – to.

Figure 74: Saving of selected time interval

User can choose another option with radio button on All checked systems in system pool

tree. In this case is description also automatically filled and it is necessary to do not

change description between <>, because there will be system ID.

Figure 75: Saving of all checked systems in system pool tree

If the user wants to load a saved interval, the interval will be available from a list box. For

deleting, select the interval and click on the delete button.

© 2017 Datavard // 67

Figure 76: Choosing the saved time interval

Not all collected information exceeding the retenti on time is

deleted if it was measured in a saved interval.

System info tab

In this tab, the user should find the information about all monitored systems:

• The basic information is in the “System data”.

• The hardware configuration of hosted machine is in the “Host data”.

• About the database in the “Database data”.

• The connection to the monitored system in the “Monitor data”.

Figure 77: Detailed system information with list of servers

At the bottom of this tab, there is a list of servers. This list provides an overview of servers,

their names, if it is an application server or a database server, whether there is a host

name given, the number of the CPU(s), RAM size, as well as locality and description. In

the column ‘Don’t mon.’, if there is a flag, then the server is excluded from monitoring.

© 2017 Datavard // 68

Collector jobs tab

The Collector jobs tab displays all created Collector jobs for monitored systems and

provides information regarding their statuses. From this tab, Collector job runs can be

controlled and monitored.

In the list of Collector jobs, following information is displayed:

• SID – determine system ID for which Collector job has been created. • Profile – which customizing is in use for the Collector job, i.e. what KPIs is being

checked? • Job status – informs about status of background job of Collector job. Background

job can have these statuses: o Not running – No scheduled job. o Scheduled – Job schedule run created for Collector job. o Waiting – Collector job informs that a job is waiting for free work processes

for running. o Running - Collector job is currently running.

• Period value / Period type – informs how often a Collector job is running. • Button – If a Collector job is scheduled, the user can click stop button is

required which stops and cancels the scheduled job. • Button – If Collector job is not running, the user can click the start button to

run the Collector job. • Execution – Determine if Collector job is executed immediately or scheduled on

specific date and time. • Start date/Start time – date and time of initial run of the Collector job. • Retention time – specifies how old collected data will be stored by Collector job.

Data older then retention time are automatically deleted with the exception data, which are collected in saved time intervals.

• Background Job Name/button – name for background job of Collector job. Clicking on this button will execute transaction SE37 with displaying of this job.

• Job last status/Last status icon – specifies about status of last background job run. Can have these statuses:

o Finished - specifies that the last background job of Collector job was successfully finished.

o Aborted - specifies that the last background job of Collector job was terminated by error or cancelled by user

o Not running - specifies that the background job of Collector job was not started before.

• Delay[s] – specifies of any background job delay in seconds while waiting for a free work process.

• Run date/Run time – specifies the date and time in which background job of Collector job is started

• Duration – specifies how long the background job of Collector job was running.

© 2017 Datavard // 69

Figure 78: Collector jobs tab

• Last delay – specifies about last background job delay in seconds when it was waiting for free work process.

• Last run date/Last run time – specifies the date and time when last background job had been started.

• Last duration - specifies how long the background job of Collector job was running. • Remaining time – specifies the time in seconds in which the next run of Collector

job will occur. • Next run date/Next run time – specifies the date and time of next Collector job run. • Create date/Create time – specifies the date and time of creation of background job

for Collector job • Creator name – specifies who started/stopped background job for Collector job.

If the user double clicks on Collector job record in the list, then all information is displayed

in detail in the bottom section of Collector job tab.

In the top bar, the menu of Collector job list is available which contains all standard

buttons for working with ALV list and which allows the user to sort, filter etc. In addition, a

refresh button is available along with information about last time of refresh. This

button gets actual status of all background jobs.

© 2017 Datavard // 70

To modify or delete a Collector job, the user can right-click on the Collector job record and

from the menu that displays, it is possible to delete or modify the selected Collector job by

choosing the required option.

Figure 79: Context menu on selected Collector job

Deletion of Collector job will remove it from the list and will also remove collected data by

this Collector job. Modify Collector job will display Collector job manager for current

Collector job where definition of Collector job can by changed. The process of starting the

monitoring is described in a separate section called “Start monitoring”.

Only Collector job that is not running can be delet ed! Deletion

of Collector job will remove all collected data wit h exception of

data collected in saved time intervals.

KPI tab

All collected KPIs of monitored systems are represented in the form of charts within this

tab. In these charts, you can directly see the behaviour of monitored KPI with respect to

the time.

When the tab is chosen for the first time, then all data about KPI, which is necessary for

displaying of charts, are loaded. Progress of loading takes some time and it is displayed in

the status bar in the bottom left corner of the screen. KPI data are loaded only once for

each KPI chart. This indicates that KPI chart is displayed faster during the second time,

because the system uses the cached data.

Figure 80: Progress of loading data

Each chart describes one measured KPI in a selected ‘time interval’ for systems and/or

servers that have been checked in the ‘system tree’. The chart has the KPI’s description at

the top, X-axis represents a timeline and the Y-axis represents measured values. The unit

of value is displayed after the KPI description at the top in brackets (next to the chart title).

© 2017 Datavard // 71

A legend is displayed by clicking on a grey square on left side in each chart. The legend

describes the coloured series, which represents the checked system(s)/server(s).

Figure 81: KPI charts

The measured KPI can be defined for a system or for a server as follows:

• If only one system/server is checked, then one line will be displayed to represent the KPI.

Figure 82: System’s KPI in a chart

© 2017 Datavard // 72

If KPIs of multiple systems/servers are displayed in one chart, then each individual system

or server will be represented by a separate coloured line. In the legend, you can see which

coloured series is associated with which system or server.

Figure 83: Server’s KPIs in a chart

The number of charts per page can be selected by choosing a predefined layout. Possible

grid layouts are 1x1, 1x2, 2x2, 3x3 and 4x4. The grid between charts is also resizable by

dragging the mouse.

Figure 84: Grid layout choosing

Depending on the number of KPIs, these charts are not only placed on one page but on

several pages. The user can switch between pages using the and buttons found on

the top left corner of the chart displayed in the KPI tab.

The KPIs, which are displayed in the grid layout, is determined by selected KPI group or

specific KPI in KPI tree. Each group consists of KPIs and other subgroups. The correct

page is set automatically.

© 2017 Datavard // 73

Figure 85: Displaying KPI charts in grid layout by selecting KPI in KPI tree

KPI mix tab

By using the KPI mix tab, the user can see the behaviour of more KPIs together, by

graphically comparing dependencies between all measured KPIs, for example, the

dependence between the CPU load and work processes.

When the KPI tab is selected, the user may then check to display an active KPI in KPI tree

(note that a system/server must also be selected in the system tree). Once a KPI is

checked, it will be displayed as a chart of mixed KPIs and assigned to a new coloured

series.

When KPI or system/server is unchecked, the appropriate series will be removed from the

chart. Allowing the user to create and customize a comparison chart based on individual

needs. All KPI series are portioned in the same manner similar to the KPI tab charts

specified by KPI definition.

© 2017 Datavard // 74

Figure 86: Checked KPI in KPI mixer

You can find associations of coloured series to KPIs in the legend at the bottom of the

chart. These colours of series are different from the previous KPI tab.

Messages tab

The message tab displays the status messages created by CanaryCode, for example,

during the collection and processing of KPIs from a monitored system. Each message is

described by a text containing information about when it occurred, on which system or

server and the type of message (in ID column). Three standard types of messages exist:

• - OK / successful messages • - Information / alert messages • - Error messages

The messages displayed are dependent on the systems/servers that are checked in the

system tree.

Towards the top of the Messages tab, there is a list box in which the user can filter the

message group. By default, all messages are displayed and in addition there are the

standard ALV operations such as sorting, filtering, aggregating etc.

© 2017 Datavard // 75

Figure 87: Monitor Messages

Details tab

This tab contains additional information collected from the monitored systems. All this

information of the same kind is categorized and placed into one table. By clicking on a

concrete table, all the information is displayed in an ALV list from the table. With this ALV

list of messages, it is possible to do all standard ALV operations like sorting, filtering,

aggregating and so on.

Figure 88: Detailed information from monitoring

© 2017 Datavard // 76

Events tab

The Events tab displays messages during monitoring and collecting of KPIs, where an

event occurs to one or more specific KPIs’ values. Messages of events wherein the KPI’s

critical values that reach or exceed the threshold limits, which is set by the user. Listed

below are some examples of such events:

• Massive short dumps within a short period of time • System downtime or unavailability • System stops/restarts • A typical peaks or downs in system performance • Start/end of SLO operations (conversions or migrations) • Users working in the system during conversions and many others

Such events will be in a state of occurrence as long as KPI values are outside of the

threshold limit. If events hold for a long time (also customizable), the alerts will keep

informing the user that such events are occurring and allows the user to keep track and

monitor the event’s progress.

The configuration and maintenance of events for KPIs and related purposes are described

in the separate section “Event definitions maintenance”. Below is an example of an event

occurrence in CanaryCode:

Figure 89: Process of event occurrence

During the process of event occurrence (X-axis: Value and Y-axis: Duration), the KPI line

starts below the threshold but then begins to rise and crosses the threshold, this is when

the process of detecting events starts:

KPI

THRESHOLD

TIMELINE

DURATION

START

EVENT DURATION VA

LUE

1 2 3 4 5 7

EVENT

PERIOD EVENT

PERIOD

6 8

ALERT ALERT ALERT

DURATION

STOP

ALERT

GRAY

AREA

© 2017 Datavard // 77

1. When the KPI value reaches and crosses the threshold, the progress turns to “grey”, which indicates that the KPI value still has a chance to return under the threshold for up to a certain timeframe and the Duration has started for CanaryCode.

2. Since the KPI has remained above the threshold for the allocated time, the progress turns to “Red”, an event is started, and an alert is raised.

3. The event continues even if the KPI value falls below the threshold “grey area” because the progress needs to remain below the threshold for a certain period. If the progress stays below the threshold for long enough, then the duration would stop. However, for this example, the progress again rises above the threshold and so the event continues.

4. As the event duration is still continuing and an event period has elapsed, the system raises new alert to inform the user that the event is still occurring.

5. During the elapse of the second event period, another (third) alert could be raised depending on how the user has configured the event. This is because, this time the progress has dropped below the threshold but the progress is grey since the progress has not remained below the threshold for a certain timeframe.

6. Once the line has remained below the threshold for long enough, the progress changes to green and the event duration is finished. The system raises a green alert and informs the user that the event has ended.

Through an event occurrence, the process is recorded and stored within the events tab.

There, you can find an ALV list of occurred events. Each line of the list represents one

event. It has information about the system and the server (if the KPI of the event is server-

specific). There is also an icon that informs about event statuses as follows:

o - Success event o - Warning event o - Issues event o - Error event

In the next column, there is a count of occurred event alerts. There is always the number

one if an event occurs for the first time. The next columns indicate when an event has

started and when it has ended (if it has ended). The last column is an event’s description.

Figure 90: Occurred events

With this ALV list of messages, it is possible to do all standard ALV operations like sorting,

filtering, aggregating and so on.

For more detailed view on event, just double click on the line in ALV and detailed output

will be displayed.

© 2017 Datavard // 78

Figure 91: Detail output

© 2017 Datavard // 79

Benchmarking

The benchmark originates from our Fitness test and enables you to see the exact situation

of your monitoring results. This benchmark can be used for comparison with your other

benchmarking results, which we recommend to execute in a monthly timeframe.

By clicking on the icon, a pop up will display from which you can request a

benchmark. If there are benchmark results, then the system displays the

benchmark score.

Figure 92: Benchmark score, and manager

For accessing of benchmark, just click in the system row on the score/icon.

Benchmark Manager

The benchmark manager allows you to display your benchmark results and manage your

KPIs. It consists of two tabs:

© 2017 Datavard // 80

Benchmark Results

This tab provides you access to the benchmark results and functions to upload new results

or to download existing benchmark results

Monitoring Results

In this tab, you can select the KPIs and/or detail tables that will be used to calculate your

benchmark. The monitor results should be available in order to calculate, and provide you

with your benchmark score(s). These results are packaged based on the time range you

specify (monthly is recommended), in a downloaded or mail format; just click on your

preferred method.

© 2017 Datavard // 81

Figure 93: Monitoring results Tab

Figure 94: Monitoring results via mail

Note: Refer to your EULA for further information on the type of data being accessed to

provide your benchmarks.

Once your results are processed and benchmarked, we will send you a file from which you

can upload your new benchmark results. The historical benchmarks will be displayed and

will be available for comparison in the lower pane of the benchmark results tab.

© 2017 Datavard // 82

Figure 95: Benchmarks results tab

© 2017 Datavard // 83

Incident Management

Create your own solution library; linked to your monitoring, discover whether this type of

incident has occurred before. Smartly document issues and solution(s) for faster

resolutions with future issues.

Figure 96: Goto Incident management

When something is detected in CanaryCode, link it by creating a new incident. Document

and record the group input of the steps taken for the incident’s resolution.

Figure 97: selection screen for incident management

In the incident management screen, you have an overview of all incidents recorded, their

statuses and whether a solution was found. As these incidents are processed, you can

create and edit them accordingly from here.

© 2017 Datavard // 84

Figure 98: Incident management overview

Incident Detail

From the detail screen, you can add a description, assign a status and link the incident

occurrence to server/ KPI groups. The detail screen facilitates documentation of the

actions taken. Once updates have been made, these needs to be saved and the

information recorded for this incident can be downloaded for further analysis.

© 2017 Datavard // 85

Figure 99: Incident detail

Figure 100: Incident KPI selection

Note: Some KPIs cannot be unselected, as these were defined in the KPI definition and

set - to be always recorded whenever an incident is created.

Solution Detail

In the solution detail tab, if no solution exists for the incident, you will be asked if you

would like to create a solution.

© 2017 Datavard // 86

Figure 101: Solution detail

In the solution tab, you can create, document, assign multiple solutions to one incident and

these solutions can be classified as a final ‘Solution’ or ‘workaround’.

© 2017 Datavard // 87

FIORI dashboard for CanaryCode

Setup of OData service

First you need to setup OData service on CanaryCode central instance that will be

provider of information for FIORI web application.

Prerequisites

• CanaryCode installed on central system

• oData connector for CanaryCode

Setup of OData service on CanaryCode Central system

1. Activate SAP NetWeaver Gateway (if it isn’t activated already) a. Run transaction code /IWFND/IWF_ACTIVATE b. Click on button Activate

2. Create System Alias for CanaryCode Central system a. Run transaction code SM30 b. Put /IWFND/V_DFSYAL into Table/View field c. Click on button Maintain d. Create new entry or if you want to use existing one write down its System Alias

and continue with next step i. Put here connection information to system where OData service is

implemented, in this case you can reuse alias LOCAL or create it with RFC destination NONE

ii. Remember SAP System Alias [ALIAS]

3. Assign Alias to OData gateway service and activate it a. Run transaction code /IWFND/MAINT_SERVICE

If you get this error message:

© 2017 Datavard // 88

Execute the transaction with /n: /n/IWFND/MAINT_SERVICE

b. Click on Add Service

Select service /DVD/MON and click on Add Selected Services, you should see

service /DVD/MON on Service Catalog screen:

c. On down right side click on Add System Alias

d. Create following entry Service Doc. Identifier = /DVD/MON_0001

SAP Systems Alias = [name of created alias]

Default System = X

e. Go back and on down left side click on ICF Node and chose Activate

© 2017 Datavard // 89

f. On the top click on Load Metadata

g. On the down left side click on Call browser to check whether service is up and running:

Web browser should display information like this:

Setup of FIORI dashboard for CanaryCode on differen t system

(Optional)

This step is required only if system where you want to setup UI5 application is different

from system where CanaryCode central system is installed.

If you want to setup UI5 service on same system as CanaryCode Central system is

installed skip this step.

OData service must be installed in system where CanaryCode is installed. It is

possible only to install UI5 application components in a different system and

consume OData service from CanaryCode Central system.

© 2017 Datavard // 90

Introduction

If you want to setup UI5 application on different system from CanaryCode Central system,

you have to setup OData service on both systems. NetWeaver Gateway of system where

UI5 application is installed will be reconnected to NetWeaver Gateway service using RFC

connection.

Prerequisites

• Working RFC connection from currently configuring system to CanaryCode central

system.

Setup on target system

1. Activate SAP NetWeaver Gateway (if it isn’t activated already) a. Run transaction code /IWFND/IWF_ACTIVATE b. Click on button Activate

2. Create System Alias for CanaryCode Central system a. Run transaction code SM30 b. Put /IWFND/V_DFSYAL into Table/View field c. Click on button Maintain d. Create new entry or if you want to use existing one write down its System Alias

(in example we creating alias for system NSD with RFC destination NSD) and continue with next step

i. Put here connection information to system where OData service is implemented

ii. Remember SAP System Alias [ALIAS]

3. Assign Alias to OData gateway service a. Run transaction code /IWFND/MAINT_SERVICE b. Click on Add service c. Select services /DVD/MON and click on Add Selected Services d. Select package assignment $TMP for selected services and confirm e. Go back f. Click on service /DVD/MON g. On down left side click on ICF Node and chose Activate h. On the top click on Load Metadata i. On the down left side click on Call browser to check whether service is up and

running j. Web browser should display information like this:

© 2017 Datavard // 91

Setup of UI5 web application

Prerequisites

• CanaryCode Central system is installed and respective OData services are up and running

Setup steps

1. Import transport CanaryCode UI5 interface package 2. Enable CanaryCode UI5 Web application

a. Run transaction code SICF b. Enter service path: /sap/public/bc/ui2 c. Execute (F8) d. Do right click on node ui2 and chose Activate Service

e. Change service path on top to: /sap/bc/ui2/start_up f. Click on button Apply g. Do right click on node start_up and chose activate h. Change service path on top to: /sap/bc/ui5_ui5/dvd/mon_web/ i. Click on button Apply j. Do right click on node mon_web and chose activate k. Do right click on node mon_web and click Test service l. Web browser should display CanaryCode UI5 Application:

© 2017 Datavard // 92

In case application is not reachable, check that HTTP and HTTPS services are

active on SAP ICM: Call transaction SMICM, then Goto � Services

You should see protocols HTTP and HTTPS active:

© 2017 Datavard // 93

If they are not active, create following parameters in transaction RZ10 for configuring

them:

icm/server_port_0 PROT=HTTP,PORT=80$$,PROCTIMEOUT=600,TIMEOUT=600

icm/server_port_1 PROT=HTTPS,PORT=443$$,PROCTIMEOUT=600,TIMEOUT=600

System restart is required after this change.

© 2017 Datavard // 94

Appendix 1: Collectors

RFC Test Collector

The collector for RFC connections testing is named: /DVD/MON_CL_COL_RFC.

It collects KPIs about count of failed RFC destination tests. There are three KPIs for this

collector:

• RFC_IN_AUTHERR � count of failed RFC tests, testing full RFC connection with

authorization

• RFC_IN_CON_ERR � count of failed RFC tests, testing only connection without

authorization

• RFC_IN_PINGERR � count of failed PING tests, pinging of IP address from RFC

connection

As you can see, there are three tests which collector can provide for each RFC

destination. Ping Test pings the IP defined in RFC, this only tests if the server with RFC

connection is reachable. Connection Test tests also if there is available and running

requested SAP system. Finally, Authorization Test provides complete RFC test with

authorization and calling of functional module.

For PING test is possible to specify count of PINGs on IP address. Default count is 4. To

change this, set parameter “PING_COUNT”.

User can decide which RFC connections in his system should be monitored and which test

or tests should be done for them. If any of requested tests failed the corresponding KPI will

not be zero. KPI value in all three KPIs indicate count of failed RFC destination in each

test.

It is needed to define RFC destination for testing in input table /DVD/MON_RFC_I1, only

provided RFC destinations will be tested. There are also columns to determine which tests

should be done.

Input table /DVD/MON_RFC_I1 contains following fields:

System ID SAP system on which are tested RFC connections

RFC Destination RFC destination for testing

Test conn. Flag if connection testing without authorization should be done.

possible values: ‘X’ – Yes; ‘ ’ – No

© 2017 Datavard // 95

Test auth. Flag if connection testing with authorization should be done.


Test ping Flag if ping test should be provided. This test pings IP address

defined for RFC connection.


The collector provides also detailed output in detail table. For each failed test, there is

information about RFC destination and failed test. Detail table is called Details for

unsuccessful RFC connection tests - /DVD/MON_S_RFC_DETAILS.

Step by step to set up RFC tests KPI:

1. Define RFC destination to test in input table /DVD/MON_RFC_I1

© 2017 Datavard // 96

2. Optional, set parameter for PING count:

3. Save customizing, add the KPI to monitoring profile and you are DONE

4. Check results of KPI after first run of collector job (in “SAP Services” -> ” RFC

Services” )

NOTE: the result should be zero for all KPIs.

OS Command Test Collector

The collector for workload statistic is named: /DVD/MON_CL_COL_SYS_CMD.

It allows to test shell script commands on operational system. The KPIs are defined via

KPI definition and input table /DVD/MON_SYSCMD1.

Input table /DVD/MON_SYSCMD1 set extended KPI definition with following fields:

KPI name Same technical name like in KPI definition

Command name OPTIONAL: Define this or next field.

Name of command to run, possible inputs in SAP transaction SM69.

OS Command OPTIONAL: Define this or previous field.

Command text to run. This can be dangerous – it is better to use

command from SM69.

© 2017 Datavard // 97

Parameters Additional parameters for OS command

REGEXP Regular expression to find in OS response

Requested Value Which type of KPI value is requested:

EXISTS: KPI is set to 1 if REGEXP is found in OS response

COUNT: KPI is set to count of founded REGEXP

NUMBER: KPI is set to first number fouded in REGEXP

Defining KPIs via input tables offers higher scalability to create KPIs based on customer

needs without any coding. It is possible to run any shell command including customer

scripts and collect KPIs with different meanings.

There is a KPI provided in standard delivery with collector as example:

OS_RUN_PS_COUNT. It returns number of running processes on OS (only for Linux).

© 2017 Datavard // 98

Step by step to define workload statistic KPI:

1. Create KPI definition

2. Define KPI extended definition in input table /DVD/MON_SYSCMD1:


4. Check results of KPI after first run of collector job

© 2017 Datavard // 99

Disc Partition Size Collector

The collector for checking free size on HDD partitions is named:

/DVD/MON_CL_COL_SYS_FS.

It collects KPIs about free size on defined HDD partitions. The KPIs are defined via KPI

definition and input table /DVD/MON_SYS_FS1.

Input table /DVD/MON_SYS_FS1 sets extended KPI definition with following fields:

System id Sap system name

KPI name same technical name like in KPI definition

Value result define which value will be set for KPI. Possible options are:

USED_SIZE - used size in MB on system is requested

FREE_SIZE - free size in MB on system is requested

FREE_PERC - free size percentage

Disc name Name of HDD / path where HDD is mounted.

This value have to match name of partition from SAP

transaction ST06 (*). Note: this field is case sensitive.

*) Start SAP transaction ST06

If you do not see this screen (newer SAP release): choose: “Environment” -> “Old ST06”.

© 2017 Datavard // 100

After clicking on “Detail analysis menu”

click on “FileSys” button.

Defining KPIs via input tables offers higher scalability to create KPIs based on customer

needs without any coding. For each system and each KPI is possible to define different

HDD partition and requested value.

There is an example KPI provided in standard delivery with collector as example

DS_ROOT_FREE. It collects percentage of free size of root directory ‘/’.

Step by step to define workload statistic KPI:

1. Create KPI definition

© 2017 Datavard // 101

2. Define KPI extended definition in input table /DVD/MON_SYS_FS1:


4. Check results of KPI after first run of collector job

© 2017 Datavard // 102

Appendix 2: Glossary of Terms

This glossary refers to SAP-related terminology dealing specifically with Datavard

CanaryCode.

RFC Remote Function Call : provides interface shims for

different operating systems and platforms, which provide the

communication APIs for doing RFC from and to R/3 system.

Standard transaction for RFC maintenance is SM59.

KPI Key Performance Indicator describes any form of

measurement data and performance metrics used to

measure system performance. Instead of clearly identifying

the information needs and then carefully designing the most

appropriate indicators to assess performance.

KPI Collector Key Performance Indicator Collector is a concrete

implementation for measuring KPI from systems. All

collectors use same class interface.

Transport An SAP transport is a package, which is used to transfer

data from one SAP installation to another. This data can

range from a simple printer driver to a whole SAP client. It

can be thought of as an "update", the only difference being

that SAP users themselves make SAP transports.

Retention time Determines the number of days from last monitoring update

in which all collected data will be stored in central Monitor.

Only the data from saved interval will be excluded.

Profile defines different monitoring setup for different

© 2017 Datavard // 103

Profile monitored systems. Determines which KPIs will be collected

for a specific monitored system and which events will be

watched.

Threshold

Threshold is a limit value for a KPI. If a KPI exceeds its

defined threshold of an associated event, then this event will

occur.

© 2017 Datavard // 104

Appendix 3: List of Figures

Figure 1 Centralized monitoring ......................................................................................... 13 Figure 2 Decentralized monitoring ..................................................................................... 13 Figure 3: License dialog window ........................................................................................ 17 Figure 4: Filled license in dialog window ............................................................................ 19 Figure 5: CanaryCodeTM monitoring model ........................................................................ 21 Figure 6: First start of the CanaryCodeTM Monitor .............................................................. 24 Figure 7: Adding a new system .......................................................................................... 25 Figure 8: New system in the monitored systems pool ........................................................ 26 Figure 9: Removing a monitored system from monitoring pool .......................................... 26 Figure 10: Warning if Collector jobs are not stopped before deletion ................................ 26 Figure 11: User confirmation before final removal ............................................................. 27 Figure 12: Collector job Manager ....................................................................................... 27 Figure 13: Successfully started monitoring Collector job ................................................... 28 Figure 14: Accessing Report Generator............................................................................. 28 Figure 15: Setting up scope of Report and Exporting options ............................................ 29 Figure 16: Report Export Log ............................................................................................. 29 Figure 17: System maintenance ........................................................................................ 30 Figure 18: Setup of response time ..................................................................................... 30 Figure 19: Server list .......................................................................................................... 31 Figure 20: System groups .................................................................................................. 31 Figure 21: System group list .............................................................................................. 32 Figure 22: Example of graphical distribution of groups in system tree ............................... 32 Figure 23: Configuration setup ........................................................................................... 34 Figure 24: Property configuration ....................................................................................... 35 Figure 25: Restriction in Monitoring Overview ................................................................... 35 Figure 26: Restriction in Monitoring Input Screen .............................................................. 36 Figure 27: Time intervals ................................................................................................... 36 Figure 28: Time intervals in monitoring main screen.......................................................... 37 Figure 29: Messages groups ............................................................................................. 37 Figure 30: Messages list .................................................................................................... 37 Figure 31: Message notification ......................................................................................... 38 Figure 32: User List settings .............................................................................................. 38 Figure 33: Setting up User Filter for System ID’s ............................................................... 39 Figure 34: Setting up User Filter for KPI groups ................................................................ 39 Figure 35: Customized view in CanaryCodeTM Monitor ...................................................... 40 Figure 36: Monitoring settings ............................................................................................ 40 Figure 37: Collectors maintenance .................................................................................... 41 Figure 38: Collector’s KPI .................................................................................................. 41 Figure 39: Collector’s setup ............................................................................................... 41 Figure 40: Collector’s parameters ...................................................................................... 42 Figure 41: Collector’s inputs .............................................................................................. 42 Figure 42: Collector inputs edit .......................................................................................... 43 Figure 43: KPI Definitions .................................................................................................. 43 Figure 44: Maintenance KPI definition ............................................................................... 44 Figure 45: Long description ............................................................................................... 45

© 2017 Datavard // 105

Figure 46: Automatic calculation ........................................................................................ 46 Figure 47: Example for average calculation for .................................................................. 46 Figure 48: Example for percentage calculation for ............................................................. 47 Figure 49: KPI Groups ....................................................................................................... 48 Figure 50: Filter for KPI group ............................................................................................ 48 Figure 51: Detail tables ...................................................................................................... 49 Figure 52: Profile definition ................................................................................................ 49 Figure 53: Association of KPIs to profile ............................................................................ 50 Figure 54: Alerts created for profile-dependent KPI ........................................................... 50 Figure 55: Alert definition ................................................................................................... 51 Figure 56: Created alert ..................................................................................................... 51 Figure 57: Comparison operator ........................................................................................ 52 Figure 58: Event association .............................................................................................. 52 Figure 59: Alert notification ................................................................................................ 53 Figure 60: General settings ................................................................................................ 54 Figure 61: Quick search for SIDs, SERVERs, KPIs ........................................................... 55 Figure 62: Chart settings .................................................................................................... 56 Figure 63: JavaScript Charts ............................................................................................. 56 Figure 64: Main GUI layout ................................................................................................ 59 Figure 65: Main menu buttons ........................................................................................... 59 Figure 66 ............................................................................................................................ 60 Figure 67 ............................................................................................................................ 60 Figure 68 ............................................................................................................................ 60 Figure 69: Tree list of monitored systems without system groups ..................................... 62 Figure 70: Tree list of monitored systems with system groups .......................................... 62 Figure 71: Context menu for system pool tree (select all, deselect all, Select all in alert) . 64 Figure 72: KPI tree (without / with checkboxes) ................................................................. 65 Figure 73: Time interval definition ...................................................................................... 66 Figure 74: Saving of selected time interval ........................................................................ 66 Figure 75: Saving of all checked systems in system pool tree ........................................... 66 Figure 76: Choosing the saved time interval ...................................................................... 67 Figure 77: Detailed system information with list of servers ................................................ 67 Figure 78: Collector jobs tab .............................................................................................. 69 Figure 79: Context menu on selected Collector job ........................................................... 70 Figure 80: Progress of loading data ................................................................................... 70 Figure 81: KPI charts ......................................................................................................... 71 Figure 82: System’s KPI in a chart ..................................................................................... 71 Figure 83: Server’s KPIs in a chart .................................................................................... 72 Figure 84: Grid layout choosing ......................................................................................... 72 Figure 85: Displaying KPI charts in grid layout by selecting KPI in KPI tree ...................... 73 Figure 86: Checked KPI in KPI mixer................................................................................. 74 Figure 87: Monitor Messages ............................................................................................ 75 Figure 88: Detailed information from monitoring ................................................................ 75 Figure 89: Process of event occurrence ............................................................................ 76 Figure 90: Occurred events ............................................................................................... 77 Figure 91: Detail output...................................................................................................... 78 Figure 92: Benchmark score, and manager ....................................................................... 79 Figure 93: Monitoring results Tab ...................................................................................... 81 Figure 94: Monitoring results via mail ................................................................................ 81 Figure 95: Benchmarks results tab .................................................................................... 82

© 2017 Datavard // 106

Figure 96: Goto Incident management............................................................................... 83 Figure 97: selection screen for incident management ....................................................... 83 Figure 98: Incident management overview ........................................................................ 84 Figure 99: Incident detail .................................................................................................... 85 Figure 100: Incident KPI selection ..................................................................................... 85 Figure 101: Solution detail ................................................................................................. 86

© 2017 Datavard // 107

CONTACT

Name: DATAVARD GMBH Römerstraße 9

69115 Heidelberg

Telephone: +49 6202 57514-0

Email: [email protected]

Website: www.datavard.com

© 2017 Datavard // 108

canarycode.com

All information in this document is © Copyright 2015 Datavard GmbH and its subsidiaries. All

rights reserved. No part of this publication may be reproduced or transmitted in any form or for

any purpose without the express permission of Datavard GmbH. The information contained

herein may be changed without prior notice. Datavard and OutBoard are trademarks or

registered trademarks of Datavard GmbH. SAP, R/3, ABAP, SAP NetWeaver, and other SAP

products and services mentioned herein as well as their respective logos are trademarks or

registered trademarks of SAP AG in Germany and other countries. Apache Hadoop, Hadoop,

HDFS, HBase, Hive are trademarks of the Apache Software Foundation.

Documents

CanaryCode UG 1705 - Datavardinfo.datavard.com/hubfs/Canary_Code_PDFS/CanaryCode_UG... · 2017-10-09 · BusinessObjects GRC Global Trade Services, SAP GTS are the trademarks or registered