AppManagerDataExporter for Linux

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

Installing the AppManagerDataExporter

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

Set options using the command-line interface

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

  1. Download the installation script.

    wget -O InstallDataExporter.sh https://www.manageengine.com/products/applications_manager/54974026/InstallDataExporter.sh

  2. Execute the installation command with the required options.

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

    or

    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:

OptionDescription
-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
-adp, -agent.data.port Inter Process Communication data port number
-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.

    wget -O InstallDataExporter.sh https://www.manageengine.com/products/applications_manager/54974026/InstallDataExporter.sh

  2. Set the required options.

    export APM_LICENSE_KEY="licensekey"

    export APM_HOST="appmanager hostname"

    export APM_PORT="appmanager SSL PORT"

    Note:

    The list of other available options is given below:

    OptionDescription
    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.

    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 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.

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

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:

OptionDescription
[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
[agent.data.port] Inter Process Communication data port number
[apm.protocol.https] Whether the data to the server should be sent through HTTPS protocol.

Uninstalling the AppManagerDataExporter

Execute the below uninstallation command to uninstall the AppManagerDataExporter.

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 (Restarting AppManagerDataExporter is required)
agent.data.port Inter Process Communication data port number (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 configure AppManagerDataExporter

    $ apminsight-run --apm_app_name "monitorname" --apm_exp_host "apm-exporter-host" --apm_exp_status_port "20021" --apm_exp_data_port "20022" sampleapp.py

  • To start AppManagerDataExporter

    service AppManagerDataExporter start

    or

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

  • To stop AppManagerDataExporter

    service AppManagerDataExporter stop

    or

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

  • To restart AppManagerDataExporter

    service AppManagerDataExporter restart

    or

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

  • To check the status ofAppManagerDataExporter

    service AppManagerDataExporter status

    or

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

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.