Web Documentation

Getting Started

Overview

metric² provides end user and admin tools which visualize, display and share your enterprise data through real-time web and mobile based applications. Providing employees the ability to view all their data in one place, and make informed decisions using relevant, on-hand, and up to date information. Our applications are perfect for start-ups, enterprises, departments and developers wanting to get the most out of their SAP technologies.

 

Why realtime? The intent is to be proactive about your systems or applications health, having the Metric² dashboards up on a large format monitor ensures that everyone is well aware of how your system is performing, and more importantly, when it is not.

Why is metric² Web Based? While I personally prefer Native/Traditional/Window types apps, having metric² run as a web app (using SAPUI5) means it can be used and displayed on a variety of devices and formats.

Why do you call it a platform? Its more than just a bunch of metrics, everything is customizable, you can create your own metrics, your own dashboards and alerts, it also acts as a large data warehouse for any of the data you are monitoring/tracking, taking it past being an app, to a small platform which you can build, and extend upon.

 

metric² is made up of 3 key areas:

Dashboards: metric² can have multiple dashboards. Dashboards are designed as blank canvases, are quite flexible, and can contain metrics.

Metrics: Each dashboard can have multiple metrics displayed at any given time. There are a variety of metrics including a range of predefined datasources (CPU, Memory, Disk etc.) but also include custom metrics (SQL, JSON, Yahoo) which can display a myriad of information to your team. Metrics can be dragged and dropped into their needed locations and also sized accordingly.

Alerts: Certain metrics can have alerts “attached” to them, when a predefined value meets the critera, the alert is logged and displayed.

Back To Top

Installation

Required Roles for this task:
sap.hana.xs.lm.roles::Administrator

Installing metric² is quick and easy using a HANA Delivery Unit. All the files needed to run metric² on your HANA Instance are included in this compressed package.

In order to install the delivery unit follow these steps:

  1. Open the SAP HANA Application Lifecycle Management. The SAP HANA Application Lifecycle Management is available on the SAP HANA XS Web server at the following URL: http://<WebServerHost>:80<SAPHANAinstance>/sap/hana/xs/lm
  2. Choose the Products tab.
  3. Choose the Delivery Units tab.
  4. Choose Import
  5. Select the METRIC2.tgz Delivery Unit.
  6. Choose Browse to display a file explorer, which you can use to locate the DU you want to import, and choose Open.

 

Once this process is completed, you will have all the necessary files installed. Next, we will need to create the Database Schema. This is done using a step by step wizard.

  1. Open https://yourhanaserver:port/lilabs/metric2/install/index.html
  2. Follow the steps to complete the needed steps

Your installation is now complete, but before using metric², please be sure to go through the Post Installation Tasks.

Back To Top

Post Installation Tasks

Once the Delivery Unit or Files have been installed on the HANA server, and the Installation SQL script has been run, the following tasks need to be completed before logging into metric for the first time.

  1. The metric2 service account needs to be initialized.
  2. The SQLCC Connection needs to be configured.

Back To Top

Initializing the service account

metric2 uses a service account for all backend service calls, eliminating the need to create a database user for each application user. This reduces operational overhead and the amount of users with direct access to your database instance. The service account and all its required roles are created when the installation script is executed. However, because the majority of HANA instances require that an account password is set upon their initial login, we need to complete this step manually.

  1. Open the Web Admin Tool: http://<WebServerHost>:80<SAPHANAinstance>/sap/hana/xs/admin/
  2. Login using this these details: (If you are already logged in, click the “Log out” button in the top right corner).
    • Username: M2_SVC_ACCOUNT
    • Password: 7Ag6w612auiY881
  3. The system will request that you change your password.
  4. Change the password, making note of the new password as we will need it in the next step.

Back To Top

Configure Authentication

Required Roles for Task:
sap.hana.xs.admin.roles::RuntimeConfAdministrator

Because metric² uses a SQL Service account to interact with the HANA Server, it is necessary for us to configure the SQLCC connection before we can start to use the application.

  1. Open your web browser to http://<WebServerHost>:80<SAPHANAinstance>/sap/hana/xs/admin/
  2. Select Home
  3. Select XS Artifact Administration
  4. Open lilabs folder
  5. Open the metric2 folder
  6. Open the lib folder
  7. Select the metricuser.xssqlcc file
  8. Click Edit in the bottom right corner
  9. Enter the username: M2_SVC_ACCOUNT
  10. Enter the password: (Defined in the previous step)
  11. Click Save in the bottom right corner

 

Configure SQLCC exmaple

Configuring SQLCC Connection using the SAP HANA Admin tool.

Back To Top

First Login

Now that you have installed metric² using the Delivery Unit, run the SQL Install Scripts and performed the Post Installation tasks, you can login to your system for the first time.

  1. Open your browser to: http://<WebServerHost>:80<SAPHANAinstance>/lilabs/metric2/login.html
  2. Enter the following details:
    • Username: demo@metric2.com
    • Password: demo
  3. metric² should open to a blank dashboard page.
  4. You can test the system by adding a new Alert, Dashboard or Metric to verify the system is running.

