Skip to content

WIP: SQLServer XE handlers documentation #29291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

azhou-datadog
Copy link
Contributor

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

WIP: This docs update should not be merged until the backend and front end components are complete. Only the integration-core changes are written so far.

Merge readiness:

  • Ready for merge

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:

/merge

Additional notes

@azhou-datadog azhou-datadog requested review from a team as code owners May 12, 2025 18:31
@github-actions github-actions bot added the Guide Content impacting a guide label May 12, 2025
@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented May 12, 2025

Datadog Summary

✅ Code Quality    ✅ Code Security    ✅ Dependencies


Was this helpful? Give us feedback!

@azhou-datadog azhou-datadog changed the title SQLServer XE handlers documentation WIP: SQLServer XE handlers documentation May 12, 2025
@jhgilbert jhgilbert added the WORK IN PROGRESS No review needed, it's a wip ;) label May 12, 2025
@jhgilbert
Copy link
Contributor

Hi @azhou-datadog, I see this is labeled as a WIP. I went ahead and added the work-in-progress label to keep this out of the docs team's review queue. If this is incorrect, feel free to update the PR title and remove the label. Thank you!

Copy link
Contributor

@pierreln-dd pierreln-dd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some comments

);
GO

-- 2. Errors and Attentions (grouped)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to split the 2 sessions into 2 separate code blocks? Or at least mentioning the 2 different session types outside the code block (since they are mentioned on line 190)

**Performance Considerations**
- Extended Events are designed to be lightweight but still have some overhead
- If you observe performance issues, consider:
- Increasing duration thresholds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think linking back up the page to how to do this would be good

- Extended Events are designed to be lightweight but still have some overhead
- If you observe performance issues, consider:
- Increasing duration thresholds
- Adding more specific filters
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similar to my previous comment

- If you observe performance issues, consider:
- Increasing duration thresholds
- Adding more specific filters
- Disabling one or both sessions during peak load periods
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

naming the sessions or being able to explicit how to would be great IMO

);
GO

-- 2. Errors and Attentions (grouped)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as for the default SQL Server (if splitting makes sense)


## Exploring deobfuscated queries

Workflow is still a work in progress.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this expected to be released with this? Or will the docs be updated to reflect the actual workflow? Because if the workflow is indeed a WIP by the time the docs are released, I think we need a different way to phrase this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

definitely not releasing with this, this is more of a TODO for myself :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guide Content impacting a guide WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants