SQLServer XE handlers documentation #29291
Conversation
Datadog Summary✅ Code Quality ✅ Code Security ✅ Dependencies Was this helpful? Give us feedback! |
Preview links (active after the
|
azhou-datadog
changed the title
|
Hi @azhou-datadog, I see this is labeled as a WIP. I went ahead and added the |
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
azhou-datadog
changed the title
azhou-datadog
force-pushed
the
allen.zhou/sqlserver_xe
branch
from
1bfd49c to
8247c4d
Compare
|
Created DOCS-11255 for docs review. |
| GO | ||
| ``` | ||
|
|
||
| The datadog_query_errors XE session captures SQL errors (severity ≥ 11) and query timeouts (attention events), allowing Datadog to surface query failures and interruptions. |
There was a problem hiding this comment.
Are there any docs for severity >= 11?
There was a problem hiding this comment.
Also what are attention events?
There was a problem hiding this comment.
| query_errors: | ||
| enabled: true | ||
| ``` | ||
| In order to collect deobfuscated versions of query_completion and query_error events, enable collect_raw_query_statement in `sqlserver.d/conf.yaml`. |
There was a problem hiding this comment.
We should probably add this disclaimer that we include above the param in sample conf file here the docs as well: https://github.com/DataDog/integrations-core/blob/master/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example#L659
" ## Raw query statements and execution plans may contain sensitive information (e.g., passwords)
## or personally identifiable information in query text.
## Enabling this option will allow the collection and ingestion of raw query statements and
## execution plans into Datadog, which can then become viewable in query samples or explain plans.
## This option is disabled by default."
Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
What does this PR do? What is the motivation?
Adds documentation to support DataDog/integrations-core#20229
Provides instructions on how to configure SQLServer extended event (XE) sessions to capture query errors and query completions.
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes