Metrics Integrating the Metrics Service into OWF

Integrating the Metrics Service into OWF

An administrator must configure OWF to pass server-to-server data to the Metrics Service. If the Metrics Service is hosted on a different server than the server running OWF, an administrator must incorporate the Metrics Service into OWF. This involves changes to the OWFConfig.groovy file:

1. Open apache-tomcat-7.0.21\lib\OWFConfig.groovy.

2. Change the enabled property from false to true to enable the Metrics Service (line 2 in the codeblock below).

3. Configure the URL to the server location where the Metrics service is located (line 3 in the codeblock below).

    …
    1 Metrics {
    2   enabled = false
    3   url = 'https://servername:port/metric/metric'
    4
    5   //Optional additional properties with default values shown
    6   //keystorePath = System.properties['javax.net.ssl.keyStore']
    7   //keystorePass = System.properties['javax.net.ssl.keyStorePassword']
    8   //truststorePath = System.properties['javax.net.ssl.trustStore']
    9   //timeout = 1800000
    10 } 
    …
   

4. If OWF or the Metrics Service is hosted on different servers than their server security certificates, generate certificates by setting keystorePath, keystorePass and truststorePath properties.

5. Start the service.

Configuring the Metrics Widget in OWF

Administrators can view Metrics data using an OWF widget. To make Metrics data available in OWF:

1. Integrate the Metrics Server into OWF, as described in the previous section.
2. From the Toolbar, click the OWF Administration tools and select Widgets to open the Widget Manager.
3. Use the following information to create the View Metrics Widget:

Table: Data for Metrics Widget Definition

Definition	Data Input
URL	https://widget-servername:port/metric/admin/Metrics.gsp
Container Icon URL	https://widget-servername:port/metric/themes/common/images/icons/16x16_metrics.png
Launch Menu Icon URL	https://widget-servername:port/metric/themes/common/images/icons/64x64_metrics.png
Width	700
Height	500
Widget Type	Metrics

Note: The Metrics Widget can respond to OWF themes. For information about customizing themes, see the Configuring Themes page.

Viewing the Metrics Widget

The Metrics Service can be viewed in OWF through the Metrics Widget. After following the steps in Configuring the Metrics Widget in OWF section and assigning the View Metrics Widget to users, it will appear under the Metrics button in the Toolbar.

Note: OWF users who signed in using CAS will be prompted to sign in to additional security for the Metrics Service.

Figure: Metrics Widget

The widget opens to a Tag Cloud tab that lists widget views. Clicking the name of a widget from the Tag Cloud or the grid switches to the widget’s Graph tab. This displays how many times that widget was viewed along with a grid listing all widgets and their data. To change the monitoring dates, click the calendar icon(s) above the graph. Use the arrows or click directly on the month and year to select different date durations. Clicking the month and year (identified in the image below) opens a drop-down date selector. After clicking OK, click the highlighted date on the calendar to complete the change.

Figure: Graph Tab Displaying Date Switcher

Keyboard Navigation

To open the Metrics Switcher on the Toolbar, use the following keyboard combination: Alt + Shift + R

Sending Metrics to the Metrics Server

Administrators and Developers can send their own Metrics data to the server should it be needed. The JavaScript code shown below must be used to facilitate the data transfer. For full details, be sure to see the Metrics API found in the JavaScript API Reference Document.