Back to Beats

Docs

x-pack/metricbeat/module/mssql/_meta/docs.md

9.4.02.4 KB
Original Source

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

Compatibility [_compatibility_35]

The module is being tested with 2017 GA version under Linux

Permission/Access required for tables [_permissionaccess_required_for_tables]

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 [_metricsets_50]

The following Metricsets are already included:

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

performance [_performance]

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

Module-specific configuration notes [_module_specific_configuration_notes_12]

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.