database_observability: update docs to reflect latest changes in README #4672
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
|
💻 Deploy preview available (database_observability: update docs to reflect latest changes in README): |
cristiangreco
force-pushed
the
cristian/dbo11y-update-docs-from-readme
branch
from
a77729b to
5e8eaf7
Compare
cristiangreco
requested review from
a team and
clayton-cornell
as code owners
cristiangreco
force-pushed
the
cristian/dbo11y-update-docs-from-readme
branch
2 times, most recently
from
91edbec to
900cf03
Compare
- update docs with fully working example config - make `targets` mandatory
cristiangreco
force-pushed
the
cristian/dbo11y-update-docs-from-readme
branch
from
900cf03 to
3223443
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the database observability components to make the targets parameter mandatory and updates all documentation and tests to reflect this change.
Key Changes
- Made
targetsattribute mandatory by removingoptionaltag from component definitions - Added
targets = []to all test configurations to comply with the new requirement - Updated documentation with complete, working example configurations
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
internal/component/database_observability/postgres/component.go |
Removed optional tag from Targets field to make it mandatory |
internal/component/database_observability/postgres/component_test.go |
Added targets = [] to all test configuration strings and removed t.Parallel() calls from two tests |
internal/component/database_observability/mysql/component.go |
Removed optional tag from Targets field to make it mandatory |
internal/component/database_observability/mysql/component_test.go |
Added targets = [] to all test configuration strings, renamed test function, and removed t.Parallel() calls from three tests |
internal/component/database_observability/README.md |
Updated example configuration to remove unnecessary collector and fix targets reference |
docs/sources/reference/components/database_observability/database_observability.postgres.md |
Expanded example with complete working configuration including all required components |
docs/sources/reference/components/database_observability/database_observability.mysql.md |
Expanded example with complete working configuration including all required components |
| } | ||
| discovery.relabel "orders_db" { | ||
| targets = database_observability.mysql.orders_db.targets |
There was a problem hiding this comment.
Incorrect component reference: should be database_observability.postgres.orders_db.targets instead of database_observability.mysql.orders_db.targets since this is in the postgres documentation.
Suggested change
| targets = database_observability.mysql.orders_db.targets | |
| targets = database_observability.postgres.orders_db.targets |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
PR Description
targetsmandatoryWhich issue(s) this PR fixes
n.a.
Notes to the Reviewer
PR Checklist