Support Center Home


OpenTelemetry Collector Installation

Recommendation: Install an OpenTelemetry Collector before instrumenting an application. Instrumenting an application requires the endpoint of the OpenTelemetry Collector.

LogicMonitor provides a wrapped version of OpenTelemetry that is pre-configured to forward traces from your instrumented applications to the LogicMonitor platform. You can install an OpenTelemetry Collector on Linux, Docker, or Kubernetes.

You can use the OpenTelemetry Collector Installation wizard in LogicMonitor to install an OpenTelemetry Collector. This wizard guides you through choosing a platform for installation, allows you to customize the configuration file (For example, you can configure your Cross-Origin Resource Sharing (CORS) policy by specifying the domains the collector is allowed to receive requests from), and provides the command for installing the Collector. If you are installing the Collector in a container, you can edit this command to include optional parameters that allow you to further customize the installation of the Collector.

For more information about CORS, see Mozilla’s Cross-Origin Resource Sharing (CORS) documentation.

General Requirements and Considerations for Installing an OpenTelemetry Collector

To install an OpenTelemetry Collector, you must create a role in LogicMonitor that has the Manage permissions for the following:

  • Settings:
    • Data Ingestion > Traces
    • OpenTelemetry Collectors
      DataSources are created with the Push Metrics API by the OpenTelemetry Collector.
    • LogicModules
  • Resources: All listed resources
    Resources are created if the hosts running the instrumented applications do not already exist in monitoring.

This role must be associated with the user that installs the OpenTelemetry Collector.

Recommendation: Create an API-only user for installing the OpenTelemetry Collector.

For more information, see Users and Roles.

Platform Considerations

LogicMonitor currently supports the following platforms for OpenTelemetry Collector installation:

  • Linux/AMD64 architecture
  • Amazon Elastic Container Service (ECS) on the following verified container platforms:
    • Amazon Fargate
    • Amazon Elastic Compute Cloud (EC2)
  • Elastic Kubernetes Service (EKS) from Amazon Web Services (AWS)
  • Azure Kubernetes Service (AKS) from Microsoft Azure
  • Google Kubernetes Engine (GKE) from Google Cloud

Installing an OpenTelemetry Collector on Linux

You can install the OpenTelemetry Collector on Linux as a root or non-root user. For root users, lmotel runs as a service; and for non-root users, lmotel runs as a process. 

  1. Navigate to Exchange > OpenTelemetry Collectors, and click Add.
    Alternatively, you can navigate to Traces > Onboarding, and select Install OpenTelemetry Collector.
  2. Enter a name for the Collector, and select Linux for the platform.
  3. Select the version of Collector you want to install.
  4. At the “Review Configuration” step of the wizard, make changes to the configuration file as necessary to customize the Processors in the OpenTelemetry Collector settings. For more information about the modifications you can make, see Configurations for OpenTelemetry Collector Processors.
    You can configure CORS by specifying the origins to allow requests. For more information, see CORS (Cross-origin resource sharing) from OpenTelemetry.
  5. At the “Commands” step of the wizard, modify the cURL command as needed, and then copy the command.

Note: The cURL command to download the Collector binary is only valid for two hours after it is made available.

After you download the installer, you must make it executable (chmod +x installer_file) and then run the executable (./installer_file).

In addition, the installation path for the non-root user is the following:

# installation_path=/home# status check:

$ ps -ef | grep lmotel

Installing an OpenTelemetry Collector in Docker

The wizard provides you with a preconfigured Docker run command for running a container with LogicMonitor’s OpenTelemetry Collector Docker image.

  1. Navigate to Exchange > OpenTelemetry Collectors, and click Add.
    Alternatively, you can navigate to Traces > Onboarding, and select Install OpenTelemetry Collector.
  2. Enter a name for the OpenTelemetry Collector, and select Docker for the platform.
  3. Select the version of Collector you want to install.
  4. At the “Review Configuration” step of the wizard, make changes to the configuration file as necessary to customize the Processors in the OpenTelemetry Collector settings. For more information about the modifications you can make, see Configurations for OpenTelemetry Collector Processors.
    You can configure CORS by specifying the origins to allow requests. For more information, see CORS (Cross-origin resource sharing) from OpenTelemetry.
  5. At the “Commands” step of the wizard, do the following:
    1. Enter the username for the user with the minimum privileges. This is the API-only user you created for installing the OpenTelemetry Collector.
      An Access ID and Access Key are automatically created for this user. This is required to authenticate to Docker when you install the OpenTelemetry Collector in your Docker container.
    2. Modify the run command as needed, and then copy the command.
      You can enter optional parameters in the command. For more information, see Configurations for OpenTelemetry Collector Container Installation.
  6. Click Finish.

Use the command from the wizard to install the OpenTelemetry Collector in Docker. For more information about container monitoring for Docker, see Docker Monitoring.

Installing an OpenTelemetry Collector in Kubernetes

LogicMonitor provides Helm Charts to install an OpenTelemetry Collector in a Kubernetes cluster. These Helm Charts run the OpenTelemetry Collector as a replicaset. The wizard provides preconfigured Helm commands for adding LogicMonitor charts and installing the OpenTelemetry Collector.

  1. Navigate to Exchange > OpenTelemetry Collectors, and click Add.
    Alternatively, you can navigate to Traces > Onboarding, and select Install OpenTelemetry Collector.
  2. Enter a name for the OpenTelemetry Collector, and select Kubernetes for the platform.
  3. Select the version of Collector you want to install.
  4. At the “Review Configuration” step of the wizard,  make changes to the configuration file as necessary to customize the Processors in the OpenTelemetry Collector settings. For more information about the modifications you can make, see Configurations for OpenTelemetry Collector Processors.
    You can configure CORS by specifying the origins to allow requests. For more information, see CORS (Cross-origin resource sharing) from OpenTelemetry.
  5. At the “Commands” step of the wizard, do the following:
    1. Enter the username for the user with the minimum privileges. This is the API-only user you created for installing the OpenTelemetry Collector.
      An Access ID and Access Key are automatically created for this user. This is required to authenticate to Kubernetes when you install the OpenTelemetry Collector in your Kubernetes container.
    2. Modify the Helm command as needed, and then copy the command.
      You can enter optional parameters in the command. For more information, see Configurations for OpenTelemetry Collector Container Installation.
  6. Click Finish.

In This Article