api: added helper types for census reporting ent api #22837

sujay-hashicorp · 2025-09-26T05:07:34Z

Description

Added Census client for handling operator utilization related calls

Testing & Reproduction steps

n/a

Links

n/a

PR Checklist

updated test coverage
external facing docs updated
appropriate backport labels added
not a security concern

PCI review checklist

I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.

Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

srahul3

Added few minor comments.

srahul3 · 2025-09-26T05:48:44Z

api/operator_utilization.go

+	if q != nil {
+		r.setQueryOptions(q)
+	}
+	if req != nil {


IMO, the request must not be optional. return appropriate error

As per the CLI, all the flags are optional, i.e. each of message, today-only and send_report will have a default value. Therefore, a GET request without any query params is valid and an empty request should be handled with default value.
As for CustomerID, it is a required parameter for CreateBundle but it can be derived later in reporting package itself using license data. Hence, I have removed it from here.

What is the rational behind passing the Customer ID in CLI. This information is already available in License and hence it can be bundled in the response.

srahul3 · 2025-09-26T05:49:07Z

api/operator_utilization.go

+		r.setQueryOptions(q)
+	}
+	if req != nil {
+		if req.CustomerID != "" {


IMO, the CustomerID must not be optional. return error

Removed this as a request param as it will be derived in reporting package using the license data at the time of starting reporting agent for metric collection. This CustomerID will be maintained in cache there after for Bundle creation.

api/operator_utilization.go

srahul3 · 2025-09-26T05:51:15Z

api/txn.go

+type CensusOp string
+
+const (
+	CensusPut CensusOp = "put"


Can you take care of linting issue.

Fixed the lint errors now

srahul3

✅ LGTM

srahul3 · 2025-09-26T08:03:40Z

api/operator_utilization.go

+	if q != nil {
+		r.setQueryOptions(q)
+	}
+	if req != nil {


What is the rational behind passing the Customer ID in CLI. This information is already available in License and hence it can be bundled in the response.

srahul3 · 2025-09-26T11:03:08Z

api/operator_utilization.go

+// Utilization generates a census utilization bundle by calling the
+// /v1/operator/utilization endpoint. The returned byte slice contains the bundle
+// JSON payload suitable for saving to disk or further processing.
+func (c *Census) Utilization(req *UtilizationBundleRequest, q *QueryOptions) ([]byte, *QueryMeta, error) {


Please add the response struct method in followup PR.

hc-github-team-consul-core · 2025-09-28T09:18:10Z

📣 Hi @sujay-hashicorp! a backport is missing for this PR [22837] for versions [1.18,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

hc-github-team-consul-core · 2025-09-29T09:20:11Z

📣 Hi @sujay-hashicorp! a backport is missing for this PR [22837] for versions [1.18,1.19] please perform the backport manually and add the following snippet to your backport PR description:

<details>
	<summary> Overview of commits </summary>
		- <<backport commit 1>>
		- <<backport commit 2>>
		...
</details>

sujay-hashicorp added the backport/all Apply backports for all active releases per .release/versions.hcl label Sep 26, 2025

sujay-hashicorp requested a review from a team as a code owner September 26, 2025 05:07

github-actions bot added the theme/api Relating to the HTTP API interface label Sep 26, 2025

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

da7dc83

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

8d4633b

sujay-hashicorp force-pushed the sujay/dev/api branch from da7dc83 to 8d4633b Compare September 26, 2025 05:36

srahul3 reviewed Sep 26, 2025

View reviewed changes

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

968ce8d

sujay-hashicorp force-pushed the sujay/dev/api branch from 8d4633b to 968ce8d Compare September 26, 2025 05:58

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

97a28ca

sujay-hashicorp force-pushed the sujay/dev/api branch from 968ce8d to 97a28ca Compare September 26, 2025 06:20

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

885fecc

sujay-hashicorp force-pushed the sujay/dev/api branch from 97a28ca to 885fecc Compare September 26, 2025 06:23

sujay-hashicorp requested a review from srahul3 September 26, 2025 06:43

nitin-sachdev-29 previously approved these changes Sep 26, 2025

View reviewed changes

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

4f8a186

sujay-hashicorp dismissed nitin-sachdev-29’s stale review via 4f8a186 September 26, 2025 08:34

sujay-hashicorp force-pushed the sujay/dev/api branch from 885fecc to 4f8a186 Compare September 26, 2025 08:34

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

added changelog for #22837

ef57b99

sujay-hashicorp force-pushed the sujay/dev/api branch from 4f8a186 to ef57b99 Compare September 26, 2025 09:03

sujay-hashicorp added 2 commits September 26, 2025 14:53

api: added helper types for census reporting ent api

afcaaa1

added changelog for #22837

7052cd6

sujay-hashicorp force-pushed the sujay/dev/api branch from ef57b99 to 7052cd6 Compare September 26, 2025 09:23

srahul3 approved these changes Sep 26, 2025

View reviewed changes

sujay-hashicorp merged commit 72918f9 into main Sep 26, 2025
122 checks passed

hc-github-team-consul-core added the backport/1.21 This release series is longer active on CE, use backport/ent/1.21 label Sep 26, 2025

hc-github-team-consul-core added backport/ent/1.18 Changes are backported to 1.18 ent backport/ent/1.19 Changes are backported to 1.19 ent backport/ent/1.20 backport to ent 1.20 labels Sep 26, 2025

hc-github-team-consul-core mentioned this pull request Sep 26, 2025

Backport of api: added helper types for census reporting ent api into release/1.21.x #22842

Merged

7 tasks

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

api: added helper types for census reporting ent api (#22837)

b5a09ef

sujay-hashicorp added a commit that referenced this pull request Sep 26, 2025

api: added helper types for census reporting ent api (#22837)

80d5bab

api: added helper types for census reporting ent api #22837

api: added helper types for census reporting ent api #22837

Uh oh!

Conversation

sujay-hashicorp commented Sep 26, 2025

Description

Testing & Reproduction steps

Links

PR Checklist

PCI review checklist

Uh oh!

srahul3 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srahul3 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hc-github-team-consul-core commented Sep 28, 2025

Uh oh!

hc-github-team-consul-core commented Sep 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

srahul3 left a comment •

edited

Loading