Skip to content

Commit

Permalink
feat: Document installing the collector on Windows (#261)
Browse files Browse the repository at this point in the history
* 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
BinaryFissionGames authored Mar 10, 2022
1 parent 1bbf84a commit d7b0ef2
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
The observIQ 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

* [Installing on Windows](/docs/installation-windows.md)
### Configs

For sample configs, see the `./config` directory.
Expand All @@ -11,6 +14,9 @@ For general configuration help, see the [OpenTelemetry docs](https://opentelemet
For configuration options of a specific component, take a look at the README found in their respective module roots.

For a list of possible command line arguments to use with the collector, run the collector with the `--help` argument.



# Included Components

### Receivers
Expand Down
86 changes: 86 additions & 0 deletions docs/installation-windows.md
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.

![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Restart" to restart the collector.

![The services dialog](./screenshots/windows/stop-restart-service.png)

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.

![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Stop" to stop the collector.

![The services dialog](./screenshots/windows/stop-restart-service.png)

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.

![The run dialog](./screenshots/windows/launch-services.png)

Locate the `observiq-collector` service, right click the entry, and click "Start" to start the collector.

![The services dialog](./screenshots/windows/start-service.png)

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.

![The control panel](./screenshots/windows/control-panel-uninstall.png)

Locate the `observiq-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-collector'").Uninstall()
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/windows/launch-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/windows/start-service.png
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.
Binary file added docs/screenshots/windows/uninstall-collector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion windows/templates/CustomExitDialog.wxs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To restart collector the service, run:
<Condition Action="show">Installed</Condition>
</Control>
<Control Id="DocLink" Hidden="yes" Type="Hyperlink" X="135" Y="200" Width="220" Height="20" Transparent="yes">
<Text><![CDATA[<a href="https://github.com/observIQ/observiq-collector/blob/windows-docs/docs/installation-windows.md#next-steps">Click here for online documentation on next steps!</a>]]></Text>
<Text><![CDATA[<a href="https://github.com/observIQ/observiq-collector/blob/windows-docs/docs/installation-windows.md#configuring-the-collector">Click here for online documentation on configuration.</a>]]></Text>
<Condition Action="show">NOT Installed</Condition>
</Control>
<Control Id="Title" Type="Text" X="135" Y="20" Width="220" Height="60" Transparent="yes" NoPrefix="yes" Text="!(loc.ExitDialogTitle)" />
Expand Down

0 comments on commit d7b0ef2

Please sign in to comment.