Skip to content

Commit 21f6d73

Browse files
aslamovamiraslamovamir
authored
Follow-up update on auto-reporting docs (#626)
This PR is a follow-up to hashicorp/vault-enterprise#8444, and updates the docs to accurately indicate by logs whether the feature of auto-reporting is enabled or not.
2 parents 1b9d411 + 4553252 commit 21f6d73

File tree

2 files changed

+23
-27
lines changed

2 files changed

+23
-27
lines changed

‎content/vault/v1.19.x/content/docs/license/utilization/auto-reporting.mdx

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,17 @@ You will find log entries similar to the following:
5959
<CodeBlockConfig hideClipboard>
6060

6161
```
62-
[DEBUG] core.reporting: beginning snapshot export
63-
[DEBUG] core.reporting: creating payload
64-
[DEBUG] core.reporting: marshalling payload to json
65-
[DEBUG] core.reporting: generating authentication headers
66-
[DEBUG] core.reporting: creating request
67-
[DEBUG] core.reporting: sending request
68-
[DEBUG] core.reporting: performing request: method=POST url=https://reporting.hashicorp.services
69-
[DEBUG] core.reporting: recording audit record
70-
[INFO] core.reporting: Report sent: auditRecord="{\"payload\":{\"payload_version\":\"1\",\"license_id\":\"97afe7b4-b9c8-bf19-bf35-b89b5cc0efea\",\"product\":\"vault\",\"product_version\":\"1.14.0-rc1+ent\",\"export_timestamp\":\"2023-06-01T09:34:44.215133-04:00\",\"snapshots\":[{\"snapshot_version\":1,\"snapshot_id\":\"0001J7H7KMEDRXKM5C1QJGBXV3\",\"process_id\":\"01H1T45CZK2GN9WR22863W2K32\",\"timestamp\":\"2023-06-01T09:34:44.215001-04:00\",\"schema_version\":\"1.0.0\",\"service\":\"vault\",\"metrics\":{\"clientcount.current_month_estimate\":{\"key\":\"clientcount.current_month_estimate\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":20,\"nonentity\":11}}},\"clientcount.previous_month_complete\":{\"key\":\"clientcount.previous_month_complete\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":10,\"nonentity\":11}}}}}],\"metadata\":{\"vault\":{\"billing_start\":\"2023-03-01T00:00:00Z\",\"cluster_id\":\"a8d95acc-ec0a-6087-d7f6-4f054ab2e7fd\"}}}}"
71-
[DEBUG] core.reporting: completed recording audit record
72-
[DEBUG] core.reporting: export finished successfully
62+
[DEBUG] reporting.auto_exporter: beginning snapshot export
63+
[DEBUG] reporting.auto_exporter: creating bundle
64+
[DEBUG] reporting.auto_exporter: marshalling bundle to json
65+
[DEBUG] reporting.auto_exporter: creating request
66+
[DEBUG] reporting.auto_exporter: sending request
67+
[DEBUG] reporting.auto_exporter: performing request: method=POST url=https://reporting.hashicorp.services/v2
68+
[DEBUG] reporting.auto_exporter: recording audit record
69+
[DEBUG] reporting.auto_exporter: completed recording audit record
70+
[INFO] reporting.auto_exporter: Report sent: auditRecord="{\"bundle\":{\"version\":\"2\",\"mode\":\"automatic\",\"license_id\":\"97afe7b4-b9c8-bf19-bf35-b89b5cc0efea\",\"product\":\"vault\",\"product_version\":\"1.14.0-rc1+ent\",\"export_timestamp\":\"2023-06-01T09:34:44.215133-04:00\",\"snapshots\":[{\"snapshot_version\":1,\"snapshot_id\":\"0001J7H7KMEDRXKM5C1QJGBXV3\",\"process_id\":\"01H1T45CZK2GN9WR22863W2K32\",\"timestamp\":\"2023-06-01T09:34:44.215001-04:00\",\"schema_version\":\"1.0.0\",\"service\":\"vault\",\"metrics\":{\"clientcount.current_month_estimate\":{\"key\":\"clientcount.current_month_estimate\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":20,\"nonentity\":11}}},\"clientcount.previous_month_complete\":{\"key\":\"clientcount.previous_month_complete\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":10,\"nonentity\":11}}}}}],\"metadata\":{\"vault\":{\"billing_start\":\"2023-03-01T00:00:00Z\",\"cluster_id\":\"a8d95acc-ec0a-6087-d7f6-4f054ab2e7fd\"}}}}"
71+
[DEBUG] reporting.auto_exporter: completed recording audit record
72+
[DEBUG] reporting.auto_exporter: export finished successfully
7373
```
7474

7575
</CodeBlockConfig>
@@ -80,14 +80,13 @@ egress, logs will show an error.
8080
<CodeBlockConfig hideClipboard>
8181

8282
```
83-
[DEBUG] core.reporting: beginning snapshot export
84-
[DEBUG] core.reporting: creating payload
85-
[DEBUG] core.reporting: marshalling payload to json
86-
[DEBUG] core.reporting: generating authentication headers
87-
[DEBUG] core.reporting: creating request
88-
[DEBUG] core.reporting: sending request
89-
[DEBUG] core.reporting: performing request: method=POST url=https://reporting.hashicorp.services
90-
[DEBUG] core.reporting: error status code received: statusCode=403
83+
[DEBUG] reporting.auto_exporter: beginning snapshot export
84+
[DEBUG] reporting.auto_exporter: creating bundle
85+
[DEBUG] reporting.auto_exporter: marshalling bundle to json
86+
[DEBUG] reporting.auto_exporter: creating request
87+
[DEBUG] reporting.auto_exporter: sending request
88+
[DEBUG] reporting.auto_exporter: performing request: method=POST url=https://reporting.hashicorp.services/v2
89+
[DEBUG] reporting.auto_exporter: error status code received: statusCode=403
9190
```
9291

9392
</CodeBlockConfig>
@@ -141,14 +140,12 @@ reporting status upon active unseal.
141140
</Warning>
142141

143142

144-
You will find the following entries in the server log.
143+
You will find the following entry in the server log.
145144

146145
<CodeBlockConfig hideClipboard>
147146

148147
```
149-
[DEBUG] core: reloading automated reporting
150-
[INFO] core: opting out of automated reporting
151-
[DEBUG] activity: there is no reporting agent configured, skipping counts reporting
148+
[DEBUG] reporting: automated reporting is disabled; license utilization data will not be exported unless triggered manually
152149
```
153150

154151
</CodeBlockConfig>
@@ -181,8 +178,7 @@ You will find the following entries in the server log.
181178

182179
```
183180
[INFO] core: automated reporting disabled via environment variable: env=OPTOUT_LICENSE_REPORTING
184-
[INFO] core: opting out of automated reporting
185-
[DEBUG] activity: there is no reporting agent configured, skipping counts reporting
181+
[DEBUG] reporting: automated reporting is disabled; license utilization data will not be exported unless triggered manually
186182
```
187183

188184
</CodeBlockConfig>

‎content/vault/v1.20.x/content/docs/license/utilization/auto-reporting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ You will find log entries similar to the following:
6666
[DEBUG] reporting.auto_exporter: performing request: method=POST url=https://reporting.hashicorp.services/v2
6767
[DEBUG] reporting.auto_exporter: recording audit record
6868
[DEBUG] reporting.auto_exporter: completed recording audit record
69-
[INFO] core.reporting: Report sent: auditRecord="{\"payload\":{\"payload_version\":\"1\",\"license_id\":\"97afe7b4-b9c8-bf19-bf35-b89b5cc0efea\",\"product\":\"vault\",\"product_version\":\"1.14.0-rc1+ent\",\"export_timestamp\":\"2023-06-01T09:34:44.215133-04:00\",\"snapshots\":[{\"snapshot_version\":1,\"snapshot_id\":\"0001J7H7KMEDRXKM5C1QJGBXV3\",\"process_id\":\"01H1T45CZK2GN9WR22863W2K32\",\"timestamp\":\"2023-06-01T09:34:44.215001-04:00\",\"schema_version\":\"1.0.0\",\"service\":\"vault\",\"metrics\":{\"clientcount.current_month_estimate\":{\"key\":\"clientcount.current_month_estimate\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":20,\"nonentity\":11}}},\"clientcount.previous_month_complete\":{\"key\":\"clientcount.previous_month_complete\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":10,\"nonentity\":11}}}}}],\"metadata\":{\"vault\":{\"billing_start\":\"2023-03-01T00:00:00Z\",\"cluster_id\":\"a8d95acc-ec0a-6087-d7f6-4f054ab2e7fd\"}}}}"
69+
[INFO] reporting.auto_exporter: Report sent: auditRecord="{\"bundle\":{\"version\":\"2\",\"mode\":\"automatic\",\"license_id\":\"97afe7b4-b9c8-bf19-bf35-b89b5cc0efea\",\"product\":\"vault\",\"product_version\":\"1.14.0-rc1+ent\",\"export_timestamp\":\"2023-06-01T09:34:44.215133-04:00\",\"snapshots\":[{\"snapshot_version\":1,\"snapshot_id\":\"0001J7H7KMEDRXKM5C1QJGBXV3\",\"process_id\":\"01H1T45CZK2GN9WR22863W2K32\",\"timestamp\":\"2023-06-01T09:34:44.215001-04:00\",\"schema_version\":\"1.0.0\",\"service\":\"vault\",\"metrics\":{\"clientcount.current_month_estimate\":{\"key\":\"clientcount.current_month_estimate\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":20,\"nonentity\":11}}},\"clientcount.previous_month_complete\":{\"key\":\"clientcount.previous_month_complete\",\"kind\":\"sum\",\"mode\":\"write\",\"labels\":{\"type\":{\"entity\":10,\"nonentity\":11}}}}}],\"metadata\":{\"vault\":{\"billing_start\":\"2023-03-01T00:00:00Z\",\"cluster_id\":\"a8d95acc-ec0a-6087-d7f6-4f054ab2e7fd\"}}}}"
7070
[DEBUG] reporting.auto_exporter: completed recording audit record
7171
[DEBUG] reporting.auto_exporter: export finished successfully
7272
```
@@ -85,7 +85,7 @@ egress, logs will show an error.
8585
[DEBUG] reporting.auto_exporter: creating request
8686
[DEBUG] reporting.auto_exporter: sending request
8787
[DEBUG] reporting.auto_exporter: performing request: method=POST url=https://reporting.hashicorp.services/v2
88-
[DEBUG] core.reporting: error status code received: statusCode=403
88+
[DEBUG] reporting.auto_exporter: error status code received: statusCode=403
8989
```
9090

9191
</CodeBlockConfig>

0 commit comments

Comments
 (0)