# AppManagerDataExporter for Linux

The AppManagerDataExporter is an independent process that communicates application metrics and traces to the Applications Manager server.

- [Installing the AppManagerDataExporter](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#install)
- [Installing the AppManagerDataExporter without Internet Access](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#installnointernet)
- [Upgrading the AppManagerDataExporter](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#upgrade)
- [Uninstalling the AppManagerDataExporter](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#uninstall)
- [Changing the configuration after installing the AppManagerDataExporter](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#configure)
- [Commands to manage AppManagerDataExporter](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#manage)

## Installing the AppManagerDataExporter

The AppManagerDataExporter can be installed using any of the following methods:

- [Set options using the command-line interface](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#command-line-interface)
- [Set options using the Environmental Variables](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#environment-variables)

### Set options using the command-line interface

Follow the steps below to set options using the command-line interface:

1. Download the installation script.

```bash
wget -O InstallDataExporter.zip https://www.manageengine.com/products/applications_manager/54974026/InstallDataExporter.zip && unzip InstallDataExporter.zip
```

2. Execute the installation command with the required options.

```bash
sudo sh InstallDataExporter.sh -lk "licensekey" -ah "appmanager host name" -ap "appmanager SSL Port"
```

or

```bash
sudo sh InstallDataExporter.sh -lk "licensekey" -apm.host "applications manager host name" -apm.port "SSL port of applications manager"
```

**Note:**

The list of other available options is given below:

| Option | Description |
|---|---|
| -lk, -license.key | APPMANAGER APMInsight License Key |
| -bp, -behind.proxy | The option for enabling or disabling proxy (Set to true or false) |
| -pu, -proxy.url | Complete proxy URL |
| -asp, -agent.status.port | Inter Process Communication status port number (Default: 20021) |
| -adp, -agent.data.port | Inter Process Communication data port number (Default: 20022) |
| -ah, -apm.host | Name of the host or IPV4 address where the server is installed and running. |
| -ap, -apm.port | Port number of the host where the server is installed and running. |
| -aph, -apm.protocol.https | Whether the data to the server should be sent through HTTPS protocol. |

### Set options using the Environmental Variables

Follow the steps below to set options using the environmental variables:

1. Download the installation script.

```bash
wget -O InstallDataExporter.zip https://www.manageengine.com/products/applications_manager/54974026/InstallDataExporter.zip && unzip InstallDataExporter.zip
```

2. Set the required options.

```bash
export APM_LICENSE_KEY="licensekey"
```

```bash
export APM_HOST="appmanager hostname"
```

```bash
export APM_PORT="appmanager SSL PORT"
```

**Note:**

The list of other available options is given below:

| Option | Description |
|---|---|
| APM_LICENSE_KEY | APPMANAGER APMInsight License Key |
| BEHIND_PROXY | The option for enabling or disabling proxy (Set to true or false) |
| PROXY_URL | Complete proxy URL |
| AGENT_STATUS_PORT | Inter Process Communication status port number |
| AGENT_DATA_PORT | Inter Process Communication data port number |

3. Execute the installation command.

```bash
sudo -E sh InstallDataExporter.sh
```

## Installing the AppManagerDataExporter without Internet Access

If the machine has no internet access, kindly follow the steps below to install AppManagerDataExporter:

- [Download](https://www.manageengine.com/products/applications_manager/apm-insight-agent-installation.html) the Exporter in the application server you want to monitor. Perform checksum verification to verify the integrity of the downloaded exporter file.
- Extract the downloaded Agent in the opt directory by executing the following command.

```bash
cd /opt
sudo unzip <exporter_file_name>
```

Navigate to the bin folder which is present under the Agent Extracted path and execute the following command:

```bash
sudo sh service.sh install -license.key [license.key] -apm.host [apm.host] -apm.port [apm.port]
```

**Note:**

The list of other available options is given below:

| Option | Description |
|---|---|
| [apm.host] | Host of Applications Manager |
| [apm.port] | SSL Port of Applications Manager |
| [licenseKey] | The license key. To copy License key, navigate APM → Add monitor page → Python |
| [behind.proxy] | The option for enabling or disabling proxy (Set to true or false) |
| [proxy.url] | Complete proxy URL |
| [agent.status.port] | Inter Process Communication status port number (Default: 20021) |
| [agent.data.port] | Inter Process Communication data port number (Default: 20022) |
| [apm.protocol.https] | Whether the data to the server should be sent through HTTPS protocol. |

**Note:** "appmanager-user" user/group is automatically created as part of the AppManagerDataExporter installation process. This is a security best practice to ensure the Data Exporter runs under a restricted service account instead of root. It is required for secure data collection from APMInsight agents and does not impact any existing users or application permissions.

## Upgrading the AppManagerDataExporter

To upgrade, download the [latest AppManagerDataExporter package](https://www.manageengine.com/products/applications_manager/apm-insight-agent-installation.html#dataexporter) and follow the [installation steps](https://www.manageengine.com/products/applications_manager/help/apm-insight-data-exporter-linux.html#install). The installer will automatically overwrite the existing Data Exporter components with the updated version.

**Note:** No manual uninstallation is required before upgrading.

## Uninstalling the AppManagerDataExporter

Execute the below uninstallation command to uninstall the AppManagerDataExporter.

```bash
sudo sh /opt/AppManagerDataExporter/bin/service.sh uninstall
```

## Changing the configuration after installing the AppManagerDataExporter

Modify the *configuration.json* file located in the */opt/AppManagerDataExporter/conf directory*.

**Note:** The installation path depends on the directory specified during setup (e.g., /opt/AppManagerDataExporter).

| Option | Description |
|---|---|
| license.key | APMInsight license key (APM Tab → Add Monitor → click on the respective agent → copy the license key) |
| behind.proxy | The option for enabling or disabling proxy (Enter true or false) |
| proxy.url | Complete proxy URL |
| agent.status.port | Inter Process Communication status port number. Default: 20021 (Restarting AppManagerDataExporter is required) |
| agent.data.port | Inter Process Communication data port number. Default: 20022 (Restarting AppManagerDataExporter is required) |
| service.log.dir | The path to the directory where logs will be stored |
| service.log.level | The logging level (Possible values are INFO, WARNING, DEBUG, and NOLOG) |
| service.log.size | Log size limit before rotating the log file (Enter the size in bytes) |

## Commands to manage AppManagerDataExporter

Following are the commands for managing AppManagerDataExporter:

- To start AppManagerDataExporter

```bash
service AppManagerDataExporter start
```

or

```bash
sh /opt/AppManagerDataExporter/bin/service.sh start
```

- To stop AppManagerDataExporter

```bash
service AppManagerDataExporter stop
```

or

```bash
sh /opt/AppManagerDataExporter/bin/service.sh stop
```

- To restart AppManagerDataExporter

```bash
service AppManagerDataExporter restart
```

or

```bash
sh /opt/AppManagerDataExporter/bin/service.sh restart
```

- To check the status of AppManagerDataExporter

```bash
service AppManagerDataExporter status
```

or

```bash
sh /opt/AppManagerDataExporter/bin/service.sh status
```