Skip to content

Commit

Permalink
[DOCS] Add config example for AD domain credential for MSSQL module (e…
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton authored Dec 17, 2019
1 parent f1e35e0 commit f8fb038
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 12 deletions.
38 changes: 33 additions & 5 deletions metricbeat/docs/modules/mssql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,51 @@ beta[]
This is the https://www.microsoft.com/en-us/sql-server/sql-server-2017[Microsoft SQL 2017] Metricbeat module. It is still in beta and under active development to add new Metricsets and introduce enhancements.

[float]
== Compatibility
=== Compatibility

The module is being tested with https://hub.docker.com/r/microsoft/mssql-server-linux/[2017 GA] version under Linux

[float]
== Metricsets
=== Metricsets

The following Metricsets are already included:

[float]
=== `transaction_log`
==== `transaction_log`

`transaction_log` Metricset fetches information about the operation and transaction log of each MSSQL database in the monitored instance. All data is extracted from the https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/database-related-dynamic-management-views-transact-sql?view=sql-server-2017[Database Dynamic Management Views]

[float]
=== `performance`
==== `performance`

`performance` Metricset fetches information from what's commonly known as https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-performance-counters-transact-sql?view=sql-server-2017[Performance Counters] in MSSQL.

[float]
=== Module-specific configuration notes

When configuring the `hosts` option, you can specify native user credentials
as part of the host string with the following format:

----
hosts: ["sqlserver://sa@localhost"]]
----

To use Active Directory domain credentials, you can separately specify the username and password
using the respective configuration options to allow the domain to be included in the username:

----
metricbeat.modules:
- module: mssql
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10
----

Store sensitive values like passwords in the <<keystore,secrets keystore>>.

[float]
=== Example configuration
Expand All @@ -44,7 +70,9 @@ metricbeat.modules:
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://sa@localhost"]
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10s
----
Expand Down
4 changes: 3 additions & 1 deletion x-pack/metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,9 @@ metricbeat.modules:
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://sa@localhost"]
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10s


Expand Down
4 changes: 3 additions & 1 deletion x-pack/metricbeat/module/mssql/_meta/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://sa@localhost"]
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10s

35 changes: 31 additions & 4 deletions x-pack/metricbeat/module/mssql/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,48 @@
This is the https://www.microsoft.com/en-us/sql-server/sql-server-2017[Microsoft SQL 2017] Metricbeat module. It is still in beta and under active development to add new Metricsets and introduce enhancements.

[float]
== Compatibility
=== Compatibility

The module is being tested with https://hub.docker.com/r/microsoft/mssql-server-linux/[2017 GA] version under Linux

[float]
== Metricsets
=== Metricsets

The following Metricsets are already included:

[float]
=== `transaction_log`
==== `transaction_log`

`transaction_log` Metricset fetches information about the operation and transaction log of each MSSQL database in the monitored instance. All data is extracted from the https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/database-related-dynamic-management-views-transact-sql?view=sql-server-2017[Database Dynamic Management Views]

[float]
=== `performance`
==== `performance`

`performance` Metricset fetches information from what's commonly known as https://docs.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-performance-counters-transact-sql?view=sql-server-2017[Performance Counters] in MSSQL.

[float]
=== Module-specific configuration notes

When configuring the `hosts` option, you can specify native user credentials
as part of the host string with the following format:

----
hosts: ["sqlserver://sa@localhost"]]
----

To use Active Directory domain credentials, you can separately specify the username and password
using the respective configuration options to allow the domain to be included in the username:

----
metricbeat.modules:
- module: mssql
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10
----

Store sensitive values like passwords in the <<keystore,secrets keystore>>.
4 changes: 3 additions & 1 deletion x-pack/metricbeat/modules.d/mssql.yml.disabled
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
metricsets:
- "transaction_log"
- "performance"
hosts: ["sqlserver://sa@localhost"]
hosts: ["sqlserver://localhost"]
username: domain\username
password: verysecurepassword
period: 10s

0 comments on commit f8fb038

Please sign in to comment.