feat: Add telemetry to track chectl command usage

[flacatus]

Signed-off-by: Flavius Lacatusu flacatus@redhat.com

What does this PR do?

This PR introduce to chectl the ability to collect and send to segment commands usage and flags:

• I create hooks which are executed in every command and emit the analytic hook
• Created a segment adapter to send the usage data to segment
• Cli Prompt to ask user if allows chectl to collect anonymous data and send to segment
• Store the user confirmation of usage data into chectl config directory. Is usefull to not ask user in every command if allow chectl to collect data

Refference issue:eclipse-che/che#18069

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

As the author of this Pull Request I made sure that:

• The Eclipse Contributor Agreement is valid
• Code produced is complete
• Code builds without errors
• Tests are covering the bugfix
• The repository devfile is up to date and works
• Sections What issues does this PR fix or reference and How to test this PR completed
• Relevant user documentation updated
• Relevant contributing documentation updated
• CI/CD changes implemented, documented and communicated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

[flacatus]

Some examxple of how the events are tracked in segment:

[flacatus]

Pending to fix the tests with the new changes

[tolusha]

I have two general remarks.

1. I am worried about tracking flags. They might contains some personal user's data like accessToken.
   Does it make sense to track only those flags that we are interested in ? like platform ?

2. We need a general configfile like configuration.json and store segment configuration there.
   @AndrienkoAleksandr @mmorhun WDYT?

[tolusha]

3. What if description is changed, would we have a new event ?

[flacatus]

1. What if description is changed, would we have a new event ?

Yes, if the description change we will have a new event. Also we can put in the event the command name not the command description

[flacatus]

@davidfestal @l0rd We are thinking to add an additional flag for every command in part to use telemetry. The flag can be something like: --telemetry=on/off by default to off... In case if the flag will not be turned on chectl cli will ask user from command line if allow chectl to collect anonymous data and save the prompt confirmation into the chectl cache to not ask for every command. It is necessary from my point of view to add this flag because in our general QE jobs will be hard to interact with chectl... WDYT?
cc @tolusha @rhopp

[mmorhun]

I am worried about tracking flags. They might contains some personal user's data like accessToken.
Does it make sense to track only those flags that we are interested in ? like platform ?

I think it would be better to have a list of flag that we shouldn't track (like tokens, password, etc.), however I don't know about implementation details here.

We need a general configfile like configuration.json and store segment configuration there.

I am definitely +1 here.

What if description is changed, would we have a new event

I think the ID should be the command (e.g. server:deploy) or command + flag (e.g. server:deploy.platform)

[flacatus]

/retest

[openshift-ci-robot]

New changes are detected. LGTM label has been removed.

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: flacatus, tolusha
To complete the pull request process, please assign after the PR has been reviewed.
You can assign the PR to them by writing /assign in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[flacatus]

closing in favor of #1052 after for was broken...