[chore][receiver/sqlquery] Move reusable logic to internal package #30709
Conversation
This file contains 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
github-actions
bot
added
cmd/configschema
github-actions
bot
requested review from
Aneurysm9,
bertysentry,
dashpole,
dehaansa,
djaglowski,
dmitryax,
jpkrohling,
mar4uk,
mx-psi,
mxiamxia and
pmcollins
github-actions
bot
requested review from
povilasv,
pxaws,
rmfitzpatrick and
TylerHelmuth
crobert-1
commented
Jan 22, 2024
dmitryax
reviewed
Jan 23, 2024
crobert-1
force-pushed
the
sqlquery_package
branch
from
05638e7
to
81a0bc9
Compare
|
@crobert-1 can you please rebase and check CI failures? |
crobert-1
force-pushed
the
sqlquery_package
branch
from
81a0bc9
to
4c1e578
Compare
Done. I've filed #30836 for the failing test, it was unrelated to these changes. |
- Add myself as code owner to new package - Remove unrelated godep updates - Remove unnecessary Validate() call
crobert-1
force-pushed
the
sqlquery_package
branch
from
94a987d
to
b3f96a3
Compare
dmitryax
approved these changes
Feb 2, 2024
dmitryax
reviewed
Feb 2, 2024
| Queries []Query `mapstructure:"queries"` | ||
| StorageID *component.ID `mapstructure:"storage"` | ||
| Telemetry TelemetryConfig `mapstructure:"telemetry"` | ||
| sqlquery.Config `mapstructure:",squash"` | ||
| } | ||
|
|
||
| func (c Config) Validate() error { |
There was a problem hiding this comment.
This function is redundant now. feel free to remove in a follow-up PR
dmitryax
pushed a commit
that referenced
this pull request
Feb 5, 2024
**Description:** [Requested change by Dmitrii](#30709 (comment)), this function was redundant as the underlying config has a `Validate` function called automatically.
anthoai97
pushed a commit
to anthoai97/opentelemetry-collector-contrib
that referenced
this pull request
Feb 12, 2024
…pen-telemetry#30709) **Description:** As noted in the related issues, a lot of the logic in the sqlquery receiver can be moved to a central package to be used by other receivers. I realize this appears to be a large change, but it's purely a re-organization PR, there's no functional changes. GitHub is not recognizing moved files, so please refer to new file names and their deleted counterparts. A lot of members are now public in the internal package that were private in the receiver which is likely what's causing GitHub to miss that they're just moved files. This doesn't require a changelog (in my mind) because all things moving were originally private to the receiver. They're now still purely internal, so they won't be published. I believe `internal` is the best destination for now as it allows us to solidify the usage and interface before moving it to `pkg` to be publicly available. There are still a lot of unknowns as far as how it can be used by other receivers, so I fully expect "breaking changes" to this. If we keep it internal we can update all usages with the changing interface, so the changes won't be breaking. **Link to tracking Issue:** open-telemetry#30297, open-telemetry#13546
anthoai97
pushed a commit
to anthoai97/opentelemetry-collector-contrib
that referenced
this pull request
Feb 12, 2024
…elemetry#31042) **Description:** [Requested change by Dmitrii](open-telemetry#30709 (comment)), this function was redundant as the underlying config has a `Validate` function called automatically.
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:
As noted in the related issues, a lot of the logic in the sqlquery receiver can be moved to a central package to be used by other receivers. I realize this appears to be a large change, but it's purely a re-organization PR, there's no functional changes. GitHub is not recognizing moved files, so please refer to new file names and their deleted counterparts. A lot of members are now public in the internal package that were private in the receiver which is likely what's causing GitHub to miss that they're just moved files.
This doesn't require a changelog (in my mind) because all things moving were originally private to the receiver. They're now still purely internal, so they won't be published.
I believe
internalis the best destination for now as it allows us to solidify the usage and interface before moving it topkgto be publicly available. There are still a lot of unknowns as far as how it can be used by other receivers, so I fully expect "breaking changes" to this. If we keep it internal we can update all usages with the changing interface, so the changes won't be breaking.Link to tracking Issue:
#30297, #13546
Testing:
Existing tests are all passing.
Documentation:
This is purely an internal change.