Replace default collector command line args with custom ones (#98)

Closes #85, closes #87

- Allows us to easily set http, grpc, and browser endpoints via the
command line
- Replaces the default collector commands, since we are hardcoding our
`ConfigProvider` settings anyway
- Works on Windows!

.github/workflows/go.yml

@@ -12,14 +12,19 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: windows-latest
+            env:
+              NO_WINDOWS_SERVICE: 0
+
 
     steps:
     - uses: actions/checkout@v3
 
     - name: Set up Go
       uses: actions/setup-go@v3
       with:
-        go-version: 1.18
+        go-version: 1.19
 
     - name: Build
       run: go build -v

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 otel-desktop-viewer
 desktop-exporter/node_modules
+.vscode
+.vscode/*

main.go

@@ -2,30 +2,58 @@ package main
 
 import (
 	"log"
+	"strconv"
 
+	"github.com/spf13/cobra"
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/confmap"
 	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
 	"go.opentelemetry.io/collector/otelcol"
 )
 
 func main() {
-	// We want this to be as easy to use as possible
-	// so we don't need the user to include a config
-	configContents := `yaml:
+	info := component.BuildInfo{
+		Command:     "otel-desktop-viewer",
+		Description: "Basic OTel with Custom Desktop Exporter",
+		Version:     "0.1.1",
+	}
+
+	if err := run(info); err != nil {
+		log.Fatal(err)
+	}
+}
+
+func runInteractive(buildInfo component.BuildInfo) error {
+	cmd := newCommand(buildInfo)
+	if err := cmd.Execute(); err != nil {
+		log.Fatalf("collector server run finished with error: %v", err)
+	}
+
+	return nil
+}
+
+func newCommand(info component.BuildInfo) *cobra.Command {
+	var httpPortFlag, grpcPortFlag, browserPortFlag int
+
+	rootCmd := &cobra.Command{
+		Use:          info.Command,
+		Version:      info.Version,
+		SilenceUsage: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			configContents := `yaml:
 receivers:
   otlp:
     protocols:
       http:
-        endpoint: localhost:4318
+        endpoint: localhost:` + strconv.Itoa(httpPortFlag) + `
       grpc:
-        endpoint: localhost:4317
+        endpoint: localhost:` + strconv.Itoa(grpcPortFlag) + `
 
 processors:
 
 exporters:
   desktop:
-    endpoint: localhost:8000
+    endpoint: localhost:` + strconv.Itoa(browserPortFlag) + `
 
 service:
   pipelines:
@@ -36,46 +64,40 @@ service:
       exporters:
         - desktop`
 
-	factories, err := components()
-	if err != nil {
-		log.Fatalf("failed to build components: %v", err)
-	}
-
-	info := component.BuildInfo{
-		Command:     "otel-desktop-viewer",
-		Description: "Basic OTel with Custom Desktop Exporter",
-		Version:     "0.0.2",
-	}
+			factories, err := components()
+			if err != nil {
+				log.Fatalf("failed to build components: %v", err)
+			}
 
-	provider := yamlprovider.New()
-	set := otelcol.ConfigProviderSettings{
-		ResolverSettings: confmap.ResolverSettings{
-			URIs:      []string{configContents},
-			Providers: map[string]confmap.Provider{provider.Scheme(): provider},
-		},
-	}
-
-	configProvider, err := otelcol.NewConfigProvider(set)
-	if err != nil {
-		log.Fatal(err)
-	}
+			provider := yamlprovider.New()
+			configProviderSettings := otelcol.ConfigProviderSettings{
+				ResolverSettings: confmap.ResolverSettings{
+					URIs:      []string{configContents},
+					Providers: map[string]confmap.Provider{provider.Scheme(): provider},
+				},
+			}
 
-	settings := otelcol.CollectorSettings{
-		BuildInfo:      info,
-		Factories:      factories,
-		ConfigProvider: configProvider,
-	}
+			configProvider, err := otelcol.NewConfigProvider(configProviderSettings)
+			if err != nil {
+				log.Fatal(err)
+			}
 
-	if err := run(settings); err != nil {
-		log.Fatal(err)
-	}
-}
+			collectorSettings := otelcol.CollectorSettings{
+				BuildInfo:      info,
+				Factories:      factories,
+				ConfigProvider: configProvider,
+			}
 
-func runInteractive(params otelcol.CollectorSettings) error {
-	cmd := otelcol.NewCommand(params)
-	if err := cmd.Execute(); err != nil {
-		log.Fatalf("collector server run finished with error: %v", err)
+			col, err := otelcol.NewCollector(collectorSettings)
+			if err != nil {
+				return err
+			}
+			return col.Run(cmd.Context())
+		},
 	}
 
-	return nil
+	rootCmd.Flags().IntVar(&httpPortFlag, "http", 4318, "The port number on which we listen for OTLP http payloads")
+	rootCmd.Flags().IntVar(&grpcPortFlag, "grpc", 4317, "The port number on which we listen for OTLP grpc payloads")
+	rootCmd.Flags().IntVar(&browserPortFlag, "browser", 8000, "The port number where we expose our data")
+	return rootCmd
 }

main_windows.go

@@ -1,26 +1,29 @@
-// Code generated by "go.opentelemetry.io/collector/cmd/builder". DO NOT EDIT.
-
+// go:build windows
 //go:build windows
 // +build windows
 
 package main
 
 import (
 	"fmt"
+	"log"
 	"os"
 
 	"golang.org/x/sys/windows/svc"
 
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/confmap"
+	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
 	"go.opentelemetry.io/collector/otelcol"
 )
 
-func run(params otelcol.CollectorSettings) error {
+func run(buildInfo component.BuildInfo) error {
 	if useInteractiveMode, err := checkUseInteractiveMode(); err != nil {
 		return err
 	} else if useInteractiveMode {
-		return runInteractive(params)
+		return runInteractive(buildInfo)
 	} else {
-		return runService(params)
+		return runService(buildInfo)
 	}
 }
 
@@ -40,9 +43,57 @@ func checkUseInteractiveMode() (bool, error) {
 	return !isWindowsService, nil
 }
 
-func runService(params otelcol.CollectorSettings) error {
+func runService(buildInfo component.BuildInfo) error {
+	configContents := `yaml:
+receivers:
+  otlp:
+    protocols:
+      http:
+        endpoint: localhost:4318
+      grpc:
+        endpoint: localhost:4317
+
+processors:
+
+exporters:
+  desktop:
+    endpoint: localhost:8000
+
+service:
+  pipelines:
+    traces:
+      receivers:
+        - otlp
+      processors: []
+      exporters:
+        - desktop`
+
+	factories, err := components()
+	if err != nil {
+		log.Fatalf("failed to build components: %v", err)
+	}
+
+	provider := yamlprovider.New()
+	configProviderSettings := otelcol.ConfigProviderSettings{
+		ResolverSettings: confmap.ResolverSettings{
+			URIs:      []string{configContents},
+			Providers: map[string]confmap.Provider{provider.Scheme(): provider},
+		},
+	}
+
+	configProvider, err := otelcol.NewConfigProvider(configProviderSettings)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	collectorSettings := otelcol.CollectorSettings{
+		BuildInfo:      buildInfo,
+		Factories:      factories,
+		ConfigProvider: configProvider,
+	}
+
 	// do not need to supply service name when startup is invoked through Service Control Manager directly
-	if err := svc.Run("", otelcol.NewSvcHandler(params)); err != nil {
+	if err := svc.Run("", otelcol.NewSvcHandler(collectorSettings)); err != nil {
 		return fmt.Errorf("failed to start collector server: %w", err)
 	}