Skip to content

[microsoft_sqlserver] Establish Named instance connection by Instance Name - #4501

Merged
muthu-mps merged 8 commits into
elastic:mainfrom
muthu-mps:named_instance_update
Nov 4, 2022
Merged

[microsoft_sqlserver] Establish Named instance connection by Instance Name#4501
muthu-mps merged 8 commits into
elastic:mainfrom
muthu-mps:named_instance_update

Conversation

@muthu-mps

@muthu-mps muthu-mps commented Oct 26, 2022

Copy link
Copy Markdown
Contributor
  • Enhancement

What does this PR do?

Connection is established with and without port number and also with the Instance Name.

Default Instance - username:password@host, username:password@host:port
Named Instance - username:password@host:port, username:password@host/InstanceName

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

  • Enable mssql integrations
  • Connect to mssql named instance to collect data. (Test by instance name and by port number)
  • Connect to mssql default instance using default connection string and by port number.
@muthu-mps muthu-mps self-assigned this Oct 26, 2022
@andrewkroh andrewkroh added the Integration:microsoft_sqlserver Microsoft SQL Server label Oct 26, 2022
@andrewkroh andrewkroh changed the title Establish Named instance connection by Instance Name Oct 26, 2022
@muthu-mps
muthu-mps marked this pull request as ready for review October 26, 2022 12:30
@muthu-mps
muthu-mps requested review from a team as code owners October 26, 2022 12:30
@elasticmachine

elasticmachine commented Oct 26, 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-11-03T06:32:26.356+0000

  • Duration: 16 min 44 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

elasticmachine commented Oct 26, 2022

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elasticmachine

elasticmachine commented Oct 26, 2022

Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (2/2) 💚
Files 100.0% (2/2) 💚 2.405
Classes 100.0% (2/2) 💚 2.405
Methods 93.333% (28/30) 👍 2.282
Lines 100.0% (1238/1238) 💚 9.581
Conditionals 100.0% (0/0) 💚
@muthu-mps

Copy link
Copy Markdown
Contributor Author

/test benchmark fullreport

Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Edit the instance port and provide the named instance port to connect to the named instance and collect metrics.
See: [Instruction on how to configure server to listen Named Instance port](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/configure-a-server-to-listen-on-a-specific-tcp-port?view=sql-server-ver15)
Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Establish named instance connection by using the instance name along with the host name (Ex: `host/instance_name` or `host:named_instance_port`) to collect metrics.

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.

Let's provide detailed description here to avoid repeated user queries around this. There are couple of aspects that need to be clarified:

  • As of now we support single host only. For multiple hosts, new integration need to be run. Need a section on it.
  • What is the different syntax hosts can take with syntax description.
  • Example of hosts with sample example values.

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

LGTM mod the request for detailed description in the readme.


As of now the integration supports collecting metrics from single host. For multi host, each host needs to run a new integration.

User has to provide the user name, password and the host name,

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.

Can add the following line:
+ The host configuration also contains both named instance or port details, as per the syntax below,

### Connecting to Named Instance (host)

* `host/instance_name` ex: `localhost/namedinstance_01`
* `host:named_instance_port` ex: `localhost:60873`

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.

Looks good.

@lalit-satapathy

Copy link
Copy Markdown
Contributor

LGTM

@muthu-mps
muthu-mps merged commit 370437a into elastic:main Nov 4, 2022
orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026
… Name (elastic#4501)

* named instance changes

* changelog entry update

* changes to readme

* added host config documentation

* readme update

* readme update

* Update README.md

Minor edits

* readme update

Co-authored-by: Lalit Satapathy <69236064+lalit-satapathy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 participants