In the event you are unable to login, check the troubleshooting guide for assistance, or contact support.

Back To Top

Uninstall

Uninstalling metric² is simple and straight forward, and can be done using the following steps, in the below suggested order:

  1. Remove the Delivery Unit
  2. Delete the M2_SVC_ACCOUNT user
  3. Drop the metric2 Schema from the database

Back To Top

Navigation

Menus

metric has 2 menus which can be used to interact with the application. The Side Menu, shown on the left side, and the Top Menu, shown in the top right corner. Both menu’s offer the same functionality and can be used for:

  1. Open the Sidebar
  2. Open a specific Dashboard
  3. Create a Dashboard
  4. Edit a Dashboard
  5. Create a Metric
  6. Create a Alert
  7. Open Help Tour
  8. Open the Options Menu
  9. Display your Dashboard in Fullscreen

 

Menus

Back To Top

Sidebar

The sidebar is used to display some key pieces of information and also contains some links to useful resources in metric². This includes an overview of your system status, your username, the database instance metric² is running on, a link to the recent Notifications and also the ability to quickly and easily enable or display metric streaming. To open the sidebar:

  1. Click the icon in the top-left of the screen
  2. The sidebar will be displayed

 

Sidebar

Back To Top

Notifications

Notifications are displayed at the top of the screen for various system events, including: alert notifications, errors, saving dashboards, metrics, alerts and settings. In the event you would like to see a list of these notifications:

  1. Click the icon in the top-left of the screen
  2. The sidebar will be displayed
  3. Click the icon in the middle of the screen

 

Notifications

Back To Top

Tour

metric² has a guided tour to assist new users in finding their way around. The tour will take the user through some of the important features and also show them how to use metric². To start the tour follow the steps below:

  1. Click the Tour icon from the top right menu
  2. Once you have read the information, click the Next button in the bottom left corner to move onto the next screen

 

Tour

Back To Top

Fullscreen

metric² can display your dashboard in fullscreen. This is useful if you do not want the browser frame to be shown. This is also useful for displaying your metrics on large format monitors, or on a projector.

  1. Click the Fullscreen icon from the top right menu
  2. If you would like to exit from the fullscreen mode, press Escape (esc) on your keyboard

Back To Top

Profile

Editing your profile is quick and easy, from the main screen, click your name in the top-right corner from the menu. A drop down list will be displayed and you can click the Profile link. Here you can change your first name, last name or email address. You can also change your password by click on the Change Password button.

 

Profile

Back To Top

Settings

Editing the application settings is quick and easy, from the main screen, click your name in the top-right corner from the menu. A drop down list will be displayed and you can click the Profile link. Fromt he Settings screen you can change your User Domain (used for finding other users in your organization) and for showing how much space metric² is currently using. You can also maintain the OAuth Settings for metrics which use this authentication method. The settings screen also allows you to select your prefered theme, dark or light.

 

Settings

Back To Top

Dashboards

Add a Dashboard

  1. Click the  icon from the top-right menu
  2. Enter a dashboard name
  3. You may optionally enter a timezone and the URL to a background image

 

Add Dashboard

Back To Top

Edit a Dashboard

  1. Click the Edit Dashboard icon from the top-right menu
  2. Make any changes and click the Save button

 

Edit Dashboard

Back To Top

Clone a Dashboard

  1. Click the Edit Dashboard icon from the top-right menu
  2. Click the Clone button in the bottom left corner

 

Edit Dashboard

Back To Top

Delete a Dashboard

Please note that the dashboards, its metrics, and all the historical and alert data will be deleted as well.

  1. Click the Edit Dashboard icon from the top-right menu
  2. Click the Delete button in the bottom left corner

 

Edit Dashboard

Back To Top

Share a Dashboard

Please note that a shared dashboard is not password protected. The Url is also unique, in the event you disable sharing, the Url will no longer be valid.

  1. Click the Edit Dashboard icon from the top-right menu
  2. Select the Sharing Enabled Checkbox
  3. Copy the Url which is display
  4. This Url can now be used to display the dashboard from anywhere

 

Share Dashboard

Back To Top

Metrics

Add a Metric

  1. Click the Add Metric icon from the top-right menu
  2. Select a Metric from the list
  3. You can filter the list from the list on the left.
  4. Click the metric you would like to add
  5. Enter the parameters and click Save

 

New Metric

Back To Top

Edit a Metric

  1. Hover over the icon you would like to edit, and select the Edit Metric icon in the top right corner
  2. Enter the parameters and click Save

 

Edit Metric

Back To Top

Move a Metric

Metrics can be moved by simply dragging and dropping them in a their new location. Each metric is snapped into position.

 

Move Metric

Back To Top

Clone a Metric

Cloning a metric is a quick and easy way to copy a metric which has already been configured to the same, or another dashboard. Note that the metric history and any alerts, are not copied.

  1. Hover over the icon you would like to edit, and select the Edit Metric icon in the top right corner
  2. Click the Clone button in the bottom left corner
  3. Select the Dashboard to which you would like to clone the metric to

 

Clone Metric

