This integration is open source software. That means you can browse its source code and send improvements, or create your own fork and build it.
Labels and custom attributes
You can also decorate your metrics with labels. Labels allow you to add key/value pair attributes to your metrics so that you can query, filter, or group your metrics.
Even though our default sample configuration file includes examples of labels, they're optional. You can remove, modify, or add new ones.
labels: env: production role: load_balancerMicrosoft SQL Server instance settings
The Microsoft SQL Server integration collects both Metrics and Inventory information. In the table, use the Applies to column for the settings available to each collection:
Setting | Description | Default | Applies to |
|---|---|---|---|
HOSTNAME | Hostname or IP where MS SQL server is running. | 127.0.0.1 | M/I |
PORT | Port on which MS SQL server is listening.
| 1433 | M/I |
INSTANCE | The MS SQL Server Instance to connect to.
| N/A | M/I |
USERNAME | Username for accessing the MS SQL server.
| N/A | M/I |
PASSWORD | Password for the given SQL or Domain user. | N/A | M/I |
EXTRA_CONNECTION_URL_ARGS | Specify extra connection parameters as attr1=val1&attr2=val2. | N/A | M/I |
ENABLE_SSL | Use SSL to connect to the MS SQL Server. | false | M/I |
TRUST_SERVER_CERTIFICATE | if set to | false | M/I |
CERTIFICATE_LOCATION | Location of the SSL Certificate. | N/A | M/I |
TIMEOUT | Timeout for queries, in seconds. Set 0 for no timeout. | 30 | M/I |
ENABLE_BUFFER_METRICS | Enable collection of buffer pool metrics. These can be resource intensive for large systems. | true | M |
ENABLE_DATABASE_RESERVE_METRICS | Enable collection of database partition reserve space. These can be resource intensive for large systems. | true | M |
CUSTOM_METRICS_QUERY | A SQL query to collect custom metrics. See the custom query example. | N/A | M |
CUSTOM_METRICS_CONFIG | YAML configuration with one or more SQL queries to collect custom metrics. See the multiple custom queries example. | false | M |
METRICS | Set to | false | |
INVENTORY | Set to | false |
The values for these settings can be defined in several ways:
Adding the value directly in the config file. This is the most common way.
Replacing the values from environment variables using the
{{ }}notation. Read more about using environment variable passthroughs with on-host integrations or see the example for environment variables replacement.Important
This requires infrastructure agent v1.14.0+.Using secrets management. Use this to protect sensitive information, such as passwords that would be exposed in plain text on the configuration file. For more information, see secrets management.
Inventory data
The Microsoft SQL Server integration captures the configuration parameters and current settings of the Microsoft SQL Server environment. It collects the results of the sp_configure stored procedure, as well as current running configuration settings from the sys.configurations table. The data is available on the Inventory page, under the config/mssql source.
For more about inventory data, see Understand integration data.