feat(metrics): collect the DOCKER_HOST environment variable path

[pendo324]

Which issue(s) does this change fix?

Why is this change necessary?

It allows SAM CLI to have a proxy measurement on which tools users are using as its backend. This allows the SAM CLI team to prioritize testing and features from various tools which users may be using to provide their DOCKER_HOST.

How does it address the issue?

This change collects the last part of URIs/paths, in hope that these last parts shed light on which tool the user is using with SAM CLI. For example, if a user is using a local version of docker, this new metric would collect docker.sock. This is only checking the last part of paths in an effort to not needlessly collect what may be private URLs to remote docker hosts which user's might be using.

What side effects does this change have?

None?

Mandatory Checklist

PRs will only be reviewed after checklist is complete

• [N/A] Add input/output type hints to new functions/methods
• [N/A] Write design document if needed (Do I need to write a design document?)
• [N/A] Write/update unit tests
• [N/A] Write/update integration tests
• [N.A] Write/update functional tests if needed
• make pr passes
• [N/A] make update-reproducible-reqs if dependencies were changed
• [N/A] Write documentation

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[valerena]

Thanks for the contribution! There are a few errors on make pr (and in other tests), if you can take a look.

At least in make pr

samcli/lib/telemetry/metric.py:495: error: Missing positional argument "path" in call to "exists"  [call-arg]
samcli/lib/telemetry/metric.py:497: error: Returning Any from function declared to return "str"  [no-any-return]
samcli/lib/telemetry/metric.py:500: error: Returning Any from function declared to return "str"  [no-any-return]

The first one is because of if os.path.exists(): (I imagine there's a variable missing there, probably parsed.path)

The other ones might be just errors on typing with os.path.basepath 🤔. You might be able to just do str(..) to fix those.

[valerena]

There are some more tests failing on test_installed_metrics.py

I added another comment to confirm the logic.

You can run pytest -vv tests/integration/telemetry to check those. They don't run with the standard make pr because they're integration tests, but they should run quickly (as opposed to other integration tests which could take hours)

[valerena]

Did you mean the opposite here? I imagine that if the schema is empty, then I can check if it's a file that exists, but here you're doing that if it's not empty. If it happens that it's not empty, then we could be calling os.path.exists("unix:///var/run/docker.sock") which returns False.

[pendo324]

You're correct, but honestly I think this logic was a little too overcomplicated anyway. I've simplified and removed the conditional in the latest revision.

The integ tests are also passing on my local machine, just waiting for GitHub CI to trigger

[pendo324]

@valerena, is the failing Windows smoke test related to this change? If so, I'm not sure how and could use some guidance on how to fix it