# Create LoadRunner Enterprise telemetry instances

## Create a telemetry instance <a href="#create-a-telemetry-instance" id="create-a-telemetry-instance"></a>

To create an instance of the LoadRunnerEnterprise provider, build a YAML file (`instance.yml` in this example) with the definition of the instance:

```yaml
#LoadRunnerEnterprise Telemetry Provider Instance
provider: LoadRunnerEnterprise
config:
 address: http://influxdb.mycompany.com
 port: 8086
 username: akamas
 password: influxdbpassword
 database: pc_akamas_project
```

Then you can create the instance using the Akamas CLI:

```bash
akamas create telemetry-instance instance.yml
```

### Configuration options <a href="#configuration-options" id="configuration-options"></a>

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

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

#### Required properties <a href="#required-properties" id="required-properties"></a>

* `address`: The address of the InfluxDB instance, in the form of schema://address (i.e <https://influxdb.mycompay.com>)
* `port`: The InfluxDB port
* `username`: The username required to connect to InfluxDB.
* `password`: The password for the username
* `database`: The database name where LoadRunner metrics are stored

### Telemetry instance reference <a href="#hardbreak-telemetry-instance-reference" id="hardbreak-telemetry-instance-reference"></a>

```yaml
provider: LoadRunnerEnterprise # the instance of the LoadRunnerEnterprise provider
config:
 address: https://influxdb.mycompany.com # the address of the Prometheus instance
 port: 8086 # the port of the Prometheus
 username: akamasforinflux
 passowrd: influxpassword
 database: pc_akamas_project
 verifySSL: false
 transactions:
   - mytransaction1
   - mytransaciton2
```

This table reports the reference for the `config` section within the definition of the LoadRunnerEnterprise provider instance:

| Field        | Type           | Description                                                                                                                          | Default value | Restrictions | Required |
| ------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ------------ | -------- |
| address      | String         | The address of the InfluxDB                                                                                                          | -             | A valid URL  | Yes      |
| port         | Integer        | The port of the InfluxDB                                                                                                             | -             | A valid port | yes      |
| username     | String         | The username to connect to InfluxDB                                                                                                  | -             | -            | Yes      |
| password     | String         | The password of the specified user                                                                                                   | -             | -            | Yes      |
| database     | String         | The database with the metrics                                                                                                        | -             | -            | Yes      |
| verifySSL    | Boolean        | Wheter to check the certificate, of InfluxDB API is exposed in HTTPS                                                                 | true          | true/false   | No       |
| transactions | List of string | Restrict metrics collection to the listed transactions names. If not specified the provider will collect metrics of all transactions | Empty         | -            | No       |

### Exported metrics <a href="#exported-metrics" id="exported-metrics"></a>

```yaml
users
transactions_throughput
transactions_response_time
transactions_response_time_min
transactions_response_time_max
requests_throughput
requests_error_throughput
```