[#BloombergLP-balm-StopwatchScopedGuard-isActive]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/StopwatchScopedGuard.adoc[StopwatchScopedGuard]::isActive
:relfileprefix: ../../../
:mrdocs:

Return `true` if this scoped guard will actively record metrics, and `false` otherwise.

== Synopsis

Declared in `<balm_stopwatchscopedguard.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
isActive() const;
----

== Description

If the returned value is `false` the destructor will not record a value to the metric. A scoped guard will be inactive if either (1) it was not initialized with a valid metric, (2) the metric it was initialized with was not active at the time of construction, or (3) the metric supplied at construction is currently inactive, meaning the category of metrics this metric belongs to has been disabled since this object's construction (see the `MetricsManager` method `setCategoryEnabled`).

== Return Value

`true` if this scoped guard will actively record metrics, and `false` otherwise


[.small]#Created with https://www.mrdocs.com[MrDocs]#