Skip to content

Commit a4d9573

Browse files
authored
enterprise reporting: add product usage metrics (#27005)
Add documentation for an enterprise-only feature which will allow us on the Nomad team to better understand how Nomad is being used by enterprise customers. This does not apply at all to CE code or binaries. This only documents what metrics we gather in enterprise binaries, and how to disable the extra metrics if desired.
1 parent 954be09 commit a4d9573

File tree

5 files changed

+270
-50
lines changed

5 files changed

+270
-50
lines changed

.changelog/27005.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:improvement
2+
reporting (Enterprise): Include product usage metrics with license utilization reports
3+
```

website/content/commands/operator/utilization.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ description: |-
88
# `nomad operator utilization` command reference
99

1010
The `operator utilization` command allows Nomad Enterprise users to generate
11-
utilization reporting bundles. If you have disabled automated reporting, use
11+
utilization reporting bundles. If you have disabled [automated
12+
reporting](/nomad/docs/enterprise/license/utilization-reporting), use
1213
this command to manually generate the report and send it to HashiCorp. Nomad
1314
takes a new snapshot when there are no snapshots from the past twenty-four
1415
hours.
@@ -18,10 +19,6 @@ capability.
1819

1920
<EnterpriseAlert />
2021

21-
Refer to the [manual license utilization
22-
reporting](/nomad/docs/enterprise/license/utilization-reporting) page to learn
23-
more about reporting your Nomad Enterprise license utilization.
24-
2522
## Options
2623

2724
- `-message` `(string; "")` - Provide context about the conditions under which

website/content/docs/configuration/reporting.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,17 @@ reporting {
4141
state store. You can export these snapshots with the [`nomad operator
4242
utilization`][] command.
4343

44+
- `disable_product_usage_reporting` `(bool: false)` - Specifies whether detailed
45+
product usage metrics should be disabled. Review the
46+
[full list of metrics](/nomad/docs/enterprise/license/utilization-reporting#full-list-of-metrics)
47+
before disabling this option, and share any concerns you may have
48+
with your account manager.
49+
4450
## `license` Block
4551

4652
- `enabled` `(bool: true)` - Specifies whether automated license utilization
47-
reporting should be enabled and run.
53+
reporting should be enabled and run. License utilization metrics are still
54+
gathered for offline reporting.
4855

4956
[server_mode_enabled]: /nomad/docs/configuration/server#enabled
5057
[automated_license_utilization_reporting]: /nomad/docs/enterprise/license/utilization-reporting

0 commit comments

Comments
 (0)