Make it easier to validate Sumo Logic OTC Distro installation

[calebhailey]

The Sumo Logic OTC Distro Installation documentation in this repository is pretty great. Installation of the OpenTelemetry Collector is easy thanks to statically compiled binaries — just download the binary for your platform (operating system + arch), add the executable bit, add the binary to your $PATH, and run a command to verify which version you have installed (i.e. otelcol-sumo --version). Nice and easy!

However, in my experience that's where the ease-of-use ended, and the confusion started. The second to last step in the installation documentation linked me to the Configuration documentation (should I start configuring the collector now, or finish the install?), both of which skip over the critical step of obtaining an installation token and verifying that the collector can communicate with the Sumo Logic platform.

If I could suggest a minor revision, I'd make a few small changes to the Installation documentation:

1. Add a link from the Installation documentation to the installation token documentation, and encourage users to configure an installation token and set it as an environment variable in their shell; e.g.:

   export SUMOLOGIC_INSTALL_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
   

2. Add the minimum viable CLI arguments to run otelcol-sumo such that it will successfully connect to Sumo Logic account.

   I'm assuming this will be possible via some combination of --set flags, for example:

   $ otelcol-sumo \
     --set exporters.sumologic \
     --set extensions.sumologic.install_token ${SUMOLOGIC_INSTALL_TOKEN} \
     --set ...
   

3. Instruct the user to verify that they have successfully installed otelcol-sumo by visiting the Collection page in their Sumo Logic account and confirming that the collector is now registered. Success! 🎉

   Once verified they should be able to stop the collector (e.g. via Ctrl-C).

4. Make the last instruction in the installation documentation be a link to the Configuration documentation. 5.

/cc @pmm-sumo

U

[kasia-kujawa]

Thank you for valuable suggestions! 🙇 We'll improve documentation.

[sumo-drosiek]

@calebhailey Could you look at the #624? I added additional step in installation which kind of compiles #586 and #587

I would like to know you opinion on that and I'm open for suggestions.

Personally I think that too many --set flags will reduce readability