build: Update DEB and RPM artifacts to align with documentation/non contrib collector

[Jammicus]

Description: Updating RPM and DEB artifacts to match documentation

Currently the RPM and Deb artifacts are not aligned to how they are described in the documentation. They are:

• Not bundled with a default configuration file, so the service automatically fails on start when ran via systemd. Default collector config is not created on startup #3097
• Not bundled with a environment file for the systemd service, so users cannot follow the documentation steps for adding additional options to the service (Systemd environment file and config are missing #3143)

This PR does the following:

• Bundles the default configuration file in both the RPM and DEB artifacts as
• Bundles a default environment file with OTELCOL_OPTIONS
• Removes now redundant test that checks whether the service will crash without a config file. As its bundled with the artifacts it should never be without a config file unless the users remove it. (Happy to add back if you feel its needed)

Link to tracking Issue:
#3097
#3143

Testing: Automated tests have installed + checked service is running after 5 seconds. Manually tested the DEB on Ubuntu 18.04

Documentation: N/A

Edit: Updating path.
Edit 2: Including #3143 as its dependent on the config being present

[codecov]

Codecov Report

Merging #3123 (2a98f6c) into main (81dc441) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3123      +/-   ##
==========================================
+ Coverage   91.59%   91.61%   +0.01%     
==========================================
  Files         486      486              
  Lines       23519    23519              
==========================================
+ Hits        21543    21546       +3     
+ Misses       1466     1464       -2     
+ Partials      510      509       -1     

Flag	Coverage Δ
integration	63.35% <ø> (ø)
unit	90.61% <ø> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
internal/stanza/receiver.go	100.00% <0.00%> (+5.88%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 81dc441...2a98f6c. Read the comment docs.

[pranavmarla]

@Jammicus Thanks for looking into this!

Quick question: Since this is the contrib collector, should the config be located at:
/etc/otel-collector/config.yaml
OR
/etc/otel-contrib-collector/config.yaml?

---

Update: Just confirmed by looking at the agent error message in my issue (#3097) -- when the agent fails due to a missing config file, the error message specifically mentions that it's looking for the config file in /etc/otel-contrib-collector/config.yaml. Since it seems to be looking there by default, I assume that's where the default config file should be located.

[Jammicus]

@Jammicus Thanks for looking into this!

Quick question: Since this is the contrib collector, should the config be located at:
/etc/otel-collector/config.yaml
OR
/etc/otel-contrib-collector/config.yaml?

Update: Just confirmed by looking at the agent error message in my issue (#3097) -- when the agent fails due to a missing config file, the error message specifically mentions that it's looking for the config file in /etc/otel-contrib-collector/config.yaml. Since it seems to be looking there by default, I assume that's where the default config file should be located.

Oooh good spot! Will update

[Jammicus]

Looking at the failing tests, its failing due to a test which explicitly checks that the collector does not start without config:

# test install without config, service should not be running
echo
$docker_run
install_pkg $container_name "$PKG_PATH"
sleep 5
echo "Checking $SERVICE_NAME service status after install without config ..."
if $docker_exec systemctl --no-pager status $SERVICE_NAME; then
    echo "$SERVICE_NAME service is running when it should not" >&2
    exit 1
fi
echo "$SERVICE_NAME service is correctly not running"

Looking at the file this seems to have been added when it was initially created. Will need some guidance from the contributors as to whether this is intentional and the collector should not be shipped with default config or can be removed (Happy to update/close this depending on your guidance)

[pranavmarla]

Thanks again @Jammicus !

Q: I've seen the use of OTELCONTRIBCOL in other places, so not sure what the appropriate contrib naming scheme is for this variable -- should it be OTELCOL_OPTIONS or OTELCONTRIBCOL_OPTIONS?

Also, minor edit: In the comment on line 3, otel-collector should be otel-contrib-collector

[Jammicus]

Thanks, updated line 3.

Not sure on the naming conventions - approvers can give us some guidance when they have time to review this

[anuraaga]

I think there's value in keeping the environment variables symmetrical between contrib and non-contrib, they're mostly just different versions of the same thing so more swappability is nice

[jchengsfx]

IMO, I would use OTELCONTRIBCOL_OPTIONS just to be consistent with the otelcontribcol binary name.

[bogdandrutu]

@jchengsfx can you review?

[anuraaga]

I think there's value in keeping the environment variables symmetrical between contrib and non-contrib, they're mostly just different versions of the same thing so more swappability is nice

[bogdandrutu]

@jchengsfx please approve if everything looks good