fix: Rename the official full name of the collector to "observIQ Dist…

…ro for OpenTelemetry Collector" (#533) * Rename the official full name of the collector per OTel request Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com> * change display name to observIQ Distro for OpenTelemetry Collector * update screenshots * Updated Windows documentation for service names Signed-off-by: Corbin Phelps <corbin.phelps@bluemedora.com> * win readme tweaks Co-authored-by: Brandon Johnson <brandon.johnson@bluemedora.com>
observIQ · Jun 30, 2022 · 8e98c7f · 8e98c7f
1 parent 5e1a1bf
commit 8e98c7f
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Disclaimer
 While the `main` branch is stable, it is still under development and documentation may not fully reflect the current feature set. Please refer to documentation for your specific release.
 
-# observIQ OpenTelemetry Collector
+# observIQ Distro for OpenTelemetry Collector
 
 <center>
 
@@ -13,7 +13,7 @@ While the `main` branch is stable, it is still under development and documentati
 
 </center>
 
-observIQ OpenTelemetry Collector is observIQ’s distribution of the [OpenTelemetry collector](https://github.com/open-telemetry/opentelemetry-collector). It provides a simple and unified solution to collect, refine, and ship telemetry data anywhere.
+observIQ Distro for OpenTelemetry Collector is observIQ’s distribution of the [OpenTelemetry collector](https://github.com/open-telemetry/opentelemetry-collector). It provides a simple and unified solution to collect, refine, and ship telemetry data anywhere.
 
 ## Benefits
 
@@ -80,7 +80,7 @@ For more information on configuration see the [Configuration section](#configura
 
 ## Configuration
 
-The observIQ OpenTelemetry Collector uses OpenTelemetry configuration.
+The observIQ Distro for OpenTelemetry Collector uses OpenTelemetry configuration.
 
 For sample configs, see the [config](/config/) directory.
 For general configuration help, see the [OpenTelemetry docs](https://opentelemetry.io/docs/collector/configuration/).
@@ -141,7 +141,7 @@ service:
 
 # Community
 
-The observIQ OpenTelemetry Collector is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/CONTRIBUTING.md) and [developer guide](/docs/development.md). We look forward to building with you.
+The observIQ Distro for OpenTelemetry Collector is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/CONTRIBUTING.md) and [developer guide](/docs/development.md). We look forward to building with you.
 
 # How can we help?
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -139,7 +139,7 @@ systemctl restart observiq-otel-collector
 
 ## Viewing the metrics in Google Cloud Operations
 
-You should now be able to view the host metrics in your Metrics explorer. Nice work! This is how simple it is to collect host metrics with the observIQ OpenTelemetry collector.
+You should now be able to view the host metrics in your Metrics explorer. Nice work! This is how simple it is to collect host metrics with the observIQ Distro for OpenTelemetry Collector.
 
 ### Metrics collected
 

diff --git a/docs/installation-windows.md b/docs/installation-windows.md
@@ -27,7 +27,7 @@ To access the services dialog, press Win + R, enter `services.msc` into the Run
 
 ![The run dialog](./screenshots/windows/launch-services.png)
 
-Locate the "observIQ OpenTelemetry Collector" service, right click the entry, and click "Restart" to restart the collector.
+Locate the "observIQ Distro for OpenTelemetry Collector" service, right click the entry, and click "Restart" to restart the collector.
 
 ![The services dialog](./screenshots/windows/stop-restart-service.png)
 
@@ -43,7 +43,7 @@ To access the services dialog, press Win + R, enter `services.msc` into the Run
 
 ![The run dialog](./screenshots/windows/launch-services.png)
 
-Locate the "observIQ OpenTelemetry Collector" service, right click the entry, and click "Stop" to stop the collector.
+Locate the "observIQ Distro for OpenTelemetry Collector" service, right click the entry, and click "Stop" to stop the collector.
 
 ![The services dialog](./screenshots/windows/stop-restart-service.png)
 
@@ -59,7 +59,7 @@ To access the services dialog, press Win + R, enter `services.msc` into the Run
 
 ![The run dialog](./screenshots/windows/launch-services.png)
 
-Locate the "observIQ OpenTelemetry Collector" service, right click the entry, and click "Start" to start the collector.
+Locate the "observIQ Distro for OpenTelemetry Collector" service, right click the entry, and click "Start" to start the collector.
 
 ![The services dialog](./screenshots/windows/start-service.png)
 
@@ -74,13 +74,13 @@ To uninstall the collector on Windows, navigate to the control panel, then to th
 
 ![The control panel](./screenshots/windows/control-panel-uninstall.png)
 
-Locate the `"observIQ OpenTelemetry Collector"` entry, and select uninstall. 
+Locate the `"observIQ Distro for OpenTelemetry Collector"` entry, and select uninstall. 
 
 ![The uninstall or change a program dialog](./screenshots/windows/uninstall-collector.png)
 
 Follow the wizard to complete removal of the collector.
 
 Alternatively, Powershell command below may be run to uninstall the collector.
 ```pwsh
-(Get-WmiObject -Class Win32_Product -Filter "Name = 'observIQ OpenTelemetry Collector'").Uninstall()
+(Get-WmiObject -Class Win32_Product -Filter "Name = 'observIQ Distro for OpenTelemetry Collector'").Uninstall()
 ```
diff --git a/docs/screenshots/windows/start-service.png b/docs/screenshots/windows/start-service.png
diff --git a/docs/screenshots/windows/stop-restart-service.png b/docs/screenshots/windows/stop-restart-service.png
diff --git a/docs/screenshots/windows/uninstall-collector.png b/docs/screenshots/windows/uninstall-collector.png
diff --git a/factories/factories.go b/factories/factories.go
@@ -19,7 +19,7 @@ import (
 	"go.uber.org/multierr"
 )
 
-// DefaultFactories returns the default factories used by the observIQ OpenTelemetry collector
+// DefaultFactories returns the default factories used by the observIQ Distro for OpenTelemetry Collector
 func DefaultFactories() (component.Factories, error) {
 	return combineFactories(defaultReceivers, defaultProcessors, defaultExporters, defaultExtensions)
 }

diff --git a/scripts/install/install_macos.sh b/scripts/install/install_macos.sh
@@ -160,7 +160,7 @@ usage()
   USAGE=$(cat <<EOF
 Usage:
   $(fg_yellow '-v, --version')
-      Defines the version of the observIQ OpenTelemetry Collector.
+      Defines the version of the observIQ Distro for OpenTelemetry Collector.
       If not provided, this will default to the latest version.
       Alternatively the COLLECTOR_VERSION environment variable can be
       set to configure the collector version.
@@ -171,7 +171,7 @@ Usage:
 
   $(fg_yellow '-l, --url')
       Defines the URL that the components will be downloaded from.
-      If not provided, this will default to observIQ OpenTelemetry Collector\'s GitHub releases.
+      If not provided, this will default to observIQ Distro for OpenTelemetry Collector\'s GitHub releases.
       Example: '-l http://my.domain.org/observiq-otel-collector' will download from there.
    
   $(fg_yellow '-e, --endpoint')
@@ -426,7 +426,7 @@ latest_version()
 # This will install the package by downloading & unpacking the tarball into the install directory
 install_package()
 {
-  banner "Installing observIQ OpenTelemetry Collector"
+  banner "Installing observIQ Distro for OpenTelemetry Collector"
   increase_indent 
 
   # Remove temporary directory, if it exists
@@ -512,7 +512,7 @@ install_package()
   rm -rf "$TMP_DIR" || error_exit "$LINENO" "Failed to remove temp dir: $TMP_DIR"
   succeeded
 
-  success "observIQ OpenTelemetry Collector installation complete!"
+  success "observIQ Distro for OpenTelemetry Collector installation complete!"
   decrease_indent
 }
 
@@ -558,7 +558,7 @@ display_results()
 
 uninstall()
 {
-  banner "Uninstalling observIQ OpenTelemetry Collector"
+  banner "Uninstalling observIQ Distro for OpenTelemetry Collector"
   increase_indent
 
   if [ ! -f "$INSTALL_DIR/observiq-otel-collector" ]; then

diff --git a/scripts/install/install_unix.sh b/scripts/install/install_unix.sh
@@ -162,15 +162,15 @@ usage()
   USAGE=$(cat <<EOF
 Usage:
   $(fg_yellow '-v, --version')
-      Defines the version of the observIQ OpenTelemetry Collector.
+      Defines the version of the observIQ Distro for OpenTelemetry Collector.
       If not provided, this will default to the latest version.
       Alternatively the COLLECTOR_VERSION environment variable can be
       set to configure the collector version.
       Example: '-v 1.2.12' will download 1.2.12.
 
   $(fg_yellow '-l, --url')
       Defines the URL that the components will be downloaded from.
-      If not provided, this will default to observIQ OpenTelemetry Collector\'s GitHub releases.
+      If not provided, this will default to observIQ Distro for OpenTelemetry Collector\'s GitHub releases.
       Example: '-l http://my.domain.org/observiq-otel-collector' will download from there.
 
   $(fg_yellow '-x, --proxy')
@@ -525,7 +525,7 @@ latest_version()
 # extracting the binaries, and then removing the archive.
 install_package()
 {
-  banner "Installing observIQ OpenTelemetry Collector"
+  banner "Installing observIQ Distro for OpenTelemetry Collector"
   increase_indent
 
   proxy_args=""
@@ -568,7 +568,7 @@ install_package()
     succeeded
   fi
 
-  success "observIQ OpenTelemetry Collector installation complete!"
+  success "observIQ Distro for OpenTelemetry Collector installation complete!"
   decrease_indent
 }
 
@@ -659,7 +659,7 @@ uninstall()
   observiq_banner
 
   set_package_type
-  banner "Uninstalling observIQ OpenTelemetry Collector"
+  banner "Uninstalling observIQ Distro for OpenTelemetry Collector"
   increase_indent
 
   info "Checking permissions..."

diff --git a/windows/templates/product.wxs b/windows/templates/product.wxs
@@ -55,7 +55,15 @@
       <Property Id="INSTALLDIR">
           <RegistrySearch Id='LOADINSTALLDIR' Type='raw'
             Root='HKLM' Key='Software\Microsoft\Windows\CurrentVersion\Uninstall\[ProductName]' Name='InstallLocation' />
+          <!-- Load up the install dir form the previous ProductName if it exists there, instead.-->
+          <RegistrySearch Id='LOADINSTALLDIROLD' Type='raw'
+            Root='HKLM' Key='Software\Microsoft\Windows\CurrentVersion\Uninstall\observIQ OpenTelemetry Collector' Name='InstallLocation' />
       </Property>
+
+      <!-- Set default install dir to be "C:\Program Files\observIQ OpenTelemetry Collector" instead of "C:\Program Files\[ProductName]"-->
+      <SetProperty Id="INSTALLDIR" Value="[$(var.Program_Files)]\observIQ OpenTelemetry Collector" Before="CostInitialize">
+        <![CDATA[NOT INSTALLDIR]]>
+      </SetProperty>
 
       <!-- Load Powershell location -->
       <Property Id="POWERSHELLEXE">
@@ -73,7 +81,7 @@
       <Directory Id="TARGETDIR" Name="SourceDir">
 
         <Directory Id="$(var.Program_Files)">
-            <Directory Id="INSTALLDIR" Name="{{.Product}}">
+            <Directory Id="INSTALLDIR" Name="observIQ OpenTelemetry Collector">
                 {{define "FILES"}}
                 {{range $f := .}}
                 <Component 
@@ -132,6 +140,11 @@
         </Component>
         {{end}}
         <Component Id="RegistryEntriesARP" Guid="*">
+            <!-- 
+                Remove old registry key; This one sticks around for some reason after upgrading to the new product name, which is a problem,
+                since this registry key is the one that makes it show up in the "Uninstall a program" dialog.
+            -->
+            <RemoveRegistryKey Action="removeOnInstall" Root="HKLM" Key="Software\Microsoft\Windows\CurrentVersion\Uninstall\observIQ OpenTelemetry Collector"/>
             <RegistryKey Root="HKLM" Key="Software\Microsoft\Windows\CurrentVersion\Uninstall\[ProductName]">
                 <RegistryValue Type="string" Name="AuthorizedCDFPrefix" Value=""/>
                 <RegistryValue Type="string" Name="Comments" Value="{{.Info.Comments}}"/>
@@ -155,6 +168,7 @@
                 <RegistryValue Type="string" Name="URLInfoAbout" Value="{{.Info.SupportLink}}"/>
                 <RegistryValue Type="string" Name="URLUpdateInfo" Value="{{.Info.UpdateInfoLink}}"/>
                 <RegistryValue Type="integer" Name="Version" Value="{{.Version.Hex}}"/>
+                <RegistryValue Type="integer" Name="NoModify" Value="1"/>
             </RegistryKey>
         </Component>
 

diff --git a/windows/wix.json b/windows/wix.json
@@ -1,5 +1,5 @@
 {
-  "product": "observIQ OpenTelemetry Collector",
+  "product": "observIQ Distro for OpenTelemetry Collector",
   "company": "observIQ, Inc.",
   "license": "./LICENSE.rtf",
   "info": {
@@ -13,7 +13,7 @@
       "service": {
         "name": "observiq-otel-collector",
         "start": "delayed",
-        "display-name": "observIQ OpenTelemetry Collector",
+        "display-name": "observIQ Distro for OpenTelemetry Collector",
         "description": "observIQ's distribution of the OpenTelemetry collector.",
         "arguments": "--config &quot;[INSTALLDIR]config.yaml&quot; --logging &quot;[INSTALLDIR]logging.yaml&quot; --manager &quot;[INSTALLDIR]manager.yaml&quot;"
       }