Skip to main content

Install OpenTelemetry Collector on macOS


Follow the steps in this topic to install or uninstall an OpenTelemetry Collector on macOS. See OpenTelemetry Collector for information on other operating systems.

System Requirements​​

The Sumo Logic OpenTelemetry Collector is supported on both amd64 and arm64 architectures.

Minimal resource requirements are the following:

  • 200 MB of disk space
  • 64 MB of RAM

Versions Supported

  • macOS 10.X and up


You can install our OpenTelemetry Collector using one of the following methods:

UI Installation​

  1. In Sumo Logic, select Manage Data > Collection > OpenTelemetry Collection.
  2. On the OpenTelemetry Collection page, click Add Collector.
  3. On the left panel, select macOS as the platform.
  4. Select/create installation token and customize your tags.
  5. (Optional) Select the Auto Configure Host and Process metrics data collection checkbox to collect host and process metrics.
  6. Copy the command and execute it in your system terminal where the collector needs to be installed.
    execute command in terminal
  7. Wait for the installation process to complete, then click Next to proceed.

Install Script​

Get the Installation token​

Get your installation token (if you don't have it already) and assign it to an environment variable:


Run the installation script​

You can run the script in two ways:

  • By piping curl straight into bash:
    sudo curl -Ls | sudo -E bash -s -- --tag "" --tag "deployment.environment=default" && sudo otelcol-sumo --config=/etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"
  • Or by first downloading the script, inspecting its contents for security, and then running it:
    curl -Lso
    sudo -E bash ./ -d

The -E argument to sudo is needed to preserve the SUMOLOGIC_INSTALLATION_TOKEN environment variable in sudo session.

The -d argument to the script is needed on macOS. It will skip Systemd installation, which is not supported on macOS.

It will perform the following operations:

  • Install or upgrade operation by placing the latest version as /usr/local/bin/otelcol-sumo
  • Get static configuration and place it as /etc/otelcol-sumo/sumologic.yaml
  • Create user configuration directory (/etc/otelcol-sumo/conf.d) with common.yaml file which will contain installation token

Script Options​

The following arguments can be passed to the script:

long nameshort namedescriptiontakes value
--skip-installation-tokenkSkips requirement for installation token. This option do not disable default configuration creation.No
--tagtSets tag for collector. This argument can be use multiple times. One per tag.Yes, in key=value format
--download-onlywDownload new binary only and skip configuration part.No
--versionvVersion of Sumo Logic Distribution for OpenTelemetry Collector to install. By default, it gets latest version.Yes (for example: 0.71.0-sumo-0)
--skip-configsDo not create default configurationNo
--skip-systemddPreserves from Systemd service installation.No
--fipsfInstall the FIPS-compliant binary. See FIPS section for more details.No
--install-hostmetricsHInstall the hostmetrics configuration to collect host metrics.No
--yesyDisable confirmation asks.No
--uninstalluRemoves Sumo Logic Distribution for OpenTelemetry Collector from the system and disable Systemd service eventually. Use with --purge to remove all configurations as well.No
--purgepIt has to be used with --uninstall. It removes all Sumo Logic Distribution for OpenTelemetry Collector related configuration and data.No
--helphPrints help and usage.No

The following env variables can be used along with script:


Manual step-by-step Installation​

Step 1. Download the binary​

Examples for OpenTelemetry Collector version 0.73.0-sumo-0.

curl -sLo otelcol-sumo ""

Step 2. Move the binary to your PATH environment​

Move the downloaded binary into a directory from your PATH environment so that it can be used by simply invoking otelcol-sumo.

chmod +x otelcol-sumo
sudo mv otelcol-sumo /usr/local/bin/otelcol-sumo

Step 3. Verify the Installation​

To verify installation, run the OpenTelemetry Collector.

otelcol-sumo --version

Step 4. Running Binary​

As for now, we do not support installation of OpenTelemetry Collector as service for macOS. It needs to be run manually.

sudo otelcol-sumo --config=/etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"

Additional settings​

This section describes common OpenTelemetry customizations.

Using Proxy​

Exporters leverage the HTTP communication and respect the following proxy environment variables:


You can either export proxy environment variables locally, e.g.


or make them available globally for all users, e.g.

tee -a /etc/profile << END

To exclude a specific domain or IP address from using the proxy, you can add it to the NO_PROXY environment variable. For example, to exclude the domain from using the proxy, you can add the following command:



We currently do not build FIPS binary for macOS. Refer to BoringCrypto and FIPS compliance in our repository for more details.


The recommended way to uninstall the OpenTelemetry Collector depends on how you installed it.

Install script​

If you installed the Collector with the install script, you can use it to uninstall the Collector:

sudo curl -Ls | sudo -E bash -s -- -u -y

You can also use flag -p to remove all existing configurations as well:

sudo curl -Ls | sudo -E bash -s -- -u -y -p

You can also run the following command to clear the cache. This will remove any cached data associated with the Collector.

sudo rm -rf /var/cache/otelcol-sumo

Manual step-by-step installation​

If you installed the Collector manually, simply remove the binary from the directory you have placed it in:

sudo rm /usr/local/bin/otelcol-sumo

Upgrading the collector​

Upgrade OpenTelemetry Collector​

First, you have to upgrade the Collector's version. The way you should do it, depends on how you installed it.

Install script​

Running install script will simply upgrade collector to the latest version:

sudo curl -Ls | sudo bash

You'll need to restart the collector process manually in order to apply changes.

Manual step-by-step installation​

If you installed the Collector manually, the simplest way to upgrade is to follow these steps:

Update your config​

After an upgrade, you should make sure that your config for OpenTelemetry Collector is up to date.

To see changes in upstream OpenTelemetry components, refer to the core changelog and contrib changelog.

List of breaking changes specific to Sumo Logic Distribution of OpenTelemetry Collector can be found here.


For information on troubleshooting and solutions, refer to Troubleshooting.

Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.