CPP-2702 initial MVP of a metrics client #1152
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ivomurrell
requested review from
a team and
ft-dependency-auto-merger
as code owners
This package allows us to send metrics from Tool Kit invocations to a backend server, currently planned to be an instance of Vector running in AWS. We can use these metrics to get visibility for how people use Tool Kit, and where things may be going wrong. For now, I've only added one metric, which tracks what Tool Kit tasks are run and whether they completed successfully. The telemetry package uses a child process to allow us to send the metrics asynchronously and in the background once the main Tool Kit process exits, meaning there is minimal impact on the time it takes for Tool Kit commands to run on developer machines. Children of the metrics class can be created with arbitrary attributes overridden, and these classes are passed around between functions and stored as fields in Task and Hook classes, allowing important metadata, such as whether we're in CI or the name of the task currently running, to always be included in recorded events and scoped logically.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This package allows us to send metrics from Tool Kit invocations to a backend server, currently planned to be an instance of Vector running in AWS. We can use these metrics to get visibility for how people use Tool Kit, and where things may be going wrong. For now, I've only added one metric, which tracks what Tool Kit tasks are run and whether they completed successfully.
The
telemetrypackage uses a child process to allow us to send the metrics asynchronously and in the background once the main Tool Kit process exits, meaning there is minimal impact on the time it takes for Tool Kit commands to run on developer machines.Children of the metrics class can be created with arbitrary attributes overridden, and these classes are passed around between functions and stored as fields in
TaskandHookclasses, allowing important metadata, such as whether we're in CI or the name of the task currently running, to always be included in recorded events and scoped logically.It doesn't make sense for this to be released yet as the backend server isn't ready but we can either put this in the
devbranch if we manage to get that working or leave this unmerged for now.Checklist:
feat(circleci): add support for nightly workflows,fix: set Heroku app name for staging apps too