fix: use LF/CNCF compliant name for Sumo Logic Distribution for OpenT…

…elemetry Collector

CHANGELOG.md

@@ -218,7 +218,7 @@ for more details.
 
 ### Released 2022-04-05
 
-Welcome to the Sumo Logic OT Distro Collector!
+Welcome to the Sumo Logic Distribution for OpenTelemetry Collector!
 
 With this release, we are officially out of beta status and in GA, as in General Availability. 🎉
 
@@ -227,7 +227,7 @@ and is commercially fully supported by Sumo Logic in production environments.
 
 Starting with this release, we are using upstream [OpenTelemetry Collector][otc] version numbers
 as the base for the OT Distro version numbers.
-This means that Sumo Logic OT Distro Collector `v0.47.0-sumo-0` is based on `v0.47.0`
+This means that Sumo Logic Distribution for OpenTelemetry Collector `v0.47.0-sumo-0` is based on `v0.47.0`
 of the OpenTelemetry Collector [core][otc_v0_47_0] and [contrib][contrib_v0_47_0] packages.
 
 [otc]: https://github.com/open-telemetry/opentelemetry-collector

README.md

@@ -1,13 +1,13 @@
-# Sumo Logic OpenTelemetry Distro Collector
+# Sumo Logic Distribution for OpenTelemetry Collector
 
 [![Default branch build](https://github.com/SumoLogic/sumologic-otel-collector/actions/workflows/dev_builds.yml/badge.svg)](https://github.com/SumoLogic/sumologic-otel-collector/actions/workflows/dev_builds.yml)
 
-Sumo Logic OpenTelemetry Distro Collector is a Sumo Logic-supported distribution of the [OpenTelemetry Collector][otc_link].
+Sumo Logic Distribution for OpenTelemetry Collector is a Sumo Logic-supported distribution of the [OpenTelemetry Collector][otc_link].
 It is a single agent to send logs, metrics and traces to [Sumo Logic][sumologic].
 
 **Our aim is to extend and not to replace the OpenTelemetry Collector.**
 
-In order to learn more, pleasee see [purpose of Sumo Logic OT distro](./docs/UpstreamRelation.md#purpose-of-sumo-logic-ot-distro)
+In order to learn more, pleasee see [purpose of Sumo Logic Distribution for OpenTelemetry Collector](./docs/UpstreamRelation.md#purpose-of-sumo-logic-distribution-for-opentelemetry-collector)
 
 [otc_link]: https://github.com/open-telemetry/opentelemetry-collector
 [sumologic]: https://www.sumologic.com
@@ -21,13 +21,13 @@ In order to learn more, pleasee see [purpose of Sumo Logic OT distro](./docs/Ups
 - [Known Issues](docs/KnownIssues.md)
 - [Contributing](./CONTRIBUTING.md)
 - [Changelog](./CHANGELOG.md)
-- [Purpose of Sumo Logic OT Distro](./docs/UpstreamRelation.md#purpose-of-sumo-logic-ot-distro)
+- [Purpose of Sumo Logic Distribution for OpenTelemetry Collector](./docs/UpstreamRelation.md#purpose-of-sumo-logic-distribution-for-opentelemetry-collector)
 - [Versioning policy](./docs/UpstreamRelation.md#versioning-policy)
 - [Breaking changes policy](./docs/UpstreamRelation.md#breaking-changes-policy)
 
 ## Components
 
-This section lists the components that are included in Sumo Logic OT distro.
+This section lists the components that are included in Sumo Logic Distribution for OpenTelemetry Collector.
 
 The `highlighted` components are delivered by Sumo Logic.
 

docs/Configuration.md

@@ -138,7 +138,7 @@ See section below on [Collecting logs from files](#collecting-logs-from-files) f
 
 ### Basic configuration for metrics
 
-Sumo Logic OT Distro uses the Telegraf Receiver to ingest metrics.
+Sumo Logic Distribution for OpenTelemetry Collector uses the Telegraf Receiver to ingest metrics.
 
 Here's a minimal `config.yaml` file that sends the host's memory metrics to Sumo Logic:
 

docs/Installation.md

@@ -1,6 +1,6 @@
 # Installation
 
-The Sumo Logic OT Distro can be run using either the binary file available in [Github releases][github_releases] or
+The Sumo Logic Distribution for OpenTelemetry Collector can be run using either the binary file available in [Github releases][github_releases] or
 the container images stored in AWS Public ECR under the following repository:
 [public.ecr.aws/sumologic/sumologic-otel-collector](https://gallery.ecr.aws/sumologic/sumologic-otel-collector).
 
@@ -18,7 +18,7 @@ the container images stored in AWS Public ECR under the following repository:
 
 ## Standalone
 
-The Sumo Logic OT Distro is a static Go binary.
+Sumo Logic Distribution for OpenTelemetry Collector is a static Go binary.
 To run it as a standalone process you only need to run the binary file downloaded from
 [Github releases][github_releases] with an appropriate configuration.
 
@@ -55,7 +55,7 @@ Follow the steps for your platform below.
 > chmod 640 config.yaml
 > ```
 
-1. Run Sumo Logic OT Distro:
+1. Run Sumo Logic Distribution for OpenTelemetry Collector:
 
    ```bash
    otelcol-sumo --config config.yaml
@@ -92,7 +92,7 @@ Follow the steps for your platform below.
 > chmod 640 config.yaml
 > ```
 
-1. Run Sumo Logic OT Distro:
+1. Run Sumo Logic Distribution for OpenTelemetry Collector:
 
    ```bash
    otelcol-sumo --config config.yaml
@@ -129,7 +129,7 @@ Follow the steps for your platform below.
 > chmod 640 config.yaml
 > ```
 
-1. Run Sumo Logic OT Distro:
+1. Run Sumo Logic Distribution for OpenTelemetry Collector:
 
    ```bash
    otelcol-sumo --config config.yaml
@@ -151,7 +151,7 @@ for potential breaking changes that would require manual migration steps.
 
 ## Container image
 
-To run the Sumo Logic OT Distro in a container, you only need to run the container
+To run the Sumo Logic Distribution for OpenTelemetry Collector in a container, you only need to run the container
 using the image available in the
 [public.ecr.aws/sumologic/sumologic-otel-collector](https://gallery.ecr.aws/sumologic/sumologic-otel-collector)
 repository.
@@ -172,7 +172,7 @@ repository.
 > chmod 640 config.yaml
 > ```
 
-1. Run the Sumo Logic OT Distro in container, e.g.
+1. Run the Sumo Logic Distribution for OpenTelemetry Collector in container, e.g.
 
     ```bash
     $ docker run --rm -ti --name sumologic-otel-collector -v "$(pwd)/config.yaml:/etc/config.yaml" "public.ecr.aws/sumologic/sumologic-otel-collector:${RELEASE_VERSION}" --config /etc/config.yaml
@@ -195,7 +195,7 @@ repository.
 
 > **IMPORTANT NOTE**:
 >
-> When running Sumo Logic OT distro in a container with [`sumologicextension`][sumologicextension],
+> When running Sumo Logic Distribution for OpenTelemetry Collector in a container with [`sumologicextension`][sumologicextension],
 > one needs to take into account the local state files which are being used locally
 > in order to store collector credentials upon successful collector registration.
 >
@@ -312,15 +312,15 @@ To run opentelemetry collector as Systemd Service please apply following steps:
 
 ## Ansible
 
-Example installation of Sumo Logic Distro of OpenTelemetry Collector with Ansible is described in
+Example installation of Sumo Logic Distribution for OpenTelemetry Collector with Ansible is described in
 [examples/ansible](../examples/ansible/README.md).
 
 ## Puppet
 
-Example installation of Sumo Logic Distro of OpenTelemetry Collector with Puppet is described in
+Example installation of Sumo Logic Distribution for OpenTelemetry Collector with Puppet is described in
 [examples/puppet](../examples/puppet/README.md).
 
 ## Chef
 
-Example installation of Sumo Logic Distro of OpenTelemetry Collector with Chef is described in
+Example installation of Sumo Logic Distribution for OpenTelemetry Collector with Chef is described in
 [examples/chef](../examples/chef/README.md).

docs/README.md

@@ -9,6 +9,6 @@
 - [Mapping OpenTelemetry concepts to Sumo Logic](./OpenTelemetryConcepts.md)
 - [Known Issues](./KnownIssues.md)
 - [Troubleshooting](./Troubleshooting.md)
-- [Purpose of Sumo Logic OT Distro](./UpstreamRelation.md#purpose-of-sumo-logic-ot-distro)
+- [Purpose of Sumo Logic Distribution for OpenTelemetry Collector](./UpstreamRelation.md#purpose-of-sumo-logic-distribution-for-opentelemetry-collector)
 - [Versioning policy](./UpstreamRelation.md#versioning-policy)
 - [Breaking changes policy](./UpstreamRelation.md#breaking-changes-policy)

docs/UpstreamRelation.md

@@ -4,9 +4,9 @@ This document describes what is purpose of this repository,
 why do we provide another OpenTelemetry Collector distrubution and
 how look like our versioning and breaking changes policies.
 
-## Purpose of Sumo Logic OT Distro
+## Purpose of Sumo Logic Distribution for OpenTelemetry Collector
 
-Sumo Logic OT Distro is the OpenTelemetry Collector with addition of Sumo Logic specific changes.
+Sumo Logic Distribution for OpenTelemetry Collector is the OpenTelemetry Collector with addition of Sumo Logic specific changes.
 
 **Our aim is to extend and not to replace the OpenTelemetry Collector.**
 
@@ -27,8 +27,8 @@ and to provide better customer support:
 
 ## Versioning policy
 
-We are using upstream OpenTelemetry Collector version numbers as the base for the Sumo Logic OT Distro version numbers.
-This means that Sumo Logic OT Distro Collector `v0.47.0-sumo-0` is based on `v0.47.0`
+We are using upstream OpenTelemetry Collector version numbers as the base for the Sumo Logic Distribution for OpenTelemetry Collector version numbers.
+This means that Sumo Logic Distribution for OpenTelemetry Collector `v0.47.0-sumo-0` is based on `v0.47.0`
 of the OpenTelemetry Collector core and contrib packages.
 
 In order to prevent confusion we are going to add Sumo Logic specific features

examples/README.md

@@ -1,9 +1,9 @@
 # Examples
 
-- [ansible](ansible) - example Ansible playbook to install Sumo Logic Distro of OpenTelemetry Collector
+- [ansible](ansible) - example Ansible playbook to install Sumo Logic Distribution for OpenTelemetry Collector
 - [config_cpu_load_metrics.yaml](config_cpu_load_metrics.yaml) - example configuration to collect CPU load metrics using [Host Metrics Receiver][hostmetricsreceiver]
-- [puppet](puppet) - example manifest and module to install Sumo Logic Distro of OpenTelemetry Collector with Puppet
-- [chef](chef) - example cookbook to install Sumo Logic Distro for OpenTelemetry Collector with Chef
+- [puppet](puppet) - example manifest and module to install Sumo Logic Distribution for OpenTelemetry Collector with Puppet
+- [chef](chef) - example cookbook to install Sumo Logic Distribution for OpenTelemetry Collector with Chef
 - [config_logging.yaml](config_logging.yaml) - example configuration to collect CPU load metrics using
   [Host Metrics Receiver][hostmetricsreceiver] without sending them to Sumo Logic.
 - [logs_json](logs_json) - example configuration to parse logs using [json_parser][json_parser] with example log

examples/ansible/README.md

@@ -1,18 +1,18 @@
-# Ansible playbook to install Sumo Logic Distro of OpenTelemetry Collector
+# Ansible playbook to install Sumo Logic Distribution for OpenTelemetry Collector
 
 This playbook will install Sumo Logic Distro of [OpenTelemetry Collector][otc_link].
 
 ## Settings
 
-- `sumologic_otel_collector.version`: version of Sumo Logic Distro of OpenTelemetry Collector
-- `src_config_path`: path to configuration file for Sumo Logic Distro of OpenTelemetry Collector
-- `memory_high`: defines the throttling limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
-- `memory_max`: defines the absolute limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
-- `systemd_service`: enables creation of Systemd Service for Sumo Logic Distro of OpenTelemetry Collector
+- `sumologic_otel_collector.version`: version of Sumo Logic Distribution for OpenTelemetry Collector
+- `src_config_path`: path to configuration file for Sumo Logic Distribution for OpenTelemetry Collector
+- `memory_high`: defines the throttling limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
+- `memory_max`: defines the absolute limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
+- `systemd_service`: enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector
 
 ## Running playbook
 
-- Prepare [configuration](../../docs/Configuration.md) for Sumo Logic Distro of OpenTelemetry Collector
+- Prepare [configuration](../../docs/Configuration.md) for Sumo Logic Distribution for OpenTelemetry Collector
 - Customize [inventory](inventory) file and add your host
 - Adjust configuration of Sumo Logic Distro of of OpenTelemetry Collector in [vars/default.yaml](vars/default.yaml)
 - Run the playbook

examples/chef/README.md

@@ -1,14 +1,14 @@
-# Chef cookbook to install Sumo Logic Distro of OpenTelemetry Collector
+# Chef cookbook to install Sumo Logic Distribution for OpenTelemetry Collector
 
 This cookbook will install Sumo Logic Distro of [OpenTelemetry Collector][otc_link].
 
 ## Properties
 
-- `version`: version of Sumo Logic Distro of OpenTelemetry Collector
-- `src_config_path`: path to configuration file for Sumo Logic Distro of OpenTelemetry Collector
-- `memory_high`: defines the throttling limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
-- `memory_max`: defines the absolute limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
-- `systemd_service`: enables creation of Systemd Service for Sumo Logic Distro of OpenTelemetry Collector
+- `version`: version of Sumo Logic Distribution for OpenTelemetry Collector
+- `src_config_path`: path to configuration file for Sumo Logic Distribution for OpenTelemetry Collector
+- `memory_high`: defines the throttling limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
+- `memory_max`: defines the absolute limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
+- `systemd_service`: enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector
 - `os_family`: OS family, can by either `linux` or `darwin`
 - `os_arch`: OS architecture, can be either `amd64` or `arm64`. `arm64` is supported for `linux` `os_family` only
 
@@ -19,7 +19,7 @@ Chef-solo is installed in Vagrant environment to simplify testing and modifying
 [Chef playground](.) is mounted as `/sumologic/examples/chef`.
 The following steps describe procedure of testing changes:
 
-- Prepare configuration for Sumo Logic Distro of OpenTelemetry Collector
+- Prepare configuration for Sumo Logic Distribution for OpenTelemetry Collector
   using steps described in [Configuration](../../docs/Configuration.md)
 - Adjust [recipe](sumologic-otel-collector/recipes/default.rb) to your needs
 - From main directory of this repository start virtual machine:

examples/chef/sumologic-otel-collector/resources/default.rb

@@ -1,16 +1,16 @@
 # enable unified mode
 unified_mode true
 
-# version of Sumo Logic Distro of OpenTelemetry Collector
+# version of Sumo Logic Distribution for OpenTelemetry Collector
 # rel: https://github.com/SumoLogic/sumologic-otel-collector/releases
 property :version, String, default: '0.50.0-sumo-0'
-# path to configuration file for Sumo Logic Distro of OpenTelemetry Collector
+# path to configuration file for Sumo Logic Distribution for OpenTelemetry Collector
 property :src_config_path, String, default: '/sumologic/examples/config_logging.yaml'
-# defines the throttling limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
+# defines the throttling limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
 property :memory_high, String, default: '200M'
-# defines the absolute limit on memory usage for Sumo Logic Distro of OpenTelemetry Collector
+# defines the absolute limit on memory usage for Sumo Logic Distribution for OpenTelemetry Collector
 property :memory_max, String, default: '300M'
-# enables creation of Systemd Service for Sumo Logic Distro of OpenTelemetry Collector
+# enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector
 property :systemd_service, [true, false] , default: true
 # os architecture
 property :os_arch, ['amd64', 'arm_64'], default: 'amd64'

examples/puppet/README.md

@@ -1,18 +1,18 @@
-# Installation of Sumo Logic Distro of OpenTelemetry Collector with Puppet
+# Installation of Sumo Logic Distribution for OpenTelemetry Collector with Puppet
 
 This [Puppet][puppet] [manifest](manifest/../manifests/install_otel_collector.pp) along with
 [module](modules/install_otel_collector/) will install Sumo Logic Distro of [OpenTelemetry Collector][otc_link].
 
 ## Configuration
 
-- Prepare [configuration](../../docs/Configuration.md) for Sumo Logic Distro of OpenTelemetry Collector and
+- Prepare [configuration](../../docs/Configuration.md) for Sumo Logic Distribution for OpenTelemetry Collector and
   save it in [files](modules/install_otel_collector/files/) directory for `instal_otel_collector` module as `config.yaml`.
 - If needed modify variables in [modules/install_otel_collector/manifests/init.pp](modules/install_otel_collector/manifests/init.pp):
 
   ```ruby
   class install_otel_collector {
-     $otel_collector_version = "0.50.0-sumo-0" # version of Sumo Logic Distro of OpenTelemetry Collector
-     $systemd_service = false                  # enables creation of Systemd Service for Sumo Logic Distro of OpenTelemetry Collector
+     $otel_collector_version = "0.50.0-sumo-0" # version of Sumo Logic Distribution for OpenTelemetry Collector
+     $systemd_service = false                  # enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector
 
   ...
   }
@@ -29,7 +29,7 @@ Example Puppet manifest and module are mounted to Vagrant virtual machine:
 - [modules/](modules/)  is mounted to `/etc/puppetlabs/code/environments/production/modules/`
 - [manifests/](manifests/) is mounted to `/etc/puppetlabs/code/environments/production/manifests/`
 
-To install Sumo Logic Distro of OpenTelemetry Collector with Puppet on Vagrant virtual machine:
+To install Sumo Logic Distribution for OpenTelemetry Collector with Puppet on Vagrant virtual machine:
 
 - Prepare configuration using steps described in [Configuration](#configuration)
 - From main directory of this repository start virtual machine:

examples/puppet/modules/install_otel_collector/manifests/init.pp

@@ -1,7 +1,7 @@
 class install_otel_collector {
 
-   $otel_collector_version = "0.50.0-sumo-0" # version of Sumo Logic Distro of OpenTelemetry Collector
-   $systemd_service = false                  # enables creation of Systemd Service for Sumo Logic Distro of OpenTelemetry Collector
+   $otel_collector_version = "0.50.0-sumo-0" # version of Sumo Logic Distribution for OpenTelemetry Collector
+   $systemd_service = false                  # enables creation of Systemd Service for Sumo Logic Distribution for OpenTelemetry Collector
 
    $arch = $facts['os']['architecture'] ? {
       'aarch64' => 'arm64',

otelcolbuilder/.gon_config_amd64.json

@@ -13,6 +13,6 @@
 
   "dmg" :{
     "output_path": "./cmd/otelcol-sumo-darwin_amd64.dmg",
-    "volume_name": "Sumo Logic OT Distro"
+    "volume_name": "Sumo Logic Distribution for OpenTelemetry Collector"
   }
 }

otelcolbuilder/.gon_config_arm64.json

@@ -13,6 +13,6 @@
 
   "dmg" :{
     "output_path": "./cmd/otelcol-sumo-darwin_arm64.dmg",
-    "volume_name": "Sumo Logic OT Distro"
+    "volume_name": "Sumo Logic Distribution for OpenTelemetry Collector"
   }
 }