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

docs: fix dbStats example in contrib/database/sql #2669

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Conversation

mtoffl01
Copy link
Contributor

What does this PR do?

The WithDBStats example on the contrib/database/sql go docs is inaccurate: https://pkg.go.dev/gopkg.in/DataDog/dd-trace-go.v1@v1.63.0/contrib/database/sql#example-package-DbStats
It's missing WithDBStats in the register function call. This PR updates the code snippet to an accurate example

Motivation

Clarity and usability for the feature

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • System-Tests covering this feature have been added and enabled with the va.b.c-dev version tag.
  • There is a benchmark for any new code, or changes to existing code.
  • If this interacts with the agent in a new way, a system test has been added.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild.

Unsure? Have a question? Request a review!

@mtoffl01 mtoffl01 requested a review from a team as a code owner April 24, 2024 09:39
@github-actions github-actions bot added the apm:ecosystem contrib/* related feature requests or bugs label Apr 24, 2024
@pr-commenter
Copy link

pr-commenter bot commented Apr 24, 2024

Benchmarks

Benchmark execution time: 2024-04-24 09:52:18

Comparing candidate commit 61c50fc in PR branch mtoff/dbstats-docs with baseline commit c4f2942 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 43 metrics, 1 unstable metrics.

@mtoffl01 mtoffl01 merged commit 47fe650 into main Apr 25, 2024
158 of 159 checks passed
@mtoffl01 mtoffl01 deleted the mtoff/dbstats-docs branch April 25, 2024 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:ecosystem contrib/* related feature requests or bugs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants