Export OpenTelemetry data to Applications Manager

Browse through the following topics to seamlessly export your OpenTelemetry data to APM Insight in Applications Manager:

• Applications Manager OpenTelemetry Collector - Guided Installation
  • Download and install APM OTel Collector
  • Configure the OTLP Endpoint and APM License Key
  • Restart application
• Install Applications Manager OpenTelemetry Collector for Linux
  • Download and install APM OTel Collector
  • Configure the OTLP Endpoint and APM License Key
  • Restart application
• Install Applications Manager OpenTelemetry Collector for Windows
  • Download and install APM OTel Collector
  • Configure the OTLP Endpoint and APM License Key
  • Restart application

Applications Manager OpenTelemetry Collector - Guided Installation

You can install the APM OTEL Collector directly from the Applications Manager UI using the guided installation wizard.

Download and install APM OTel Collector

1. In Applications Manager, navigate to New Monitor > Add New Monitor > APM Insight > OpenTelemetry.
2. Select the operating system (Linux or Windows) and click Next.
3. Follow the on-screen instructions to download and install the APM OTEL Collector.

Configure the OTLP Endpoint and APM License Key

After installation, configure your application's OTLP exporter to send data to the APM OTEL Collector. The guided wizard provides the endpoint URL and license key required for configuration.

Restart application

Restart your application to begin data collection.

Install Applications Manager OpenTelemetry Collector for Linux

Download and install APM OTel Collector

1. Download and install the Applications Manager OpenTelemetry Collector by executing the following commands. Perform checksum verification to validate the integrity of the downloaded file.

   wget -O InstallOtelCollector.zip https://www.manageengine.com/products/applications_manager/54974026/InstallOtelCollector.zip && unzip InstallOtelCollector.zip 
export ME_SERVER_ENDPOINT="https://[HOST-NAME]:[SSL-PORT]" sudo -E sh InstallOtelCollector.sh

   where,

   • [HOST-NAME] → Host of Applications Manager
   • [SSL-PORT] → SSL Port of Applications Manager
   • Example:https://apm-prod-server:8443

Configure the OTLP Endpoint and APM License Key

1. Configure your OTLP Exporter to export data to this endpoint with the api-key header set.

   Generally, the OTLP exporter endpoint and headers in OpenTelemetry SDKs can be set via the OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS environment variables, respectively.

   export OTEL_EXPORTER_OTLP_ENDPOINT="http://[APM-OTELCOLLECTOR-HOST-NAME]:4318" 
export OTEL_EXPORTER_OTLP_HEADERS="api-key=[APM-LICENSE-KEY]"

1. If you are using an OpenTelemetry collector, follow the below syntax:

   exporters: otlphttp: endpoint: "http://[APM-OTELCOLLECTOR-HOST-NAME]:4318" headers: "api-key": "[APM-LICENSE-KEY]"

   where,

   • [APM-LICENSE-KEY] → Applications Manager license key, which is to be added in the OpenTelemetry Agent configuration (otelcol-config.yaml) file. To obtain the license key, navigate to New Monitor > Add New Monitor > APM Insight > OpenTelemetry and copy the license key from the right panel.
   • [APM-OTELCOLLECTOR-HOST-NAME] → Hostname or IP address of the Applications Manager OpenTelemetry Collector.
   • Example:http://otel-collector:4318

Restart application

Restart the application to initiate data collection.

Install Applications Manager OpenTelemetry Collector for Windows

Download and install APM OTel Collector

1. Download the APM Insight OpenTelemetry Collector (.msi) file.

2. Launch the installer and follow the steps given in the installation wizard.

   

3. Please read the license agreement, select I Agree, and click Next to continue.

   

4. Select the installation folder and click Next to continue.

   

5. Enter the required details such as Applications Manager Endpoint as well as Proxy URL (optional) and click Next.

   

6. Click Next to confirm the installation.

   

7. After the installation is complete, click Close.

Configure the OTLP Endpoint and APM License Key

1. Configure your OTLP Exporter to export data to this endpoint with the api-key header set.

   Generally, the OTLP exporter endpoint and headers in OpenTelemetry SDKs can be set via the OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS environment variables, respectively.

   SET OTEL_EXPORTER_OTLP_ENDPOINT=http://[APM-OTELCOLLECTOR-HOST-NAME]:4318 
SET OTEL_EXPORTER_OTLP_HEADERS=api-key=[APM-LICENSE-KEY]

   If you are using an OpenTelemetry collector, follow the below syntax:

   exporters: otlphttp: endpoint: "http://[APM-OTELCOLLECTOR-HOST-NAME]:4318" headers: "api-key": "[APM-LICENSE-KEY]"        

   where,

   • [APM-LICENSE-KEY] → Applications Manager license key, which is to be added in the OpenTelemetry Agent configuration (otelcol-config.yaml) file. To obtain the license key, navigate to New Monitor > Add New Monitor > APM Insight > OpenTelemetry and copy the license key from the right panel.
   • [APM-OTELCOLLECTOR-HOST-NAME] → Hostname or IP address of the Applications Manager OpenTelemetry Collector.
   • Example:http://otel-collector:4318

Restart application

Restart the application to initiate data collection.