[receiver/sqlserver] Add collection interval for top query #40002
Conversation
github-actions
bot
added
receiver/sqlserver
Run Windows
|
This PR should not be part of |
| - This value can only guarantee that the top queries are collected at most once in this interval. | ||
| - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `60s`. | ||
| - In this case, the default receiver scraper will still try to run in every 10 seconds. | ||
| - However, the top queries collection will only run after 60 seconds have passed since the last collection. | ||
| - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `5s`. | ||
| - In this case, `top_query_collection.collection_internal` will make no effects to the collection |
There was a problem hiding this comment.
This feels like it should be moved out from the attribute definitions, and into its own section that can explain it in more detail.
There was a problem hiding this comment.
This document is specifically intended for configurations, so it seems appropriate to include it here?
There was a problem hiding this comment.
As a user who is new to the component, this is a lot of context provided as dot points. To help give a deeper background and context, it should be moved to its own section and expanded upon in a paragraph so examples can also be given.
There was a problem hiding this comment.
I wouldn't call this a blocking action, but as a user it would be nice to provide that extra context in a more naturally written form.
crobert-1
added
ready to merge
|
I'll wait on |
| - This value can only guarantee that the top queries are collected at most once in this interval. | ||
| - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `60s`. | ||
| - In this case, the default receiver scraper will still try to run in every 10 seconds. | ||
| - However, the top queries collection will only run after 60 seconds have passed since the last collection. | ||
| - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `5s`. | ||
| - In this case, `top_query_collection.collection_internal` will make no effects to the collection |
There was a problem hiding this comment.
I wouldn't call this a blocking action, but as a user it would be nice to provide that extra context in a more naturally written form.
…metry#40002) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR added `collection_interval` for top query to make the collection not too frequent: - This value must be a string readable by Golang's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration). - This value can only guarantee that the top queries are collected at most once in this interval. - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `60s`. - In this case, the default receiver scraper will still try to run in every 10 seconds. - However, the top queries collection will only run after 60 seconds have passed since the last collection. - For instance, you have global `collection_interval` as `10s` and `top_query_collection.collection_interval` as `5s`. - In this case, `top_query_collection.collection_internal` will make no effects to the collection <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> #### Link to tracking issue n/a <!--Describe what testing was performed and which tests were added.--> #### Testing Updated <!--Describe the documentation added.--> #### Documentation Updated <!--Please delete paragraphs that you did not use before submitting.--> --------- Co-authored-by: Curtis Robert <[email protected]>
Description
This PR added
collection_intervalfor top query to make the collection not too frequent:collection_intervalas10sandtop_query_collection.collection_intervalas60s.collection_intervalas10sandtop_query_collection.collection_intervalas5s.top_query_collection.collection_internalwill make no effects to the collectionLink to tracking issue
n/a
Testing
Updated
Documentation
Updated