Skip to content

[microsoft_sqlserver] Add OTel assets - #17730

Merged
muthu-mps merged 13 commits into
elastic:mainfrom
devamanv:add_mssql_otel_assets
Apr 8, 2026
Merged

[microsoft_sqlserver] Add OTel assets#17730
muthu-mps merged 13 commits into
elastic:mainfrom
devamanv:add_mssql_otel_assets

Conversation

@devamanv

@devamanv devamanv commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Proposed commit message

The PR adds Kibana assets for monitoring Microsoft SQL Server via the OpenTelemetry sqlserverreceiver.

What's included

5 Dashboards: Overview, Memory & Saturation, Concurrency & Errors, Database I/O, and Query Performance

14 Alert rule templates: Covering deadlocks, blocked processes, buffer cache, page life expectancy, memory grants, lock waits/timeouts, execution errors, I/O latency, OS waits, TempDB, and login rate spikes

5 SLO templates: Rolling 30-day 99.5% targets for buffer cache hit ratio, page life expectancy, memory grants pending, blocked processes, and deadlock rate

Documentation with setup instructions for configuring the OTel Collector with the SQL Server receiver and Elasticsearch exporter

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@devamanv
devamanv requested a review from a team as a code owner March 10, 2026 05:38
@devamanv
devamanv requested review from a team and Copilot March 10, 2026 05:39
@devamanv devamanv self-assigned this Mar 10, 2026
@github-actions

github-actions Bot commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 2 suggestions found

💡 Suggestions (2)
File Line Rule Message
packages/microsoft_sqlserver_otel/docs/README.md 26 Elastic.Semicolons Use semicolons judiciously.
packages/microsoft_sqlserver_otel/docs/README.md 103 Elastic.WordChoice Consider using 'select, press, visits' instead of 'Hit', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces two new OpenTelemetry asset packages for the Elastic integrations repository: microsoft_sqlserver_otel for SQL Server monitoring and azure_activity_otel for Azure Activity Logs. The SQL Server package is comprehensive, including 5 dashboards, 13 alerting rule templates, 5 SLO templates, and detailed documentation. The Azure package is smaller, containing dashboards and basic documentation.

Changes:

  • New microsoft_sqlserver_otel package with dashboards (Overview, Memory & Saturation, Concurrency & Errors, Database I/O, Query Performance), SLO templates, alerting rule templates, and setup documentation covering the OTel SQL Server receiver.
  • New azure_activity_otel package with a dashboard for Azure Activity Log alerts collected via OpenTelemetry.
  • Supporting assets including SVG logos, screenshot images, _dev/shared YAML dashboard specs, changelog, license, and validation files for both packages.

Reviewed changes

Copilot reviewed 42 out of 50 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
packages/microsoft_sqlserver_otel/manifest.yml Package manifest defining metadata, discovery, screenshots, and owner for the SQL Server OTel assets
packages/microsoft_sqlserver_otel/changelog.yml Initial changelog entry (v0.1.0)
packages/microsoft_sqlserver_otel/validation.yml Validation config excluding SVR00002 check
packages/microsoft_sqlserver_otel/docs/README.md Comprehensive documentation with setup, dashboard descriptions, alert rules, and SLO templates
packages/microsoft_sqlserver_otel/kibana/dashboard/*.json Five Kibana dashboard JSON definitions using ES
packages/microsoft_sqlserver_otel/kibana/slo_template/*.json Five SLO templates (buffer cache, PLE, memory grants, blocked processes, deadlocks)
packages/microsoft_sqlserver_otel/kibana/alerting_rule_template/*.json Thirteen alerting rule templates for various SQL Server health conditions
packages/microsoft_sqlserver_otel/_dev/shared/*.yaml Human-readable YAML dashboard specifications for all five dashboards
packages/microsoft_sqlserver_otel/img/* Logo SVG and dashboard screenshots
packages/microsoft_sqlserver_otel/LICENSE.txt Elastic License 2.0
packages/azure_activity_otel/manifest.yml Package manifest for Azure Activity Logs OTel assets
packages/azure_activity_otel/changelog.yml Initial changelog with placeholder PR link
packages/azure_activity_otel/kibana/dashboard/*.json Azure Activity Logs alert overview dashboard
packages/azure_activity_otel/docs/README.md Documentation with ECF and standalone collector setup
packages/azure_activity_otel/img/* Icon SVG for Azure Activity
packages/azure_activity_otel/LICENSE.txt Elastic License 2.0

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/azure_activity_otel/manifest.yml Outdated
Comment thread packages/azure_activity_otel/manifest.yml Outdated
Comment thread packages/azure_activity_otel/manifest.yml Outdated
Comment thread packages/azure_activity_otel/changelog.yml Outdated
Comment thread packages/microsoft_sqlserver_otel/manifest.yml
Comment thread packages/microsoft_sqlserver_otel/manifest.yml
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Build: https://buildkite.com/elastic/integrations/builds/39356

What failed: Buildkite job :white_check_mark: Check go sources failed in .buildkite/scripts/check_sources.sh.

Error:

Key log excerpt
Running dependency: github.com/elastic/integrations/dev/codeowners.Check
Error: error validating packages in directory 'packages': error checking manifest 'packages/azure_activity_otel/manifest.yml': there is no owner for "packages/azure_activity_otel" in ".github/CODEOWNERS"

Root cause: This PR adds a new package at packages/azure_activity_otel/... (including packages/azure_activity_otel/manifest.yml) but the CODEOWNERS update only adds /packages/microsoft_sqlserver_otel in .github/CODEOWNERS (hunk around line ~344 in this PR). There is no /packages/azure_activity_otel entry, so dev/codeowners.Check fails.

Recommended fix: Add a CODEOWNERS entry for the new package, e.g. in .github/CODEOWNERS near other Azure package entries:

/packages/azure_activity_otel @(owning-team)

Use the same owner team used for related Azure observability packages in this repo.

Verification: Confirmed from Buildkite failed job logs for build #39356 and PR file list (.github/CODEOWNERS patch + added packages/azure_activity_otel/* files).


What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@devamanv
devamanv force-pushed the add_mssql_otel_assets branch from d42d0bb to 9273083 Compare March 11, 2026 08:21
Comment thread packages/microsoft_sqlserver_otel/manifest.yml
Comment thread packages/microsoft_sqlserver_otel/manifest.yml
Comment thread packages/microsoft_sqlserver_otel/manifest.yml Outdated
@devamanv
devamanv requested a review from ishleenk17 March 12, 2026 12:40
@devamanv devamanv added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. dashboard Relates to a Kibana dashboard bug, enhancement, or modification. Integration:microsoft_sqlserver_otel Microsoft SQL Server Assets Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Mar 12, 2026
Comment thread packages/microsoft_sqlserver_otel/manifest.yml Outdated
@devamanv
devamanv requested a review from ishleenk17 March 13, 2026 12:00
Comment thread packages/microsoft_sqlserver_otel/manifest.yml Outdated
@andrewkroh andrewkroh added the New Integration Issue or pull request for creating a new integration package. label Mar 15, 2026
@ishleenk17

ishleenk17 commented Mar 16, 2026

Copy link
Copy Markdown
Member

@devamanv Please address below dashboard specific feedback:

Y axis of compilation vs recompilation (Concurrency dashboard)
Page file expectancy Y axis title
Login vs Logout Y axis
Deadlocks and blocked pressure over time Y axis

@strawgate

Copy link
Copy Markdown
Contributor

I ran kb-dashboard 0.4.0 upgrade validation on this PR in an isolated worktree.

Results

  • packages/microsoft_sqlserver_otel/_dev/shared
    • upgrade --fail-on-change exit: 5
    • upgrade --write exit: 0
    • post-upgrade compile --format elastic-integrations exit: 0

Upgrade and post-upgrade compile succeeded with 0.4.0.
Please apply these commands in your branch and commit both YAML + regenerated JSON artifacts.

Suggested commands:

uvx --from kb-dashboard-cli==0.4.0 kb-dashboard upgrade --input-dir packages/microsoft_sqlserver_otel/_dev/shared --write
uvx --from kb-dashboard-cli==0.4.0 kb-dashboard compile --input-dir packages/microsoft_sqlserver_otel/_dev/shared --output-dir packages/microsoft_sqlserver_otel/kibana/dashboard --format elastic-integrations
@devamanv

Copy link
Copy Markdown
Contributor Author

Updates:

  • Compiled the dashboards with 0.4.0 and regenerated the JSON artifacts. The dashboards are now up-to-date
  • Fixed the y-axis labels and title for panels to make them consistent across all the dashboards.

@ishleenk17 could you please take a look once more?

@devamanv
devamanv requested a review from ishleenk17 March 20, 2026 11:10

@mykola-elastic mykola-elastic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've got a bit confused by few things (in comments). Can you please clarify?

Comment thread packages/microsoft_sqlserver_otel/img/overview.png
Comment thread packages/microsoft_sqlserver_otel/img/concurrency-errors.png

@mykola-elastic mykola-elastic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, Please update screenshots to match the dashboard changes

Comment thread packages/microsoft_sqlserver_otel/manifest.yml
| **[SQL Server OTel] Login rate spike** | Login rate above 50/s (connection storm) | Warning |

## SLO templates

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add SLO stack version dependency note.

@muthu-mps

Copy link
Copy Markdown
Contributor

/test

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

@muthu-mps
muthu-mps merged commit 47e83e6 into elastic:main Apr 8, 2026
12 checks passed
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package microsoft_sqlserver_otel - 0.1.0 containing this change is available at https://epr.elastic.co/package/microsoft_sqlserver_otel/0.1.0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dashboard Relates to a Kibana dashboard bug, enhancement, or modification. documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:microsoft_sqlserver_otel Microsoft SQL Server Assets New Integration Issue or pull request for creating a new integration package. Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

8 participants