Skip to content

Commit 7a34ebc

Browse files
authored
Update docs to include optional parameter.mdx
1 parent e214d04 commit 7a34ebc

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

src/install/microsoft-sql/whatsNext.mdx

+25-1
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ headingText: What's next?
173173
PASSWORD: mssql_password
174174
ENABLE_BUFFER_METRICS: false
175175
ENABLE_DATABASE_RESERVE_METRICS: false
176+
ENABLE_DISK_METRICS_IN_BYTES: false
176177
interval: 30s
177178
labels:
178179
environment: production
@@ -183,6 +184,7 @@ headingText: What's next?
183184

184185
* If you enable `ENABLE_BUFFER_METRICS`, a query starts running involving the `sys.sysdatabases` and `sys.dm_os_buffer_descriptors` internal tables to obtain the buffer's pool size for each database. This query could cause overhead on some SQL Servers. If you disable `ENABLE_BUFFER_METRICS`, the metric `bufferpool.sizePerDatabaseInBytes` won't be reported in MssqlDatabaseSample and `buferpool.sizeInBytes` won't be reported in MssqlInstanceSample.
185186
* If you enable `ENABLE_DATABASE_RESERVE_METRICS`, the reserved size is queried for each database and may cause some load on your server, depending on its size and usage. When it's disabled, both `pageFileTotal` and `pageFileAvailable` metrics stop being reported in MssqlDatabaseSample.
187+
* If you enable `ENABLE_DISK_METRICS_IN_BYTES`, runs a query which fetchs the volume stats for each database and this query can be slow. If you disable `ENABLE_DISK_METRICS_IN_BYTES`, the metric `instance.diskInBytes` won't be reposted in MssqlDatabaseSample.
186188
</Collapser>
187189

188190
<Collapser
@@ -446,7 +448,8 @@ The Microsoft SQL Server integration collects the following metric data attribut
446448
</td>
447449

448450
<td>
449-
The amount of disk space on the instance, in bytes.
451+
The amount of disk space on the instance, in bytes. It is reported
452+
when `ENABLE_DISK_METRICS_IN_BYTES` is set to true.
450453
</td>
451454
</tr>
452455

@@ -1004,6 +1007,27 @@ The Microsoft SQL Server integration collects the following metric data attribut
10041007
{
10051008
' '
10061009
}
1010+
<tr>
1011+
<td>
1012+
`ENABLE_DISK_METRICS_IN_BYTES`
1013+
</td>
1014+
1015+
<td>
1016+
Enable collection of the volume stats for each MSSQL instance.
1017+
</td>
1018+
1019+
<td>
1020+
`true`
1021+
</td>
1022+
1023+
<td style={{ 'text-align': 'center' }}>
1024+
M
1025+
</td>
1026+
</tr>
1027+
1028+
{
1029+
' '
1030+
}
10071031

10081032
<tr>
10091033
<td>

0 commit comments

Comments
 (0)