Back To Top

Delete a Metric

  1. Hover over the icon you would like to edit, and select the Edit Metric icon in the top right corner
  2. Click the Delete button in the bottom left corner

 

Edit Metric

Back To Top

Share a Metric

Please note that a shared metric is not password protected. The Url is also unique, in the event you disable sharing, the Url will no longer be valid.

  1. Hover over the icon you would like to Share, and select the Edit Metric icon in the top right corner
  2. Select the Sharing Enabled Checkbox
  3. Copy the Url which is display
  4. This Url can now be used to display the metric from anywhere

 

Share Metric

Back To Top

Metric History

View Metric History

Certain Metrics values are captured each time they are rendered, or displayed on a dashboard. Thus giving you the ability to view their values over time, which may be helpful for troubleshooting, historical analysis or further investigation. To view the metric history, follow the steps below.

  1. Hover over the metric you would like to edit, and select the History icon in the top right corner
  2. A popup will be shown displaying the recent history of the metric

Features

  1. The date range can be defined, by selecting a start and end date, and then clicking the icon
  2. Using the SAP HANA PAL (Predictive Analytics Library) you can run a predicitve function on the data set, click the Predictive Forecast button in the top right corner
  3. In the event you no longer want any data for the metric, you can click the Delete button in the bottom left corner
  4.  

    View Metric History

Back To Top

Alerts

Alerts

Alerts can be used to trigger notifications about various events and occurances of events in metric². There are 2 types of alerts, User Alerts which are based on metrics which you have created. And System Alerts, which are generated by the HANA instance, these cannot be defined or changed. In order to view the system and user alerts, click on the icon in the top-right menu. The Alerts screen will display:

  1. All User Alerts and their status
  2. All System Alerts
  3. A Chart showing alert count by type
  4. A Chart showing alerts by Month
  5. This screen provices the ability to create, edit, disable and delete alerts
  6. Alert history can be displayed

 

Alerts

Back To Top

Create a Alert

  1. Click the Add Alert icon from the top-right menu
  2. Select a Metric from the drop down list
  3. Select the logical operator for the alert
  4. Enter the numeric threshold which will be used by the operator to trigger the alert
  5. Enter your notification method. This could also include a pager, or Cell Number
  6. Click Save

 

Add Alert

Back To Top

Edit a Alert

  1. Click the name of the user alert you would like to edit
  2. Edit the paramters and click Save

 

Edit Alert

Back To Top

Enable/Disable Alert

Please note that the when an alert is disabled, no data will be captured or alerts triggered.

  1. Find the Alert name from the user alert list
  2. Click the Link in the Status column, this will toggle the alerts status

 

Change Alert Status

Back To Top

Delete a Alert

Please note that the when an alert is deleted, all data and historical data is also deleted.

  1. Click the Alert name from the user alert list
  2. Click the Delete button in the bottom left corner

 

Edit Alert

Back To Top

Alert History

View Alert History

The Alert History scren displays the data from when each alert was triggered. This is helpful for troubleshooting when the event occured, what the parameters of the event were and why the event occured. In order to display the Alert History screen, locate the alert from the list of User Alerts, click the link in the Alert Count Column. The Alert History screen displays:

  1. A heatmap of alert occurances
  2. A bubble chart of alert occurances
  3. A paretto chart of alert occurances
  4. The ability to display the raw alert data, using the SQL Data Browser
  5. This screen also provides the ability to delete the historical alert data

 

Alert History Heatmap
Alert History Paretto
Alert History Bubble

Back To Top

Developers

Support

Remove a Delivery Unit

 

Required roles for this task:
sap.hana.xs.lm.roles::Administrator

Deleting the Delivery unit of the application will render the application useless, while none of your data will be deleted, the application will no longer run.

  1. Open the SAP HANA Application Lifecycle Management. The SAP HANA Application Lifecycle Management is available on the SAP HANA XS Web server at the following URL: http://<WebServerHost>:80<SAPHANAinstance>/sap/hana/xs/lm
  2. Choose the Products tab
  3. Choose the Delivery Units tab
  4. Select METRIC2
  5. Click the Delete button in the toolbar
  6. Confirm the deletion

 

 

 

Back To Top

Drop the metric2 Schema

In the event you need to remove the metric2 Schema from your HANA server, follow the steps below. This will remove all data and structures from your HANA instance pertaining to metric2. Keep in mind that this operation is not reversable, and will require a restore in the event some of the data is required.

 

  1. Open the Web IDE SQL Catalog or your Eclipse Instance
  2. Open a SQL Editor Window
  3. Enter the statement: DROP METRIC2;
  4. Enter the statement: DROP M2_SVC_ACCOUNT;
  5. Execute these 2 statements

If the statement succeeds, and the  step has been completed, metric2 is now uninstalled from your HANA server.

 

Back To Top

Troubleshooting

metric2-login-error

Error: The Login screen shows “Status: Error Error: Internal Server Error”

Suggestion: Check that the SQLCC connection has been defined. You can run this command in Eclipse or SQL Catalog to check the correct connection is being used, using this query:

 

Back To Top