Skip to content

README.md

Latest commit

 

History

History
47 lines (34 loc) · 2.83 KB

README.md

File metadata and controls

47 lines (34 loc) · 2.83 KB

Ansible playbook to install Sumo Logic Distribution for OpenTelemetry Collector

This playbook will install Sumo Logic Distro of OpenTelemetry Collector on both Linux/Mac and Windows hosts.

Controller Node (Where You Run Ansible)

  • Must be a Linux/Mac environment
  • On Windows, use WSL (Windows Subsystem for Linux) with Ansible installed

Target Nodes (Where the Collector Will Be Installed)

  • Windows Hosts:
    • PowerShell 5.1 or later
    • WinRM enabled and accessible from the controller
    • Ansible user must have administrative privileges

Running playbook

  • Get an installation token from Sumo Logic, see

  • Prepare configuration file for Sumo Logic Distribution for OpenTelemetry Collector and put the file in a directory of your choice. You can put multiple configuration files in this directory, and all of them will be used.

    NOTE: The playbook will prepare a base configuration for you, and configure the extension as well.

  • Customize inventory file and add your host

  • Run the playbook, passing the prepared values via the command line:

    ansible-playbook -i inventory install_sumologic_otel_collector.yaml \
  -e '{"installation_token": "<your_token>", "collector_tags": {"tag_name": "tag_value"}, "src_config_path": "<your_config_path>"}'

    Notice: If you need to specify a password for sudo, run ansible-playbook with --ask-become-pass (-K for short).

Playbook variables

  • installation_token: Sumo Logic installation token
  • collector_tags: Collector tags, these are applied to all processed data
  • api_url: Sumo Logic API url. You shouldn't need to set this in most normal circumstances.
  • version: version of Sumo Logic Distribution for OpenTelemetry Collector. The default is the latest stable version.
  • systemd_service: enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector. Enabled by default. Note that this playbook will not start the collector if you disable this.
  • src_config_path: path to configuration directory for Sumo Logic Distribution for OpenTelemetry Collector
  • remotely_managed: enables creation of remotely managed Sumo Logic Distribution for OpenTelemetry Collector. Disabled by default.
  • opamp_api_url: Sumo Logic Opamp API url. You shouldn't need to set this in most normal circumstances.