[Draft] Attempting to add Windows Services

I ran out of time and will pick this up in the new year

Things I'm unsure about:

* Can we change the package name on Windows? The package and binaries names
  for everything else is uniformly 'otelcol-google' but the package name on
  Windows is 'google-built-opentelemetry-collector'
* I deleted some code that said it was handling an issue with spaces in the
  default config path on Windows. I don't know what that was for but I'd
  like to fix/workaround that if possible since we are now using services
  which statically point to the default config path in Program Files
* I tested maint.ps1 in isolation, and it works, but I haven't done an
  end-to-end test yet

Author: jefferbrecht

google-built-opentelemetry-collector/README.md

@@ -89,7 +89,7 @@ The Google-Built OpenTelemetry Collector is an open-source, production-ready bui
 | ack | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/ackextension/README.md) |
 | basicauth | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/basicauthextension/README.md) |
 | bearertokenauth | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/bearertokenauthextension/README.md) |
-| filestorage | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/README.md) |
+| filestorage | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/filestorage/README.md) |
 | googleclientauth | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/googleclientauthextension/README.md) |
 | headerssetter | [docs](https://www.github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/headerssetterextension/README.md) |
 | healthagent | [docs](No docs linked for component) |

google-built-opentelemetry-collector/goo/maint.ps1

@@ -27,8 +27,13 @@ $envFromMatch = {
      Where-Object -Property Name -eq $match.Groups[1].Value).Value
 }
 $InstallDir = [regex]::Replace($InstallDir,'^<([^>]+)>',$envFromMatch)
-
 $configFilePath = "$InstallDir\config.yaml"
+$serviceName = "google-built-opentelemetry-collector"
+
+function Set-ServiceConfig {
+    & sc.exe failure $serviceName reset= 60 actions= restart/1000/restart/2000
+    & sc.exe config $serviceName depend= "rpcss" start= delayed-auto
+}
 
 if ($Action -eq "install") {
     if (-not(Test-Path -Path $configFilePath -PathType Leaf)) {
@@ -39,10 +44,25 @@ if ($Action -eq "install") {
          catch {
              throw $_.Exception.Message
          }
-     }
-     else {
-         Write-Host "Keep [$configFilePath] as-is because a file with that name already exists."
-     }
-     # Sleep for 5s before installing services to allow previous service deletion to complete.
-     Start-Sleep -s 5
+    }
+    else {
+        Write-Host "Keep [$configFilePath] as-is because a file with that name already exists."
+    }
+    New-EventLog -LogName Application -Source $serviceName
+    if (-not (Get-Service $serviceName -ErrorAction SilentlyContinue)) {
+        New-Service -DisplayName "Google-Built OpenTelemetry Collector" `
+                    -Name $serviceName `
+                    -BinaryPathName "`"${InstallDir}\bin\otelcol-google.exe`" --config=`"${configFilePath}`"" `
+                    -StartupType Automatic `
+                    -Description "OpenTelemetry Collector Built By Google"
+        Set-ServiceConfig
+        Start-Service $serviceName -Verbose -ErrorAction Stop
+    }
+    else {
+        Set-ServiceConfig
+    }
+}
+elseif ($Action -eq "uninstall") {
+    Stop-Service -Force $serviceName
+    & sc.exe delete $serviceName
 }

integration_test/smoke_test/smoke_test.go

@@ -157,7 +157,7 @@ func locationFromEnvVars() PackageLocation {
 
 func restartCommandForPlatform(platform string) string {
 	if gce.IsWindows(platform) {
-		panic("Unimplemented call to restartCommandForPlatform on Windows.")
+		return "Restart-Service -Force google-built-opentelemetry-collector"
 	}
 	return "sudo systemctl restart otelcol-google"
 }
@@ -276,24 +276,9 @@ func setupOtelCollectorFrom(ctx context.Context, logger *log.Logger, vm *gce.VM,
 	}
 
 	if gce.IsWindows(vm.ImageSpec) {
-		// Sidestep some quoting issues with spaces in the default config location.
-		uploadedConfigPath := `C:\configUpload\otel-config.yaml`
-		if err := gce.UploadContent(ctx, logger, vm, strings.NewReader(config), uploadedConfigPath); err != nil {
-			return fmt.Errorf("setupOtelCollectorFrom() failed to upload config file: %v", err)
-		}
-
-		quotedOtelPath := "`\"C:\\Program Files\\Google\\OpenTelemetry Collector\\bin\\otelcol-google.exe`\""
-		// The best way I've found to start a process asynchronously
-		// (Start-Process and Start-Job didn't detach properly).
-		// One downside is that standard output and standard error are lost.
-		if _, err := gce.RunRemotely(ctx, logger, vm, fmt.Sprintf(`Invoke-WmiMethod -ComputerName . -Class Win32_Process -Name Create -ArgumentList "%s --config=%s"`, quotedOtelPath, uploadedConfigPath)); err != nil {
-			return fmt.Errorf("setupOtelCollectorFrom() failed to start otel collector process: %v", err)
-		}
 		// Give the collector time to start up.
 		time.Sleep(10 * time.Second)
-
-		return nil
-	} // End windows handling.
+	}
 
 	defaultConfigPath := collectorConfigPath(vm.ImageSpec)
 	if err := gce.UploadContent(ctx, logger, vm, strings.NewReader(config), defaultConfigPath); err != nil {

templates/google-built-opentelemetry-collector/goo/maint.ps1.go.tmpl

@@ -27,8 +27,13 @@ $envFromMatch = {
      Where-Object -Property Name -eq $match.Groups[1].Value).Value
 }
 $InstallDir = [regex]::Replace($InstallDir,'^<([^>]+)>',$envFromMatch)
-
 $configFilePath = "$InstallDir\config.yaml"
+$serviceName = "{{ .Name }}"
+
+function Set-ServiceConfig {
+    & sc.exe failure $serviceName reset= 60 actions= restart/1000/restart/2000
+    & sc.exe config $serviceName depend= "rpcss" start= delayed-auto
+}
 
 if ($Action -eq "install") {
     if (-not(Test-Path -Path $configFilePath -PathType Leaf)) {
@@ -39,10 +44,25 @@ if ($Action -eq "install") {
          catch {
              throw $_.Exception.Message
          }
-     }
-     else {
-         Write-Host "Keep [$configFilePath] as-is because a file with that name already exists."
-     }
-     # Sleep for 5s before installing services to allow previous service deletion to complete.
-     Start-Sleep -s 5
+    }
+    else {
+        Write-Host "Keep [$configFilePath] as-is because a file with that name already exists."
+    }
+    New-EventLog -LogName Application -Source $serviceName
+    if (-not (Get-Service $serviceName -ErrorAction SilentlyContinue)) {
+        New-Service -DisplayName "{{ .DisplayName }}" `
+                    -Name $serviceName `
+                    -BinaryPathName "`"${InstallDir}\bin\{{ .BinaryName }}.exe`" --config=`"${configFilePath}`"" `
+                    -StartupType Automatic `
+                    -Description "{{ .Description }}"
+        Set-ServiceConfig
+        Start-Service $serviceName -Verbose -ErrorAction Stop
+    }
+    else {
+        Set-ServiceConfig
+    }
+}
+elseif ($Action -eq "uninstall") {
+    Stop-Service -Force $serviceName
+    & sc.exe delete $serviceName
 }