[microsoft_sqlserver] Add OTel assets - #17730
Conversation
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
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. |
There was a problem hiding this comment.
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_otelpackage 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_otelpackage with a dashboard for Azure Activity Log alerts collected via OpenTelemetry. - Supporting assets including SVG logos, screenshot images,
_dev/sharedYAML 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.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Build: https://buildkite.com/elastic/integrations/builds/39356 What failed: Buildkite job Error: Key log excerptRoot cause: This PR adds a new package at Recommended fix: Add a CODEOWNERS entry for the new package, e.g. in Use the same owner team used for related Azure observability packages in this repo. Verification: Confirmed from Buildkite failed job logs for build What is this? | From workflow: PR Buildkite Detective Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
d42d0bb to
9273083
Compare
|
@devamanv Please address below dashboard specific feedback: Y axis of compilation vs recompilation (Concurrency dashboard) |
|
I ran Results
Upgrade and post-upgrade compile succeeded with 0.4.0. 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 |
|
Updates:
@ishleenk17 could you please take a look once more? |
mykola-elastic
left a comment
There was a problem hiding this comment.
I've got a bit confused by few things (in comments). Can you please clarify?
…SE instead of RATE
mykola-elastic
left a comment
There was a problem hiding this comment.
LGTM, Please update screenshots to match the dashboard changes
| | **[SQL Server OTel] Login rate spike** | Login rate above 50/s (connection storm) | Warning | | ||
|
|
||
| ## SLO templates | ||
|
|
There was a problem hiding this comment.
Add SLO stack version dependency note.
|
/test |
💚 Build Succeeded
History
|
|
Package microsoft_sqlserver_otel - 0.1.0 containing this change is available at https://epr.elastic.co/package/microsoft_sqlserver_otel/0.1.0/ |
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
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots