Skip to content

[microsoft_sqlserver] Add performance DataStream - #3391

Merged
ManojS-shetty merged 73 commits into
elastic:mainfrom
ManojS-shetty:mssql-generic-datastream-v1
Jun 14, 2022
Merged

[microsoft_sqlserver] Add performance DataStream#3391
ManojS-shetty merged 73 commits into
elastic:mainfrom
ManojS-shetty:mssql-generic-datastream-v1

Conversation

@ManojS-shetty

@ManojS-shetty ManojS-shetty commented May 19, 2022

Copy link
Copy Markdown
Contributor

What does this PR do?

This PR contributes the performance data stream for Microsoft sqlserver which fetches information from what’s commonly known as Performance Counters in MSSQL. Please refer for transaction_log data stream PR here transaction_log

MSSQL server integration developed using generic sql, as per the design doc

  • Added a data stream (performance) under microsoft_sqlserver integration package
  • Added data collection logic for the data streams.
  • Added Fields metadata in the appropriate yaml files.
  • Added dashboards and visualizations.
  • Added System Testing.
  • No Documentation added.

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.

How to test this PR locally

  • Install the MSSQL
  • Go to Integration UI in Kibana
  • Add the Microsoft SQL Server Integration
  • Enroll the new elastic-agent
  • In the asset -> Performance dashboard you should be able to see the default visualization.

Screenshots

sqlserver-perf-dashboard

@ManojS-shetty ManojS-shetty added enhancement New feature or request Team:Integrations Label for the Integrations team labels May 19, 2022
@ManojS-shetty
ManojS-shetty requested a review from a team May 19, 2022 16:07
@ManojS-shetty ManojS-shetty self-assigned this May 19, 2022
@elasticmachine

elasticmachine commented May 19, 2022

Copy link
Copy Markdown

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-14T05:22:46.315+0000

  • Duration: 14 min 24 sec

Test stats 🧪

Test Results
Failed 0
Passed 8
Skipped 0
Total 8

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.
@ManojS-shetty

ManojS-shetty commented Jun 3, 2022

Copy link
Copy Markdown
Contributor Author

Lets make sure we always use vis by value: #3448

Done . Visualizations are now using by value.

@andrewkroh andrewkroh added the Integration:microsoft_sqlserver Microsoft SQL Server label Jun 3, 2022

@jsoriano jsoriano 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.

Added some comments about fields definitions.

Comment thread packages/microsoft_sqlserver/_dev/build/build.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/base-fields.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/fields.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/fields.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/fields.yml Outdated
@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

Comment thread packages/microsoft_sqlserver/manifest.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/manifest.yml
@lalit-satapathy

Copy link
Copy Markdown
Contributor

@ManojS-shetty @muthu-mps,
Do we have any changes pending or all the feedbacks are resolved now?

@ruflin @jsoriano @r00tu53r, tar-getting the merge of this PR, need your approval for the same.

@ManojS-shetty

Copy link
Copy Markdown
Contributor Author

@ManojS-shetty @muthu-mps, Do we have any changes pending or all the feedbacks are resolved now?

@ruflin @jsoriano @r00tu53r, tar-getting the merge of this PR, need your approval for the same.

The changes are Done.

@jsoriano jsoriano 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.

There are a couple of unaddressed comments.

Comment thread packages/microsoft_sqlserver/_dev/build/build.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/base-fields.yml Outdated
Comment thread packages/microsoft_sqlserver/data_stream/performance/fields/fields.yml Outdated
Comment thread packages/microsoft_sqlserver/manifest.yml Outdated
Comment thread packages/microsoft_sqlserver/manifest.yml Outdated
@jsoriano
jsoriano self-requested a review June 8, 2022 15:55

@jsoriano jsoriano 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.

Same comments as in #3395 (review)

It'd be nice to have some pipeline tests, but I am ok with adding them later.

And I would consider removing the query by now, taking into account that it will be easier to add it later, than to remove it.

@ManojS-shetty

Copy link
Copy Markdown
Contributor Author

Same comments as in #3395 (review)

It'd be nice to have some pipeline tests, but I am ok with adding them later.

And I would consider removing the query by now, taking into account that it will be easier to add it later, than to remove it.

@jsoriano Removed Query field for now.

@ManojS-shetty

Copy link
Copy Markdown
Contributor Author

Pinging @elastic/security-external-integrations for approval.

@efd6 efd6 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'd like to see a pipeline test here.

Comment thread packages/microsoft_sqlserver/data_stream/performance/agent/stream/stream.yml.hbs Outdated
@ManojS-shetty

Copy link
Copy Markdown
Contributor Author

I'd like to see a pipeline test here.

Thank you for that suggestion , Yes we will be keeping the pipeline test in enhancement.

@ManojS-shetty
ManojS-shetty merged commit 752ffee into elastic:main Jun 14, 2022
orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026
* Quick & Dirty MSSQL ImportBeats run and verified to be running fine.

* System Test for MS-SQL imported package prelim version

* System Test for MS-SQL imported package prelim version1

* working prelims- MSSQL Integration System Test

* performance datastream working with 8.3.0-SNAPSHOT elastic agent

* added mappings to fields.yml file in performance

* MSSQL Performance Dashboards with new Mapping

* Added the Dynamic Metrics change to handlebar for performance

* Added TRIM functionality in the Performance query and remapped the Performance dashboard

* Added the change for naming and description in fields.yml

* Deleted transaction_log old dashboard

* Changes to perf dashboard

* Updated changelog.yml

* Updated manifest.yml

* added changes to manifest.yml in top level for title and description

* Updated changelog.yml

* updated Changelog.yml and manifest.yml

* Updated a comment for hosts

* removed the extra line

* added transaction dashboard screenshot image

* Reverted codeowner value in manifest

* deleted system test chnages

* Updated the format in the files

* Formatted fields yaml file

* Added new sql performance query and changed the field yaml mapping accordingly

* deleted system test case for now

* Added handling of named instance for perf DataStream

* Removed the visualization in kibana directory

* Maintained consistency in visualization panels

* Updated the consistency in naming conventions for perf

* Formatting fields yaml file

* Added system Integration test for perf datastream

* Formatting docker compose file

* Formatting test config yaml file

* fixed formatting issue in test yaml file

* Updated changelog.yml

* Adding README and sample event json files

* Fixed formatting in sample event json for perf

* Updated the kibana version in manifest file

* Chnaged the kibana version for compatibality

* Added the dynamic counter name change

* Perfomance dashboard checked in with naming consistency

* Added documentation change to README

* Added manifest changes

* Added README file changes

* Adding build yaml file

* Added 1.0.1 version to manifest and changelog entry

* Changed the kibana version for backaward compatibality

* Changed back the kibana version

* Revert "Deleted transaction_log old dashboard"

This reverts commit 9bb54347dae66463496dd4cb50bab08ce1099d2f.

* Added ingest pipeline for renaming sql to mssql

* Deleted the transaction logs visualisation and dashboard to avoid the merge conflict

* Removed SNAPSHOT in version from perf dashboard

* changed the visualisation from by reference to by value

* Adding new image of performance dashboard

* Delete microsoft-sqlserver-performance-dashboard.png

* Updated fields and manifest yaml file

* Removed Snapshot from the dashboard file

* Added few changes like ECS import and driver field removal

* Added default yaml file in ingest pipeline

* Keeping policy template name to previous value

* Removed Query

* Adding new sample_event file

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

Labels

enhancement New feature or request Integration:microsoft_sqlserver Microsoft SQL Server Team:Integrations Label for the Integrations team Team:Service-Integrations Label for the Observability Service Integrations team