About the Forge Metrics Web service

The Forge Metrics Web service provides progress and performance metrics for Forge. You can use the output of this Web service in the monitoring tool or interface of your choice.

A running instance of Forge hosts a WSDL interface, metrics.wsdl. Using this WSDL interface, you can query Forge for specific information about its performance.

Metrics are hierarchical, with parent-child relationships indicated by their location in the tree. You can either give the service a full path to precisely the information you are seeking, or get the full tree and traverse it to find what you want.

The following is an example of the kind of information tree returned by the Forge Metrics Web service:

(Root)
   Start time: Wed Jan 24 14:34:14 2007
   Percent complete: 41.4%
   Throughput: 871 records/second
   Records processed: 24000
   Components
      IndexerAdapter
         Records processed: 24902
         Total processing time: 2.331 seconds
      PropDimMapper
         Records processed: 24902
         Total processing time: 6.983 seconds
      LoadMainData
         Records processed: 24903
        Total processing time: 8.19 seconds
Each metric can be one of three types:
  • Metric — serves as a parent category for child metrics, without containing any data of its own.
  • Attribute metric — stores attributes, such as the start time of the Forge being queried.

    For each attribute metric you request, you receive ID, Name, and Attribute Value (a string).

  • Measurement metric — contains quantatative data, such as:
    • Estimated percent complete.
    • Overall throughput.
    • Number of records processed.
    • Per-component throughput.

    For each measurement metric you request, you receive ID, Name, Measurement Units (a string), and Measurement Value (a number).

Note:

The Forge Metrics Web service does not tell you what step Forge is on or its estimated time to completion.

The service is not long-lived; it exits when Forge does. For this reason, you cannot use this service to find out how long the Forge run took.

The Forge Metrics Web service does not work in conjunction with parallel Forge.