OpenTelemetry Collector Installation from LogicMonitor Wizard
Last updated on 09 September, 2024You 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.
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.
- Navigate to Traces > (Onboarding), and select Install OpenTelemetry Collector.
- Enter a name for the Collector, and select Linux for the platform.
- Select the version of the Collector you want to install.
- 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. - 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.
- Navigate to Traces > (Onboarding), and select Install OpenTelemetry Collector.
- Enter a name for the OpenTelemetry Collector, and select Docker for the platform.
- Select the version of the Collector you want to install.
- 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. - At the Commands step of the wizard, do the following:
- 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. - Copy the Run command to use for installing the Collector.
You can modify this command as needed by entering optional parameters in the command. For more information, see Configurations for OpenTelemetry Collector Container Installation.
- Enter the username for the user with the minimum privileges. This is the API-only user you created for installing the OpenTelemetry Collector.
- Click Finish.
Use the command from the wizard to install the OpenTelemetry Collector in Docker.
Note: If using Microsoft Azure App Service, you can deploy the OpenTelemetry Collector to an Azure Container Instance after you install it in Docker. For more information, see Configurations for OpenTelemetry Collector Deployment in Microsoft Azure Container Instance.
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.
In addition, you can leverage an Ingress resource for use with the OpenTelemetry Collector by specifying the Ingress Endpoint. This allows the OpenTelemetry Collector to communicate in a hybrid environment if only some of your resources or services are hosted in Kubernetes, and you need these resources to communicate with resources not hosted in Kubernetes.
- Navigate to Traces > (Onboarding), and select Install OpenTelemetry Collector.
- Enter a name for the OpenTelemetry Collector, and select Kubernetes for the platform.
- Select the version of the Collector you want to install.
- 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. - At the Commands step of the wizard, do the following:
- 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. - If you want to leverage an Ingress resource, enter the Ingress Endpoint on which the Ingress Controller listens for incoming spans.
- Copy the Helm Chart command to use for installing the Collector.
You can modify this command as needed by entering the following:- Optional parameters
For more information, see Configurations for OpenTelemetry Collector Container Installation. - Additional properties for leveraging an Ingress resource
For more information, see Configuration for Ingress Resource for OpenTelemetry Kubernetes Installation.
- Optional parameters
- Enter the username for the user with the minimum privileges. This is the API-only user you created for installing the OpenTelemetry Collector.
- Click Finish.