Revision control
Copy as Markdown
# Boolean
Boolean metrics are used for reporting simple flags.
## Recording API
### `set`
Sets a boolean metric to a specific value.
{{#include ../../../shared/tab_header.md}}
<div data-lang="Kotlin" class="tab">
```Kotlin
import org.mozilla.yourApplication.GleanMetrics.Flags
Flags.a11yEnabled.set(System.isAccesibilityEnabled())
```
</div>
<div data-lang="Java" class="tab">
```Java
import org.mozilla.yourApplication.GleanMetrics.Flags;
Flags.INSTANCE.a11yEnabled().set(System.isAccessibilityEnabled());
```
</div>
<div data-lang="Swift" class="tab">
```Swift
Flags.a11yEnabled.set(self.isAccessibilityEnabled)
```
</div>
<div data-lang="Python" class="tab">
```Python
from glean import load_metrics
metrics = load_metrics("metrics.yaml")
metrics.flags.a11y_enabled.set(is_accessibility_enabled())
```
</div>
<div data-lang="Rust" class="tab">
```Rust
use glean_metrics::flags;
flags::a11y_enabled.set(system.is_accessibility_enabled());
```
</div>
<div data-lang="JavaScript" class="tab">
```js
import * as flags from "./path/to/generated/files/flags.js";
flags.a11yEnabled.set(this.isAccessibilityEnabled());
```
</div>
<div data-lang="Firefox Desktop" class="tab">
**C++**
```cpp
#include "mozilla/glean/GleanMetrics.h"
mozilla::glean::flags::a11y_enabled.Set(false);
```
**JavaScript**
```js
Glean.flags.a11yEnabled.set(false);
```
</div>
{{#include ../../../shared/tab_footer.md}}
#### Recorded errors
* [`invalid_type`](../../user/metrics/error-reporting.md): if a non-boolean value is given (JavaScript only).
## Testing API
### `testGetValue`
Gets the recorded value for a given boolean metric.
Returns `true` or `false` if data is stored.
Returns a language-specific empty/null value if no data is stored.
Has an optional argument to specify the name of the ping you wish to retrieve data from, except
in Rust where it's required. `None` or no argument will default to the first value found for `send_in_pings`.
{{#include ../../../shared/tab_header.md}}
<div data-lang="Kotlin" class="tab">
```Kotlin
import org.mozilla.yourApplication.GleanMetrics.Flags
assertTrue(Flags.a11yEnabled.testGetValue())
```
</div>
<div data-lang="Java" class="tab">
```Java
import org.mozilla.yourApplication.GleanMetrics.Flags;
assertTrue(Flags.INSTANCE.a11yEnabled().testGetValue());
```
</div>
<div data-lang="Swift" class="tab">
```Swift
XCTAssertTrue(Flags.a11yEnabled.testGetValue())
```
</div>
<div data-lang="Python" class="tab">
```Python
from glean import load_metrics
metrics = load_metrics("metrics.yaml")
assert True is metrics.flags.a11y_enabled.test_get_value()
```
</div>
<div data-lang="Rust" class="tab">
```Rust
use glean_metrics::flags;
assert!(flags::a11y_enabled.test_get_value(None).unwrap());
```
</div>
<div data-lang="JavaScript" class="tab">
```js
import * as flags from "./path/to/generated/files/flags.js";
assert(await flags.a11yEnabled.testGetValue());
```
</div>
<div data-lang="Firefox Desktop" class="tab">
**C++**
```cpp
#include "mozilla/glean/GleanMetrics.h"
ASSERT_EQ(false, mozilla::glean::flags::a11y_enabled.TestGetValue().value());
```
**JavaScript**
```js
Assert.equal(false, Glean.flags.a11yEnabled.testGetValue());
```
</div>
{{#include ../../../shared/tab_footer.md}}
### `testGetNumRecordedErrors`
Gets the number of errors recorded for a given boolean metric.
{{#include ../../../shared/tab_header.md}}
<div data-lang="Kotlin" class="tab">
```Kotlin
import org.mozilla.yourApplication.GleanMetrics.Flags
assertEquals(
0, Flags.a11yEnabled.testGetNumRecordedErrors(ErrorType.INVALID_VALUE)
)
```
</div>
<div data-lang="Java" class="tab">
```Java
import org.mozilla.yourApplication.GleanMetrics.Flags;
assertEquals(
0, Flags.INSTANCE.a11yEnabled().testGetNumRecordedErrors(ErrorType.INVALID_VALUE)
);
```
</div>
<div data-lang="Swift" class="tab">
```Swift
XCTAssertEqual(0, Flags.a11yEnabled.testGetNumRecordedErrors(.invalidValue))
```
</div>
<div data-lang="Python" class="tab">
```Python
assert 0 == metrics.flags.a11y_enabled.test_get_num_recorded_errors(
ErrorType.INVALID_VALUE
)
```
</div>
<div data-lang="Rust" class="tab">
```Rust
use glean::ErrorType;
use glean_metrics::flags;
assert_eq!(
0,
flags::a11y_enabled.test_get_num_recorded_errors(
ErrorType::InvalidValue
)
);
```
</div>
<div data-lang="JavaScript" class="tab"></div>
<div data-lang="Firefox Desktop" class="tab"></div>
{{#include ../../../shared/tab_footer.md}}
## Metric parameters
Example boolean metric definition:
```yaml
flags:
a11y_enabled:
type: boolean
description: >
Records whether a11y is enabled on the device.
bugs:
data_reviews:
notification_emails:
- me@mozilla.com
expires: 2020-10-01
```
For a full reference on metrics parameters common to all metric types,
refer to the [metrics YAML registry format](../yaml/metrics.md) reference page.
### Extra metric parameters
N/A
## Data questions
* Is accessibility enabled?
## Reference
* [Swift API docs](../../../swift/Classes/BooleanMetricType.html)
* [Python API docs](../../../python/glean/metrics/index.html#glean.metrics.BooleanMetric)
* [Rust API docs](../../../docs/glean/private/boolean/struct.BooleanMetric.html)