Document which metrics will be discard when buffers metrics and reserve metrics are disabled

[carlossscastro]

We should improve our documentation to state which metrics are lost when users set

ENABLE_BUFFER_METRICS: false

or

ENABLE_DATABASE_RESERVE_METRICS: false

to be more clear on the tradeoff for improved performance.

[alaiavee]

I just responded to a customer asking for these details in a support case. Adding notes here for whomever writes up the documentation changes.

The ENABLE_BUFFER_METRICS argument appears to affect the database and instance buffer size metrics:

MssqlDatabaseSample > bufferpool.sizePerDatabaseInBytes MssqlInstanceSample > bufferpool.sizeInBytes

As for the ENABLE_DATABASE_RESERVE_METRICS argument, it appears to enable or disable the following database metrics:

MssqlDatabaseSample > pageFileTotal MssqlDatabaseSample > pageFileAvailable

---

Code References:

If EnableBufferMetrics argument is true, it will perform the following:

• appends instanceBufferDefinitions to collectionList (LINK)
• calls the processDBBufferDefinitions function (LINK)

instanceBufferDefinitions metric query is defined HERE Results are saved to the following metric format: db:"instance_buffer_pool_size" metric_name:"bufferpool.sizeInBytes" source_type:"gauge"

function processDBBufferDefinitions defined HERE References a call to only one query, databaseBufferDefinitions.

databaseBufferDefinitions query defined HERE Results are saved in the following metric format: db:"buffer_pool_size" metric_name:"bufferpool.sizePerDatabaseInBytes" source_type:"gauge"

[carlossscastro]

Thanks @alaiavee

We'll update the documentation shortly.

[workato-integration[bot]]

https://issues.newrelic.com/browse/NEWRELIC-4722

[workato-integration[bot]]

Jira CommentId: 167331 Commented by calvarez:

Additional context: https://newrelic.slack.com/archives/CP2EWSX7C/p1641398727030200?thread_ts=1641398281.029200&cid=CP2EWSX7C

[workato-integration[bot]]

Jira CommentId: 167399 Commented by calvarez:

docs-PR: https://github.com/newrelic/docs-website/pull/12082

[workato-integration[bot]]

Work has been completed on this issue.