This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« MongoDB status metricset MSSQL performance metricset »

› ›

MSSQL module

edit

MSSQL module

edit

This is the Microsoft SQL 2017 Metricbeat module. It is still under active development to add new Metricsets and introduce enhancements.

Compatibility

edit

The module is being tested with 2017 GA version under Linux

Permission/Access required for tables

edit

1.transaction_log :

sys.databases
sys.dm_db_log_space_usage
sys.dm_db_log_stats(DB_ID)

2.performance :

sys.dm_os_performance_counters

If you browse MSDN for above tables, you will find "Permissions" section which defines the permission needed, e.g Permissions

Metricsets

edit

The following Metricsets are already included:

`transaction_log`

edit

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 Database Dynamic Management Views

`performance`

edit

performance Metricset fetches information from what’s commonly known as Performance Counters in MSSQL.

Module-specific configuration notes

edit

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 secrets keystore.

Example configuration

The MSSQL module supports the standard configuration options that are described in Modules. Here is an example configuration:

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

Metricsets

The following metricsets are available:

« MongoDB status metricset MSSQL performance metricset »