Skip to content

Commit da0d252

Browse files
Merge pull request #19312 from abhishuraina/patch-1
Update docs to include optional parameter.mdx
2 parents 4b75634 + 1f0cb6e commit da0d252

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

src/install/microsoft-sql/whatsNext.mdx

+27-2
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,7 +184,9 @@ 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.
186-
</Collapser>
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.
188+
189+
</Collapser>
187190

188191
<Collapser
189192
id="custom-query"
@@ -446,7 +449,8 @@ The Microsoft SQL Server integration collects the following metric data attribut
446449
</td>
447450

448451
<td>
449-
The amount of disk space on the instance, in bytes.
452+
The amount of disk space on the instance, in bytes. It is reported
453+
when `ENABLE_DISK_METRICS_IN_BYTES` is set to true.
450454
</td>
451455
</tr>
452456

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

10081033
<tr>
10091034
<td>

0 commit comments

Comments
 (0)