✨Add simcore_user_agent and product_name to user service labels

[GitHK]

What do these changes do?

Extends the user services with new labels: simcore_user_agent and product_name.

Note simcore_user_agent will be empty or have the value puppeteer as seen below:

osparc-simcore/tests/e2e/tutorials/tutorialBase.js

Line 59 in f0fdf2c

"X-Simcore-User-Agent": "puppeteer"

Related issue/s

• E2E: complete implementation of test to check if all dy-sidecar created services were properly removed after testing #3588
• basic monitoring functionality osparc-issues#881

How to test

Checklist

• Unit tests for the changes exist
• Runs in the swarm

[codecov]

Codecov Report

Merging #3990 (f91eefc) into master (bb2b726) will decrease coverage by 0.1%.
The diff coverage is 100.0%.

@@           Coverage Diff            @@
##           master   #3990     +/-   ##
========================================
- Coverage    85.2%   85.2%   -0.1%     
========================================
  Files         858     874     +16     
  Lines       38061   39496   +1435     
  Branches      539     729    +190     
========================================
+ Hits        32446   33660   +1214     
- Misses       5490    5641    +151     
- Partials      125     195     +70     

Flag	Coverage Δ
integrationtests	61.9% <60.0%> (-4.2%)	⬇️
unittests	82.7% <100.0%> (+0.3%)	⬆️

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

Impacted Files	Coverage Δ
...service_director_v2/api/routes/dynamic_services.py	89.2% <ø> (ø)
...ector_v2/modules/dynamic_sidecar/scheduler/_abc.py	100.0% <ø> (ø)
...modules/dynamic_sidecar/scheduler/_core/_events.py	62.0% <ø> (-35.2%)	⬇️
...ules/dynamic_sidecar/scheduler/_core/_scheduler.py	76.5% <ø> (-2.2%)	⬇️
...ctor_v2/modules/dynamic_sidecar/scheduler/_task.py	94.1% <ø> (ø)
...ckages/models-library/src/models_library/docker.py	90.0% <100.0%> (+4.8%)	⬆️
...rvice-library/src/servicelib/aiohttp/monitoring.py	72.9% <100.0%> (ø)
...s/service-library/src/servicelib/common_headers.py	100.0% <100.0%> (ø)
...or_v2/models/schemas/dynamic_services/scheduler.py	97.3% <100.0%> (-2.0%)	⬇️
...v2/modules/dynamic_sidecar/docker_compose_specs.py	72.1% <100.0%> (-27.1%)	⬇️
... and 5 more

... and 184 files with indirect coverage changes

[sanderegg]

I would use the very same label that already exists on the metrics:
simcore_user_agent

And also the header you check is the wrong one.

[codeclimate]

Code Climate has analyzed commit f91eefc and detected 0 issues on this pull request.

View more on Code Climate.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.1% Duplication

[elisabettai]

Hi @GitHK, I'm having a look in master if we can filter (dynamic) services started by puppeteers.
Where am I supposed to find the simcore_user_agent?
In Prometheus, I'm looking at metrics such as simcore_simcore_service_director_services_started_total and a typical returned entry is:

simcore_simcore_service_director_services_started_total{deployment="master", instance="10.11.6.159:8080", job="simcore", service_key="simcore/services/dynamic/raw-graphs", service_name="director", service_tag="2.11.2", service_type="DYNAMIC", user_id="undefined_user"}

I don't see any simcore_user_agent there and user_id is always "undefined_user". I was hoping user_id would be what we're looking for and thus being = puppeetteer in this case.
fyi @mrnicegyu11 and @sanderegg

[GitHK]

@elisabettai this applies to dynamic-sidecar powered services. For legacy ones I am not aware if this should already be in place.

[elisabettai]

I see @GitHK, so the simcore_simcore_service_director_services_started_total give the legacy services, I haven't realized that, my bad. Still I find user_id=undefined_user on the director started services is a bit confusing. 😉

So now I'm looking at simcore_simcore_service_webserver_services_started_total on master, one example entry is:
simcore_simcore_service_webserver_services_started_total{deployment="master", instance="10.11.7.175:8080", job="simcore", service_key="simcore/services/dynamic/jupyter-smash", service_name="webserver", service_tag="3.0.7"}

And I don't see any simcore_user_agent. Would you know which metric has that?

[GitHK]

@mrnicegyu11 might be able to answer your question there. I think the is currently dealing with it.

[GitHK]

@elisabettai you should now be able to find the new label (for legacy services) in master as soon as the above PR gets deployed