Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CLI] Add 'source' metadata for metrics collected #1225

Closed
peter-rr opened this issue Mar 12, 2024 · 2 comments · Fixed by #1304
Closed

[CLI] Add 'source' metadata for metrics collected #1225

peter-rr opened this issue Mar 12, 2024 · 2 comments · Fixed by #1304
Labels
enhancement New feature or request released

Comments

@peter-rr
Copy link
Member

peter-rr commented Mar 12, 2024

Why do we need this improvement?

We need to include source metadata as a unique identifier for every file handled in CLI when collecting metrics for the commands executed.

How will this change help?

This change will allow us to measure the Time to first API Design metric as described here.

How could it be implemented/designed?

We need to consider two different issues we've found so far:

  • The hashing algorithm to use: We should make a decision based on computational cost and security aspects according to New Relic requirements and also the recommendations from SonarCloud. Some research about algorithms like md5, sha1 or sha256 is needed.
  • Find another way to calculate the Time to first API Design metric, or a different way to identify the source so it doesn't change between file creation and generation. See feat: add POC for measuring adoption #859 (comment)

Related issue(s)

Relates to #1161

@peter-rr peter-rr added the enhancement New feature or request label Mar 12, 2024
@KhudaDad414
Copy link
Member

I have opened a PR that addresses this issue. it will collect the birth timestamp of the file that cli works on. IMO it solves the issue provides the best value and more insight into the file.

@github-project-automation github-project-automation bot moved this to Backlog in CLI - Kanban Apr 24, 2024
@peter-rr peter-rr moved this from Backlog to In progress in CLI - Kanban May 2, 2024
@peter-rr peter-rr moved this from In progress to In review in CLI - Kanban May 2, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in CLI - Kanban May 14, 2024
@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 1.13.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants