[docs] Update MSSQL README to use documentation guidelines by colleenmcginnis · Pull Request #8240 · elastic/integrations

colleenmcginnis · 2023-10-18T18:04:55Z

Proposed commit message

Update README to use documentation guidelines

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.~~

Author's Checklist

@colleenmcginnis Initial draft to align with the documentation guidelines
@SubhrataK to provide an initial review of the structure
@colleenmcginnis address initial feedback, remove draft status
@elastic/obs-infraobs-integrations technical review
@colleenmcginnis address additional feedback, merge

How to test this PR locally

View the README.

Related issues

Related to https://github.com/elastic/observability-docs/issues/3270

elasticmachine · 2023-10-18T18:23:12Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-10-30T19:18:23.269+0000
Duration: 19 min 49 sec

Test stats 🧪

Test	Results
Failed	0
Passed	19
Skipped	0
Total	19

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.

elasticmachine · 2023-10-18T18:23:21Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	100.0% (`2/2`)	💚
Files	100.0% (`2/2`)	💚
Classes	100.0% (`2/2`)	💚
Methods	93.75% (`30/32`)	❕
Lines	100.0% (`1252/1252`)	💚
Conditionals	100.0% (`0/0`)	💚

colleenmcginnis · 2023-10-18T20:20:12Z

+  changes:
+    - description: Update README to use documentation guidelines
+      type: enhancement
+      link: TBD


Suggested change

link: TBD

link: https://github.com/elastic/integrations/pull/8240

SubhrataK

Looks good!

shmsr

Thank you for improving the documentation 🎉

elasticmachine · 2023-10-30T20:04:33Z

Package microsoft_sqlserver - 2.3.1 containing this change is available at https://epr.elastic.co/search?package=microsoft_sqlserver

lalit-satapathy

Should we also keep security team informed on document changes to the audit data-streams (if any?)

lalit-satapathy · 2023-10-31T05:49:26Z

+The Microsoft SQL Server integration package allows you to search, observe, and visualize the SQL Server audit logs, as well as performance and transaction log metrics, through Elasticsearch.

-Auditing an instance of the SQL Server Database Engine or an individual database involves tracking and logging events that occur on the Database Engine.
+For more information on SQL Server auditing, refer to [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).


The line in the beginning paragraph, somewhat looks mis-placed, since it is referring the audit data-stream primarily. It may wrongly infer referring to all data streams.

lalit-satapathy · 2023-10-31T05:50:42Z

+Other log sources, such as files, are not supported.

-Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Establish a named instance connection by using the instance name along with the hostname (e.g. `host/instance_name` or `host:named_instance_port`) to collect metrics. Details of the host configuration are provided below.
+Find more details in [Logs](#logs-reference).


Unable to click the #logs-reference, in the generated document. Can we verify the anchors exist?

Fix:

s/logs-reference/logs

lalit-satapathy · 2023-10-31T05:53:11Z

+Below you'll find more specific details on setting up the Microsoft SQL Server integration.

-## Host Configuration
+<!-- Additional set up instructions -->


Is this formatting intended: it comes as below:

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#hiding-content-with-comments

Ideally, this should have worked. On GitHub it does. Maybe for the website, we are using a different markdown renderer that does not support this?

shmsr · 2023-10-31T06:32:57Z

+Other log sources, such as files, are not supported.

-Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Establish a named instance connection by using the instance name along with the hostname (e.g. `host/instance_name` or `host:named_instance_port`) to collect metrics. Details of the host configuration are provided below.
+Find more details in [Logs](#logs-reference).


Fix:

s/logs-reference/logs

shmsr · 2023-10-31T06:33:27Z

+* `performance` metrics gather the list of performance objects available on that server. Each server will have a different list of performance objects depending on the installed software.
+* `transaction_log` metrics collect all usage stats and the total space usage.
+
+Find more details in [Metrics](#metrics-reference).


Fix:

s/metrics-reference/metrics

shmsr · 2023-10-31T06:33:37Z

+Below you'll find more specific details on setting up the Microsoft SQL Server integration.

-## Host Configuration
+<!-- Additional set up instructions -->


https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#hiding-content-with-comments

Ideally, this should have worked. On GitHub it does. Maybe for the website, we are using a different markdown renderer that does not support this?

* address post-merge feedback in #8240 * add link to this pr

) * first draft edits to mssql readme * address feedback

* address post-merge feedback in elastic#8240 * add link to this pr

first draft edits to mssql readme

b8e8ad6

colleenmcginnis added enhancement New feature or request Team:Docs Label for the Observability docs team docs labels Oct 18, 2023

colleenmcginnis requested a review from SubhrataK October 18, 2023 18:04

colleenmcginnis self-assigned this Oct 18, 2023

colleenmcginnis commented Oct 18, 2023

View reviewed changes

SubhrataK approved these changes Oct 23, 2023

View reviewed changes

Merge branch 'main' into mssql-setup

0784a36

colleenmcginnis marked this pull request as ready for review October 23, 2023 15:20

colleenmcginnis requested a review from a team as a code owner October 23, 2023 15:20

shmsr requested changes Oct 30, 2023

View reviewed changes

shmsr reviewed Oct 30, 2023

View reviewed changes

Comment thread packages/microsoft_sqlserver/docs/README.md Outdated

Colleen McGinnis added 2 commits October 30, 2023 14:12

Merge branch 'main' into mssql-setup

e8a4bc7

address feedback

fa12eee

colleenmcginnis requested a review from shmsr October 30, 2023 19:18

shmsr approved these changes Oct 30, 2023

View reviewed changes

colleenmcginnis merged commit ae2f82c into elastic:main Oct 30, 2023

colleenmcginnis deleted the mssql-setup branch October 30, 2023 19:39

lalit-satapathy reviewed Oct 31, 2023

View reviewed changes

shmsr reviewed Oct 31, 2023

View reviewed changes

colleenmcginnis pushed a commit to colleenmcginnis/integrations that referenced this pull request Oct 31, 2023

address post-merge feedback in elastic#8240

4c66f5a

colleenmcginnis mentioned this pull request Oct 31, 2023

[docs] Update MSSQL README #8360

Merged

6 tasks

colleenmcginnis added a commit that referenced this pull request Nov 1, 2023

[docs] Update MSSQL README (#8360)

bb17ebd

* address post-merge feedback in #8240 * add link to this pr

colleenmcginnis mentioned this pull request Nov 14, 2023

Add additional event types for CrowdStrike integration #8498

Merged

andrewkroh added the Integration:microsoft_sqlserver Microsoft SQL Server label Jul 22, 2024

andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Jul 1, 2025

orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026

[docs] Update MSSQL README to use documentation guidelines (elastic#8240

57aaf01

) * first draft edits to mssql readme * address feedback

orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026

[docs] Update MSSQL README (elastic#8360)

52a29c7

* address post-merge feedback in elastic#8240 * add link to this pr

	link: TBD
	link: https://github.com/elastic/integrations/pull/8240

Uh oh!

Conversation

colleenmcginnis commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed commit message

Checklist

Author's Checklist

How to test this PR locally

Related issues

Uh oh!

elasticmachine commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

🤖 GitHub comments

Uh oh!

elasticmachine commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌐 Coverage report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SubhrataK left a comment

Choose a reason for hiding this comment

Uh oh!

shmsr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Oct 30, 2023

Uh oh!

lalit-satapathy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

colleenmcginnis commented Oct 18, 2023 •

edited

Loading

elasticmachine commented Oct 18, 2023 •

edited

Loading

elasticmachine commented Oct 18, 2023 •

edited

Loading