The NeoLoad Web provider collects metrics from a NeoLoad Web instance and makes them available to Akamas.

Prerequisites

This section provides the minimum requirements that you should match before using the NeoLoad Web telemetry provider.

Supported versions

• NeoLoad Web SaaS or managed version 7.1 or later.

Network requirements

• The NeoLoad Web API must be reachable at a provided address and port (by default https://neoload-api.saas.neotys.com).

Permissions

• NeoLoad Web API access token.

Akamas supported version

• Versions < 2.0.0 are compatibile with Akamas untill version 1.8.0

• Versions >= 2.0.0 are compatible with Akamas from version 1.9.0

Supported component types

• Web Application

You can check NeoLoadWeb provider metrics mapping to see how component-types metrics are extracted by this provider.

Workflow requirements

This section lists the workflow operators this provider depends on.

• NeoLoadWeb operator

Components configuration

Akamas reasons in terms of a system to be optimized and in terms of parameters and metrics of components of that system. To understand which metrics collected from NeoloadWeb should refer to which component, the NeoloadWeb provider looks up the property neoloadweb in the components of a system:

name: MyComponent
properties:
 neoloadweb: "true" # The presence of this property helps akamas discriminate metrics imported using neoloadweb from the ones imported by other providers for the same component

When you create an instance of the NeoLoad Web provider, you should specify some configuration information to allow the provider to correctly extract and process metrics from NeoLoad Web.

You can specify configuration information within the config part of the YAML of the instance definition.

Required properties

• accountToken - NeoLoad Web API access token.

Telemetry instance reference

The following YAML file describes the definition of a telemetry instance.

provider: NeoLoadWeb  # this is an instance of the NeoLoad Web provider
config:
  neoloadApi: http://neoload-api.mydomain.com     # API host
  accountToken: d2d9d8c6064b35209d7f6912db986a6e  # access token
  actions:    # the list of User Paths to import
    - 01 - Home page
  metrics:    # the list of metrics to import
    - transactions_response_time
    - transactions_throughput
    - pages_response_time
    - users

The following table provides the reference for the config section within the definition of the NeoLoad Web provider instance:

Notice: the NeoLoadWeb provider imports data points matching at least one of the configured values for both metrics and actions.

Use cases

This section reports common use cases addressed by this provider.

Collect Web Application metrics

Check the Web Application page for a list of all web application metrics available in Akamas

This example shows how to configure the NeoLoad Web provider in order to collect performance metrics published on the SaaS web API.

You must create a YAML file with the definition of a telemetry instance (neoload_instance.yml) of the NeoLoad Web provider:

provider: NeoLoadWeb
config:
  accountToken: d2d9d8c6064b35209d7f6912db986a6e

and then create the telemetry instance using the Akamas CLI:

akamas create telemetry-instance neoload_instance.yml

You can then configure the workflow in order to trigger the execution of a NeoLoad test using the NeoLoadWeb provider, as in the following example:

name: neoloadweb_wf
tasks:
- name: Run NeoLoadWeb
  operator: NeoLoadWeb

  arguments:
    accountToken: d2d9d8c6064b35209d7f6912db986a6e
    controllerZoneId: mlmEt
    lgZones: mlmEt:1

    scenarioName: test
    projectFile:
      http:
        url: https://files.akamas.io/neoload/project00.zip
        verifySSL: false

Best practices

This section reports common best practices you can adopt to ease the use of this telemetry provider.

• filter the imported metrics: import only the required metrics using the metrics and actions filters, in order to avoid throttling on the NeoLoad Web instance.

To install the NeoLoad Web provider, create a YAML file (called provider.yml in this example) with the definition of the provider:

Then you can install the provider using the Akamas CLI:

The installed provider is shared with all users of your Akamas installation and can monitor many different systems, by configuring appropriate telemetry provider instances.