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

refactor(core)!: move telemetry into internal folder #6763

Merged
merged 5 commits into from
Jul 9, 2024

Conversation

DimitrisJim
Copy link
Contributor

@DimitrisJim DimitrisJim commented Jul 4, 2024

Description

Additionally, move the metric.go files from types/ into a metrics package to handle import cycles. This can contain all labels for the core module.

closes: #6425


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Also nice cleanup!

ibcmetrics "github.com/cosmos/ibc-go/v8/modules/core/metrics"
)

func ReportCreateClient(clientType string) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add doc strings to all these public functions?

Copy link
Contributor

Choose a reason for hiding this comment

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

That might be nice. In case someone is wondering if they should use them or not, a bit of explanation on how and when they are supposed to be used.

Potentially a small text or readme even on how we use telemetry?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

mentioned in other PR that completely indifferent to docu strings considering they are internal use only. A small description on telemetry usage would be nice though I am still not entirely sure who consumes these atm.

@crodriguezvega crodriguezvega added the priority PRs that need prompt reviews label Jul 8, 2024
Copy link
Contributor

@gjermundgaraba gjermundgaraba left a comment

Choose a reason for hiding this comment

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

This is a great cleanup :) Love stuff like this!

Copy link

sonarcloud bot commented Jul 9, 2024

@crodriguezvega crodriguezvega added this pull request to the merge queue Jul 9, 2024
Merged via the queue into main with commit ecbf479 Jul 9, 2024
78 of 79 checks passed
@crodriguezvega crodriguezvega deleted the jim/internal-telemetry-core branch July 9, 2024 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority PRs that need prompt reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move telemetry functionality for core in a separate file
4 participants