feat: Rebrand Repo (#288)

* Rebranded code portion of collector Signed-off-by: Corbin Phelps <[email protected]> * Rebranded human readable strings Signed-off-by: Corbin Phelps <[email protected]> * Update scripts/install/install_unix.sh Co-authored-by: Brandon Johnson <[email protected]> * Update scripts/install/install_unix.sh Co-authored-by: Brandon Johnson <[email protected]> * Update scripts/install/install_unix.sh Co-authored-by: Brandon Johnson <[email protected]> * Update scripts/install/install_unix.sh Co-authored-by: Brandon Johnson <[email protected]> Co-authored-by: Brandon Johnson <[email protected]>
observIQ · Mar 18, 2022 · 6f12e17 · 6f12e17
1 parent 802e932
commit 6f12e17
Show file tree

Hide file tree

Showing 34 changed files with 222 additions and 222 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -34,7 +34,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Copy Windows Binary
-        run: cp dist/collector_windows_amd64/observiq-collector.exe windows/observiq-collector.exe
+        run: cp dist/collector_windows_amd64/observiq-otel-collector.exe windows/observiq-otel-collector.exe
       - name: Copy Plugins to MSI Build Directory
         run: cp -r release_deps/plugins windows/
       - name: Copy Example Config
@@ -58,10 +58,10 @@ jobs:
         id: get-tag
         run: printf '::set-output name=tag::%s' "$(printf '%s' "${{ github.ref }}" | sed 's/refs\/tags\///')"
       - name: "Build MSI from Tagged Release"
-        run: go-msi.exe make -m observiq-collector.msi --version ${{ steps.get-tag.outputs.tag }} --arch amd64
+        run: go-msi.exe make -m observiq-otel-collector.msi --version ${{ steps.get-tag.outputs.tag }} --arch amd64
         working-directory: C:/build
       - name: Install MSI
-        run: msiexec.exe /qn /i observiq-collector.msi
+        run: msiexec.exe /qn /i observiq-otel-collector.msi
         working-directory: C:/build
       - name: Install CINC (Inspec)
         run: . { iwr -useb https://omnitruck.cinc.sh/install.ps1 } | iex; install -project cinc-auditor -version 4
@@ -70,20 +70,20 @@ jobs:
         working-directory: C:/build/test
       - name: Uninstall MSI
         run: |
-          msiexec.exe /qn /x observiq-collector.msi
+          msiexec.exe /qn /x observiq-otel-collector.msi
           sleep 5
         working-directory: C:/build
       - name: Run CINC (Inspec) Uninstall Tests
         run: C:/cinc-project/cinc-auditor/bin/cinc-auditor.bat exec uninstall.rb
         working-directory: C:/build/test
       - name: "Rename MSI to include version tag"
-        run: mv observiq-collector.msi observiq-collector-${{ steps.get-tag.outputs.tag }}.msi
+        run: mv observiq-otel-collector.msi observiq-otel-collector-${{ steps.get-tag.outputs.tag }}.msi
         working-directory: C:/build
       - name: "Upload MSI"
         uses: actions/upload-artifact@v2
         with:
-          name: observiq-collector-${{ steps.get-tag.outputs.tag }}.msi
-          path: C:/build/observiq-collector-${{ steps.get-tag.outputs.tag }}.msi
+          name: observiq-otel-collector-${{ steps.get-tag.outputs.tag }}.msi
+          path: C:/build/observiq-otel-collector-${{ steps.get-tag.outputs.tag }}.msi
           # Short lived because Go Releaser will upload the msi to a release (github release, gcs, etc)
           retention-days: 1
   build-container-image:
@@ -153,7 +153,7 @@ jobs:
           # uncomment to override jar version: https://github.com/open-telemetry/opentelemetry-java-contrib/releases
           #  JMX_JAR_VERSION=v1.7.0
           tags: |
-            observiq/observiq-collector:${{ steps.get-tag.outputs.tag }}
+            observiq/observiq-otel-collector:${{ steps.get-tag.outputs.tag }}
 
   release:
     needs: [build-msi]
@@ -175,8 +175,8 @@ jobs:
       - name: Retrieve Windows MSI Installer
         uses: actions/download-artifact@v2
         with:
-          name: observiq-collector-${{ steps.get-tag.outputs.tag }}.msi
-          path: observiq-collector-${{ steps.get-tag.outputs.tag }}.msi
+          name: observiq-otel-collector-${{ steps.get-tag.outputs.tag }}.msi
+          path: observiq-otel-collector-${{ steps.get-tag.outputs.tag }}.msi
         # install tools for cosign
       - name: Install Dependencies
         run: |

diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -5,7 +5,7 @@ before:
 # https://goreleaser.com/customization/build/
 builds:
   - id: collector
-    binary: observiq-collector
+    binary: observiq-otel-collector
     main: ./cmd/collector
     env:
       - CGO_ENABLED=0
@@ -25,9 +25,9 @@ builds:
         goarch: arm64
     ldflags:
       - -s -w
-      - -X github.com/observiq/observiq-collector/internal/version.version=v{{ .Version }}
-      - -X github.com/observiq/observiq-collector/internal/version.gitHash={{ .FullCommit }}
-      - -X github.com/observiq/observiq-collector/internal/version.date={{ .Date }}
+      - -X github.com/observiq/observiq-otel-collector/internal/version.version=v{{ .Version }}
+      - -X github.com/observiq/observiq-otel-collector/internal/version.gitHash={{ .FullCommit }}
+      - -X github.com/observiq/observiq-otel-collector/internal/version.date={{ .Date }}
     no_unique_dist_dir: false
 
 # https://goreleaser.com/customization/archive/
@@ -52,48 +52,48 @@ archives:
 
 nfpms:
   - id: collector
-    file_name_template: '{{ .PackageName }}_{{ .Os }}_{{ .Arch }}'
-    package_name: observiq-collector
+    file_name_template: "{{ .PackageName }}_{{ .Os }}_{{ .Arch }}"
+    package_name: observiq-otel-collector
     vendor: observIQ, Inc
     maintainer: observIQ <[email protected]>
     description: observIQ's distribution of the OpenTelemetry collector
-    homepage: https://github.com/observIQ/observiq-collector
+    homepage: https://github.com/observIQ/observiq-otel-collector
     license: Apache 2.0
     formats:
-    - rpm
-    - deb
-    bindir: /opt/observiq-collector
+      - rpm
+      - deb
+    bindir: /opt/observiq-otel-collector
     contents:
-    - dst: /opt/observiq-collector
-      type: dir
-      file_info:
-        mode: 0755
-        owner: observiq-collector
-        group: observiq-collector
-    - src: release_deps/config.yaml
-      dst: /opt/observiq-collector/config.yaml
-      file_info:
-        mode: 0640
-        owner: observiq-collector
-        group: observiq-collector
-      type: config|noreplace
-    - src: release_deps/opentelemetry-java-contrib-jmx-metrics.jar
-      dst: /opt/opentelemetry-java-contrib-jmx-metrics.jar
-      file_info:
-        mode: 0755
-        owner: observiq-collector
-        group: observiq-collector
-    - dst: /opt/observiq-collector/plugins
-      type: dir
-      file_info:
-        mode: 0750 # restrict plugins to owner / group only
-        owner: observiq-collector
-        group: observiq-collector
-    # Note: plugins owner/group/mode is set in the post-install script
-    # Attempting to set the permissions here results in the following error:
-    # nfpm failed: cannot write header of release_deps/plugins/amazon_eks.yaml to data.tar.gz: archive/tar: missed writing 1736 bytes
-    - src: release_deps/plugins/*
-      dst: /opt/observiq-collector/plugins
+      - dst: /opt/observiq-otel-collector
+        type: dir
+        file_info:
+          mode: 0755
+          owner: observiq-otel-collector
+          group: observiq-otel-collector
+      - src: release_deps/config.yaml
+        dst: /opt/observiq-otel-collector/config.yaml
+        file_info:
+          mode: 0640
+          owner: observiq-otel-collector
+          group: observiq-otel-collector
+        type: config|noreplace
+      - src: release_deps/opentelemetry-java-contrib-jmx-metrics.jar
+        dst: /opt/opentelemetry-java-contrib-jmx-metrics.jar
+        file_info:
+          mode: 0755
+          owner: observiq-otel-collector
+          group: observiq-otel-collector
+      - dst: /opt/observiq-otel-collector/plugins
+        type: dir
+        file_info:
+          mode: 0750 # restrict plugins to owner / group only
+          owner: observiq-otel-collector
+          group: observiq-otel-collector
+      # Note: plugins owner/group/mode is set in the post-install script
+      # Attempting to set the permissions here results in the following error:
+      # nfpm failed: cannot write header of release_deps/plugins/amazon_eks.yaml to data.tar.gz: archive/tar: missed writing 1736 bytes
+      - src: release_deps/plugins/*
+        dst: /opt/observiq-otel-collector/plugins
     scripts:
       preinstall: "./scripts/package/preinstall.sh"
       postinstall: ./scripts/package/postinstall.sh
@@ -114,7 +114,7 @@ signs:
 release:
   draft: false
   extra_files:
-    - glob: "./observiq-collector-*.msi"
+    - glob: "./observiq-otel-collector-*.msi"
     - glob: "./scripts/install/install_unix.sh"
 
 # https://goreleaser.com/customization/changelog/

diff --git a/Dockerfile b/Dockerfile
@@ -23,7 +23,7 @@ RUN \
     goreleaser build --single-target --skip-validate --rm-dist
 
 # Find built executable, there is only one, and copy it to working dir
-RUN find /collector/dist -name observiq-collector -exec cp {} . \;
+RUN find /collector/dist -name observiq-otel-collector -exec cp {} . \;
 
 RUN curl -L \
     --output /opt/opentelemetry-java-contrib-jmx-metrics.jar \
@@ -48,7 +48,7 @@ ENV PATH=$PATH:/usr/local/openjdk-8/bin
 RUN mkdir -p /etc/otel
 
 # copy binary
-COPY --from=build /collector/observiq-collector /collector/
+COPY --from=build /collector/observiq-otel-collector /collector/
 
 # copy jmx receiver dependency
 COPY --from=build /opt/opentelemetry-java-contrib-jmx-metrics.jar /opt/opentelemetry-java-contrib-jmx-metrics.jar

diff --git a/Makefile b/Makefile
@@ -24,7 +24,7 @@ VERSION ?= $(if $(CURRENT_TAG),$(CURRENT_TAG),$(PREVIOUS_TAG))
 # Default build target; making this should build for the current os/arch
 .PHONY: collector
 collector:
-	go build -ldflags "-s -w -X github.com/observiq/observiq-collector/internal/version.version=$(VERSION)" -o $(OUTDIR)/collector_$(GOOS)_$(GOARCH)$(EXT) ./cmd/collector
+	go build -ldflags "-s -w -X github.com/observiq/observiq-otel-collector/internal/version.version=$(VERSION)" -o $(OUTDIR)/collector_$(GOOS)_$(GOARCH)$(EXT) ./cmd/collector
 
 .PHONY: build-all
 build-all: build-linux build-darwin build-windows

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# observIQ Collector
+# observIQ OpenTelemetry Collector
 
-The observIQ Collector is observIQ's distribution of the OpenTelemetry Collector. It provides everything you need to get setup and sending logs to 
+The observIQ OpenTelemetry Collector is observIQ's distribution of the OpenTelemetry Collector. It provides everything you need to get setup and sending logs to 
 [observIQ](https://observiq.com/).
 
 ## Installation

diff --git a/cmd/collector/main.go b/cmd/collector/main.go
@@ -19,8 +19,8 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/observiq/observiq-collector/collector"
-	"github.com/observiq/observiq-collector/internal/version"
+	"github.com/observiq/observiq-otel-collector/collector"
+	"github.com/observiq/observiq-otel-collector/internal/version"
 	"github.com/spf13/pflag"
 	"go.opentelemetry.io/collector/service"
 )

diff --git a/collector/settings.go b/collector/settings.go
@@ -17,7 +17,7 @@ package collector
 import (
 	"os"
 
-	"github.com/observiq/observiq-collector/factories"
+	"github.com/observiq/observiq-otel-collector/factories"
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/service"
 	"go.uber.org/zap"

diff --git a/docs/installation-linux.md b/docs/installation-linux.md
@@ -2,22 +2,22 @@
 
 ## Installing
 
-Installation is done through deb and rpm packages. Installing the collector will also install the `observiq-collector` service on systemd systems.
+Installation is done through deb and rpm packages. Installing the collector will also install the `observiq-otel-collector` service on systemd systems.
 
 ### RPM Installation
-First download the RPM package for your architecture from the [releases page](https://github.com/observIQ/observiq-collector/releases/latest).
+First download the RPM package for your architecture from the [releases page](https://github.com/observIQ/observiq-otel-collector/releases/latest).
 Then you may install the package using `rpm`, see this example for installing the amd64 package:
 ```sh
-sudo rpm -U ./observiq-collector_linux_amd64.rpm
-sudo systemctl enable --now observiq-collector
+sudo rpm -U ./observiq-otel-collector_linux_amd64.rpm
+sudo systemctl enable --now observiq-otel-collector
 ```
 
 ### DEB Installation
-First download the DEB package for your architecture from the [releases page](https://github.com/observIQ/observiq-collector/releases/latest).
+First download the DEB package for your architecture from the [releases page](https://github.com/observIQ/observiq-otel-collector/releases/latest).
 Then you may install the package using `dpkg`, see this example for installing the amd64 package:
 ```sh
-sudo dpkg -i ./observiq-collector_linux_amd64.deb
-sudo systemctl enable --now observiq-collector
+sudo dpkg -i ./observiq-otel-collector_linux_amd64.deb
+sudo systemctl enable --now observiq-otel-collector
 ```
 
 ### Install/Update script
@@ -27,22 +27,22 @@ This script may also be used to update an existing installation.
 
 To install using the installation script, you may run:
 ```sh
-sudo sh -c "$(curl -fsSlL https://github.com/observiq/observiq-collector/releases/latest/download/install_unix.sh)" install_unix.sh
+sudo sh -c "$(curl -fsSlL https://github.com/observiq/observiq-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh
 ```
 
 ## Configuring the Collector
-After installing, systems with systemd installed will have the `observiq-collector` service up and running!
+After installing, systems with systemd installed will have the `observiq-otel-collector` service up and running!
 
-Logs from the collector will appear in journald. You may run `journalctl -u observiq-collector.service` to view them.
+Logs from the collector will appear in journald. You may run `journalctl -u observiq-otel-collector.service` to view them.
 
-The config file for the collector can be found at `/opt/observiq-collector/config.yaml`. When changing the configuration,the collector service must be restarted in order for config changes to take effect.
+The config file for the collector can be found at `/opt/observiq-otel-collector/config.yaml`. When changing the configuration,the collector service must be restarted in order for config changes to take effect.
 
 For more information on configuring the collector, see the [OpenTelemetry docs](https://opentelemetry.io/docs/collector/configuration/).
 
-By default, the `observiq-collector` service runs as the "observiq-collector" user. Some OpenTelemetry components may require root permissions.
+By default, the `observiq-otel-collector` service runs as the "observiq-otel-collector" user. Some OpenTelemetry components may require root permissions.
 To run the collector as root, you may create a systemd override.
 
-Run `sudo systemctl edit observiq-collector` and paste the following config:
+Run `sudo systemctl edit observiq-otel-collector` and paste the following config:
 ```
 [Service]
 User=root
@@ -54,19 +54,19 @@ Restart the collector for these changes to take effect.
 ## Restarting the Collector
 On systemd systems, the collector may be restarted with the following command:
 ```sh
-systemctl restart observiq-collector
+systemctl restart observiq-otel-collector
 ```
 
 ## Stopping the Collector
 On systemd systems, the collector may be stopped with the following command:
 ```sh
-systemctl stop observiq-collector
+systemctl stop observiq-otel-collector
 ```
 
 ## Starting the Collector
 On systemd systems, the collector may be started with the following command:
 ```sh
-systemctl start observiq-collector
+systemctl start observiq-otel-collector
 ```
 
 ## Uninstalling
@@ -75,19 +75,19 @@ systemctl start observiq-collector
 
 To uninstall the rpm package, run:
 ```sh
-sudo rpm -e observiq-collector
+sudo rpm -e observiq-otel-collector
 ```
 
 ### DEB Uninstall
 
 To uninstall the deb package, run:
 ```sh
-sudo dpkg -r observiq-collector
+sudo dpkg -r observiq-otel-collector
 ```
 
 ### Uninstall script
 
 To uninstall an installation made with the install script, run:
 ```sh
-sudo sh -c "$(curl -fsSlL https://github.com/observiq/observiq-collector/releases/latest/download/install_unix.sh)" install_unix.sh uninstall
+sudo sh -c "$(curl -fsSlL https://github.com/observiq/observiq-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh uninstall
 ```