-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Document installing the collector on Windows (#261)
* Document installing the collector on Windows * add line separating screenshots * use quiet instead of passive for headless install command * nest screenshots under windows folder, tweak wording to be more professional. * Add link to installation on windows * Next Steps -> Configuring the Collector Also add a link here to the otel docs on configuration * period instead of exclamation
- Loading branch information
1 parent
1bbf84a
commit d7b0ef2
Showing
8 changed files
with
93 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Windows Installation | ||
|
||
## Installing | ||
|
||
To install the collector on Windows, first [download the latest MSI](https://github.com/observIQ/observiq-collector/releases/latest). | ||
|
||
After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the collector. | ||
|
||
Alternatively, the Powershell command below may be run to install the MSI with no UI. | ||
```pwsh | ||
msiexec /i "<path-to-msi>" /quiet | ||
``` | ||
|
||
## Configuring the Collector | ||
|
||
After installing, the `observiq-collector` service will be running and ready for configuration! | ||
|
||
Logs from the collector will appear in the Application event log. | ||
|
||
By default, the config file for the collector can be found at `C:\Program Files\observiq-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/). | ||
|
||
## Restarting the Collector | ||
Restarting the collector may be done through the services dialog. | ||
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. | ||
|
||
 | ||
|
||
Locate the `observiq-collector` service, right click the entry, and click "Restart" to restart the collector. | ||
|
||
 | ||
|
||
Alternatively, the Powershell command below may be run to restart the collector service. | ||
```pwsh | ||
Restart-Service -Name "observiq-collector" | ||
``` | ||
|
||
## Stopping the Collector | ||
|
||
Stopping the collector may be done through the services dialog. | ||
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. | ||
|
||
 | ||
|
||
Locate the `observiq-collector` service, right click the entry, and click "Stop" to stop the collector. | ||
|
||
 | ||
|
||
Alternatively, the Powershell command below may be run to stop the collector service. | ||
```pwsh | ||
Stop-Service -Name "observiq-collector" | ||
``` | ||
|
||
## Starting the Collector | ||
|
||
Starting the collector may be done through the services dialog. | ||
To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. | ||
|
||
 | ||
|
||
Locate the `observiq-collector` service, right click the entry, and click "Start" to start the collector. | ||
|
||
 | ||
|
||
Alternatively, the Powershell command below may be run to start the collector service. | ||
```pwsh | ||
Start-Service -Name "observiq-collector" | ||
``` | ||
|
||
## Uninstalling | ||
|
||
To uninstall the collector on Windows, navigate to the control panel, then to the "Uninstall a program" dialog. | ||
|
||
 | ||
|
||
Locate the `observiq-collector` entry, and select uninstall. | ||
|
||
 | ||
|
||
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-collector'").Uninstall() | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters