database_observability: make collectors configurable #2530
+206
−33
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
fridgepoet
requested review from
cristiangreco,
matthewnolf and
a team
as code owners
|
💻 Deploy preview available: https://deploy-preview-alloy-2530-zb444pucvq-vp.a.run.app/docs/alloy/latest/ |
fridgepoet
commented
Jan 29, 2025
| `forward_to` | `list(LogsReceiver)` | Where to forward log entries after processing. | | yes | ||
| `collect_interval` | `duration` | How frequently to collect information from database. | `"10s"` | no | ||
| `query_samples_enabled` | `bool` | Whether to enable collection of query samples. | `true` | no | ||
| Name | Type | Description | Default | Required |
There was a problem hiding this comment.
Neat preview feature. See changes here https://deploy-preview-alloy-2530-zb444pucvq-vp.a.run.app/docs/alloy/latest/reference/components/database_observability/database_observability.mysql/
fridgepoet
changed the title
cristiangreco
approved these changes
Jan 29, 2025
mattdurham
approved these changes
Jan 29, 2025
Comment on lines
+33
to
+49
|
|
||
| [collectors]: #supported-collectors | ||
|
|
||
| ## Blocks | ||
|
|
||
| The `database_observability.mysql` component doesn't support any blocks. You can configure this component with arguments. | ||
|
|
||
| ### Supported Collectors | ||
|
|
||
| The full list of supported collectors is: | ||
|
|
||
| | Name | Description | Enabled by default | | ||
| |--------------|-------------------------------------------------------|--------------------| | ||
| | query_sample | Collect query samples. | yes | | ||
| | schema_table | Collect schemas and tables from `information_schema`. | yes | | ||
|
|
||
|
|
There was a problem hiding this comment.
Suggested change
| [collectors]: #supported-collectors | |
| ## Blocks | |
| The `database_observability.mysql` component doesn't support any blocks. You can configure this component with arguments. | |
| ### Supported Collectors | |
| The full list of supported collectors is: | |
| | Name | Description | Enabled by default | | |
| |--------------|-------------------------------------------------------|--------------------| | |
| | query_sample | Collect query samples. | yes | | |
| | schema_table | Collect schemas and tables from `information_schema`. | yes | | |
| The following collectors are enabled by default: | |
| * `query_sample`: Collect query samples. | |
| * `schema_table`: Collect schemas and tables from `information_schema`. | |
| [collectors]: #supported-collectors | |
| ## Blocks | |
| The `database_observability.mysql` component doesn't support any blocks. You can configure this component with arguments. | |
This info is probably better as a bullet list, and should be below the Args table, not a child of Blocks.
There was a problem hiding this comment.
Thanks for reviewing, @clayton-cornell! I agree it was a mistake to have it as a child of Blocks.
I was trying to model the page a little bit like the mysql exporter in prometheus here.
What do you think about the following:
- keeping it as a table to match the mysql exporter docs and because we will add more collectors in the future.
- Supported Collectors' is correctly moved to a child of Args
Anyway just thought I'd mention what we were modeling after, let me know what you prefer!
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.
PR Description
This enables users to select which components they want to run in the database observability component, similar to how mysqld_exporter works.
Which issue(s) this PR fixes
Fixes https://github.com/grafana/grafana-dbo11y-app/issues/370
Notes to the Reviewer
PR Checklist