Skip to content

IP-Label Ekara

The IP-Label Ekara application allows you to retrieve all metrics from the Ekara interface. You can request the metrics for a specific application, or be even more specific by requesting a single scenario.

Options

  • Name*: Just a simple label to find it easier in the SenHub's interface
  • Description: Description for your own usage only.
  • Vault*: Choose in the list box the appropriate vault for this resource. If you have not created it yet, see how to add a vault.
  • Group: optional — assign this instance to a group to organise it within SenHub.
  • Application Name*: Name of the application you are targeting. This has to be the same name as set in your Ekara console, just copy/paste it from there.
  • Resource*: The type of IP-Label Ekara resource you want to retrieve. The options are:
    • Scenario Name — Name of a specific scenario in your IP Label console. If left blank, you will get the data merged from all the scenario you have for this application.
    • Last past days — A filter that allows you to choose a period for which to collect information. Those filters are also present in your Ekara environment. Only used when gathering information for a single scenario.

Example output

The channels returned depend on the Resource you configure. When Scenario Name is left blank, the connector returns, for each scenario of the application, its performance, availability and performance trend:

{
  "metrics": [
    { "channel": "Homepage - Performance", "value": 1240, "unit": "ms" },
    { "channel": "Homepage - Availability", "value": 99.8, "unit": "%" },
    { "channel": "Homepage - Increase Performance", "value": 3.5, "unit": "%" },
    { "channel": "Checkout - Performance", "value": 2100, "unit": "ms" },
    { "channel": "Checkout - Availability", "value": 100, "unit": "%" },
    { "channel": "Checkout - Increase Performance", "value": -1.2, "unit": "%" }
  ],
  "message": "Metrics successfully retrieved.",
  "status": "OK",
  "date": 1725981405127
}

When a specific Scenario Name is set, the connector returns the per-step timings of its last run plus the scenario status (channel names come from the Ekara metric schema and are suffixed with the step name; a browser scenario also adds a Full page load time channel):

{
  "metrics": [
    { "channel": "Full page load time", "value": 3560, "unit": "ms" },
    { "channel": "Total time - Step 1", "value": 1240, "unit": "ms" },
    { "channel": "Total time - Step 2", "value": 2320, "unit": "ms" },
    { "channel": "Status", "value": 1 }
  ],
  "message": "Metrics successfully retrieved.",
  "status": "OK",
  "date": 1725981405127
}