WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:ProfileOverlay
Description:Profiles requests passing through it capturing statistics on count, response times, etc.
Id:mod.architecture.ProfileOverlay
Category:transparent overlay

ProfileOverlay is a transparent overlay. You must instantiate an instance of the overlay from its prototype, this will create a new instance within your application space.

Parameters

The mod.architecture.ProfileOverlay prototype has the following initialisation parameters:

NameRulesTypingDefaultDescription
spaceMandatorySpace(none)
A nested space definition which the overlay will delegate all requests in to.

Here is an auto-generated example of how to instantiate an instance of ProfileOverlay:

<overlay>
  <prototype>mod.architecture.ProfileOverlay</prototype>
  <space>
    < !--wrapped space...-->
  </space>
</overlay>
Import Requirements

To use ProfileOverlay transparent overlay you must import the module urn:com:ten60:netkernel:mod:architecture:

<import>
  <uri>urn:com:ten60:netkernel:mod:architecture</uri>
</import>

Operation

When the profile overlay wraps a space it will profile all requests entering that space through the overlay. It captures detailed timed access statistics and makes them available through it's metadata.

Viewing an instance of this overlay with its wrapped space in the space explorer will show you the captured statistics.

The statistics are provided for each requested endpoint:

  • count - the total number of requests issued to the endpoint
  • exceptions - the number of responses that were exceptions.
  • avg-duration - the average time of the endpoint (milliseconds)
  • max-duration - the longest recorded response time (milliseconds)
  • min-duration - the shorted recorded response time (milliseconds)

The space explorer view also offers the ability to reset the statistics.

Configuration

There is currently no configuration.