# NeoLoadWeb provider

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 <a href="#supported-versions" id="supported-versions"></a>

* NeoLoad Web SaaS or managed version 7.1 or later.

### Network requirements <a href="#network-requirements" id="network-requirements"></a>

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

### Permissions <a href="#permissions" id="permissions"></a>

* NeoLoad Web API access token.

## Akamas supported version <a href="#akamas-supported-version" id="akamas-supported-version"></a>

* 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 <a href="#supported-component-types" id="supported-component-types"></a>

* Web Application

You can check [NeoLoadWeb provider metrics mapping](https://docs.akamas.io/akamas-docs/3.1.2/akamas-reference/telemetry-providers/neoloadweb-metrics-mapping) to see how component-types metrics are extracted by this provider.

## Workflow requirements <a href="#workflow-requirements" id="workflow-requirements"></a>

This section lists the workflow operators this provider depends on.

* [NeoLoadWeb operator](https://docs.akamas.io/akamas-docs/3.1.2/akamas-reference/workflow-operators/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:

{% code lineNumbers="true" %}

```yaml
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
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.akamas.io/akamas-docs/3.1.2/integrating-akamas/integrating-telemetry-providers/neoloadweb-provider.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
