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

feat: Add Telemetry logic #605

Merged

Conversation

michielmulders
Copy link
Member

Description

This pull request adds telemetry data capture, which is disabled by default.
The documents have been updated to notify people about what we capture and how to enable it if they want to give us data.

Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
Signed-off-by: Michiel Mulders <[email protected]>
@michielmulders michielmulders merged commit 89120a0 into hashgraph:main Feb 14, 2025
16 checks passed
swirlds-automation added a commit that referenced this pull request Feb 14, 2025
## [0.3.0](v0.2.0...v0.3.0) (2025-02-14)

### Features

* Add Telemetry logic ([#605](#605)) ([89120a0](89120a0))
@swirlds-automation
Copy link
Contributor

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link

@bguiz bguiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this block repeated in all of the commands:

        await telemetryUtils.recordCommand(command.join(' '));
      }
      stateUtils.recordCommand(command);```

2 suggestions regarding this:

* a better design pattern might be to shift the invocation of `telemetryUtils.recordCommand` inside of the impl of `stateUtils.recordCommand`
* whether you shift it inside or not, consider whether you want to `await` the invocation of `telemetryUtils.recordCommand` ... does the rest of the command really need to wait for the telemetry to be logged?
    * if no, which I think is the case since this is logging and not executing any "business logic", then you can simply fire and forget.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants