Skip to content

Commit 5ae2bc7

Browse files
committed
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 f8a04d1 commit 5ae2bc7

File tree

5 files changed

+379
-56
lines changed

5 files changed

+379
-56
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+
```
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
layout: docs
3+
page_title: nomad operator utilization command reference
4+
description: |-
5+
The "operator utilization" generates utilization reporting bundles for Nomad Enterprise users.
6+
---
7+
8+
# `nomad operator utilization` command reference
9+
10+
The `operator utilization` command allows Nomad Enterprise users to generate
11+
utilization reporting bundles. If you have disabled [automated
12+
reporting](/nomad/docs/enterprise/license/utilization-reporting), use
13+
this command to manually generate the report and send it to HashiCorp. Nomad
14+
takes a new snapshot when there are no snapshots from the past twenty-four
15+
hours.
16+
17+
If ACLs are enabled, this command requires a token with the `operator:write`
18+
capability.
19+
20+
<EnterpriseAlert />
21+
22+
## Options
23+
24+
- `-message` `(string; "")` - Provide context about the conditions under which
25+
the report was generated and submitted. This message is not included in the
26+
utilization bundle but is included in the Nomad server logs.
27+
28+
- `-output` `(string; "")` - Specifies the output path for the bundle. Defaults
29+
to a time-based generated file name in the current working directory.
30+
31+
- `-today-only` `(bool: false)` - Include snapshots from the previous 24 hours,
32+
not historical snapshots.
33+
34+
## Examples
35+
36+
Create a utilization reporting bundle that includes all persisted historical
37+
snapshots and has the default bundle name
38+
(`nomad-utilization-<time_stamp>.json`).
39+
40+
```shell-session
41+
$ nomad operator utilization
42+
Success! Utilization reporting bundle written to: nomad-utilization-2024-02-16T22-23-25Z.json
43+
```
44+
45+
Create a utilization reporting bundle with a message about the bundle, and
46+
output the file at the specified path, `/utilization/reports/latest.json`.
47+
48+
```shell-session
49+
$ nomad operator utilization \
50+
-message="Change Control 654987" \
51+
-output="/utilization/reports/latest.json"
52+
```
53+
54+
**Example output**
55+
56+
<CodeBlockConfig hideClipboard>
57+
58+
```plaintext
59+
Success! Utilization reporting bundle written to: /utilization/reports/latest.json
60+
```
61+
62+
</CodeBlockConfig>
63+
64+
The message, `Change Control 654987`, is included in the _server log_, but not
65+
in the bundle.
66+
67+
**Example entry in the server log**
68+
69+
<CodeBlockConfig hideClipboard>
70+
71+
```plaintext
72+
[INFO] reporting: reporting bundle generated: message="Change Control 654987"
73+
```
74+
75+
</CodeBlockConfig>
76+
77+
## General options
78+
79+
@include 'general_options.mdx'

website/content/docs/configuration/reporting.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,17 @@ reporting {
3030
- `license` <code>([license](#license-block): default)</code> - Configures
3131
automated license utilization reporting.
3232

33+
- `disable_product_usage_reporting` `(bool: false)` - Specifies whether detailed
34+
product usage metrics should be disabled. Review the
35+
[full list of metrics](/nomad/docs/enterprise/license/utilization-reporting#full-list-of-metrics)
36+
before disabling this option, and share any concerns you may have
37+
with your account manager.
38+
3339
## `license` Block
3440

3541
- `enabled` `(bool: true)` - Specifies whether automated license utilization
36-
reporting should be enabled and run.
42+
reporting should be enabled and run. License utilization metrics are still
43+
gathered for offline reporting.
3744

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

0 commit comments

Comments
 (0)