Comment on page

Create NeoLoadWeb telemetry instances

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.
1
provider: NeoLoadWeb  # this is an instance of the NeoLoad Web provider
2
config:
3
  neoloadApi: http://neoload-api.mydomain.com     # API host
4
  accountToken: d2d9d8c6064b35209d7f6912db986a6e  # access token
5
  actions:    # the list of User Paths to import
6
    - 01 - Home page
7
  metrics:    # the list of metrics to import
8
    - transactions_response_time
9
    - transactions_throughput
10
    - pages_response_time
11
    - users
The following table provides the reference for the config section within the definition of the NeoLoad Web provider instance:
Field
Type
Description
Default value
Restrictions
Required
account
String
A valid access token
​
​
Yes
neoloadApi
URL
Hostname of the NeoLoad Web API
https://neoload-api.saas.neotys.com
​
No
metrics
List of strings
List of component metrics to import
['<all transactions>']
​
No
actions
List of strings
List of "User Paths" to import
​
​
No
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:
1
provider: NeoLoadWeb
2
config:
3
  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:
1
name: neoloadweb_wf
2
tasks:
3
- name: Run NeoLoadWeb
4
  operator: NeoLoadWeb
5
​
6
  arguments:
7
    accountToken: d2d9d8c6064b35209d7f6912db986a6e
8
    controllerZoneId: mlmEt
9
    lgZones: mlmEt:1
10
​
11
    scenarioName: test
12
    projectFile:
13
      http:
14
        url: https://files.akamas.io/neoload/project00.zip
15
        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.

Field	Type	Description	Default value	Required
`account`	String	A valid access token		Yes
`neoloadApi`	URL	Hostname of the NeoLoad Web API	`https://neoload-api.saas.neotys.com`	No
`metrics`	List of strings	List of component metrics to import	`['<all transactions>']`	No
`actions`	List of strings	List of "User Paths" to import		No

Install NeoLoadWeb telemetry provider

LoadRunner Professional provider

Last modified 4mo ago