Adding monetization fields to GW by HiranyaKavishani · Pull Request #3753 · wso2/product-microgateway

HiranyaKavishani · 2026-01-23T17:56:56Z

Purpose

This PR allows to store the billing information sent by the Control Plane (CP) and include them in the analytics event during API invocation.

Related issue: https://github.com/wso2-enterprise/apim-saas/issues/1631

Issues

Fixes #

Automation tests

Unit tests added: Yes/No
Integration tests added: Yes/No

Tested environments

Not Tested

Maintainers: Check before merge

Assigned 'Type' label
Assigned the project
Validated respective github issues
Assigned milestone to the github issue(s)

coderabbitai · 2026-01-23T17:57:05Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

wso2-engineering · 2026-01-23T17:57:43Z

...arent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/analytics/AnalyticsFilter.java

        requestContext.addMetadataToMap(MetadataConstants.APP_OWNER_KEY,
                AnalyticsUtils.setDefaultIfNull(authContext.getSubscriber()));
+        requestContext.addMetadataToMap(MetadataConstants.BILLING_CUSTOMER_ID,
+                AnalyticsUtils.setDefaultIfNull(authContext.getBillingCustomerId()));
+        requestContext.addMetadataToMap(MetadataConstants.BILLING_SUBSCRIPTION_ID,
+                AnalyticsUtils.setDefaultIfNull(authContext.getBillingSubscriptionId()));



Log Improvement Suggestion No: 1

Suggested change

requestContext.addMetadataToMap(MetadataConstants.APP_OWNER_KEY,

AnalyticsUtils.setDefaultIfNull(authContext.getSubscriber()));

requestContext.addMetadataToMap(MetadataConstants.BILLING_CUSTOMER_ID,

AnalyticsUtils.setDefaultIfNull(authContext.getBillingCustomerId()));

requestContext.addMetadataToMap(MetadataConstants.BILLING_SUBSCRIPTION_ID,

AnalyticsUtils.setDefaultIfNull(authContext.getBillingSubscriptionId()));

requestContext.addMetadataToMap(MetadataConstants.APP_OWNER_KEY,

AnalyticsUtils.setDefaultIfNull(authContext.getSubscriber()));

if (log.isDebugEnabled()) {

log.debug("Adding billing metadata - customerId: " +

(authContext.getBillingCustomerId() != null ? "[present]" : "[null]") +

", subscriptionId: " +

(authContext.getBillingSubscriptionId() != null ? "[present]" : "[null]"));

}

wso2-engineering · 2026-01-23T17:57:44Z

...forcer/src/main/java/org/wso2/choreo/connect/enforcer/analytics/ChoreoAnalyticsProvider.java

        map.put(AnalyticsConstants.GATEWAY_URL, gwURL);
        map.put(AnalyticsConstants.DEPLOYMENT_TYPE, deploymentType);
+        map.put(AnalyticsConstants.BILLING_CUSTOMER_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_CUSTOMER_ID));
+        map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_SUBSCRIPTION_ID));


Log Improvement Suggestion No: 2

Suggested change

map.put(AnalyticsConstants.GATEWAY_URL, gwURL);

map.put(AnalyticsConstants.DEPLOYMENT_TYPE, deploymentType);

map.put(AnalyticsConstants.BILLING_CUSTOMER_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_CUSTOMER_ID));

map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_SUBSCRIPTION_ID));

map.put(AnalyticsConstants.GATEWAY_URL, gwURL);

map.put(AnalyticsConstants.DEPLOYMENT_TYPE, deploymentType);

map.put(AnalyticsConstants.BILLING_CUSTOMER_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_CUSTOMER_ID));

map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, getValueAsString(fieldsMap, MetadataConstants.BILLING_SUBSCRIPTION_ID));

log.debug("Added billing information to analytics properties.");

wso2-engineering · 2026-01-23T17:57:45Z

...r/src/main/java/org/wso2/choreo/connect/enforcer/analytics/ChoreoFaultAnalyticsProvider.java

    public Map<String, Object> getProperties() {
        Map map = new HashMap();
+        AuthenticationContext authContext = AnalyticsUtils.getAuthenticationContext(requestContext);


Log Improvement Suggestion No: 3

Suggested change

public Map<String, Object> getProperties() {

Map map = new HashMap();

AuthenticationContext authContext = AnalyticsUtils.getAuthenticationContext(requestContext);

public Map<String, Object> getProperties() {

Map map = new HashMap();

AuthenticationContext authContext = AnalyticsUtils.getAuthenticationContext(requestContext);

log.debug("Retrieving properties for analytics with billing information");

wso2-engineering · 2026-01-23T17:57:45Z

...r/src/main/java/org/wso2/choreo/connect/enforcer/analytics/ChoreoFaultAnalyticsProvider.java

        map.put(AnalyticsConstants.API_METHOD, requestContext.getRequestMethod());
+        map.put(AnalyticsConstants.BILLING_CUSTOMER_ID,  billingCustomerId);
+        map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, billingSubscriptionId);


Log Improvement Suggestion No: 4

Suggested change

map.put(AnalyticsConstants.API_METHOD, requestContext.getRequestMethod());

map.put(AnalyticsConstants.BILLING_CUSTOMER_ID, billingCustomerId);

map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, billingSubscriptionId);

map.put(AnalyticsConstants.API_METHOD, requestContext.getRequestMethod());

map.put(AnalyticsConstants.BILLING_CUSTOMER_ID, billingCustomerId);

map.put(AnalyticsConstants.BILLING_SUBSCRIPTION_ID, billingSubscriptionId);

if (log.isDebugEnabled()) {

log.debug("Added billing details to analytics properties - customerId: " +

(billingCustomerId.isEmpty() ? "not-set" : "set") +

", subscriptionId: " + (billingSubscriptionId.isEmpty() ? "not-set" : "set"));

}

wso2-engineering · 2026-01-23T17:57:46Z

...er-parent/enforcer/src/main/java/org/wso2/choreo/connect/enforcer/security/KeyValidator.java

        infoDTO.setSubscriberTenantDomain(app.getTenantDomain());
+        infoDTO.setBillingCustomerId(sub.getBillingCustomerId());


Log Improvement Suggestion No: 5

Suggested change

infoDTO.setSubscriberTenantDomain(app.getTenantDomain());

infoDTO.setBillingCustomerId(sub.getBillingCustomerId());

infoDTO.setSubscriberTenantDomain(app.getTenantDomain());

if (log.isDebugEnabled()) {

log.debug("Setting billing information for subscription: customerId={}, subscriptionId={}",

sub.getBillingCustomerId() != null ? "[REDACTED]" : "null",

sub.getBillingSubscriptionId() != null ? "[REDACTED]" : "null");

}

infoDTO.setBillingCustomerId(sub.getBillingCustomerId());

wso2-engineering · 2026-01-23T17:57:47Z

...r/src/main/java/org/wso2/choreo/connect/enforcer/subscription/SubscriptionDataStoreImpl.java

            newSubscription.setVersionRange(subscription.getVersionRange());
+            newSubscription.setBillingCustomerId(subscription.getBillingCustomerId());
+            newSubscription.setBillingSubscriptionId(subscription.getBillingSubscriptionId());


Log Improvement Suggestion No: 6

Suggested change

newSubscription.setVersionRange(subscription.getVersionRange());

newSubscription.setBillingCustomerId(subscription.getBillingCustomerId());

newSubscription.setBillingSubscriptionId(subscription.getBillingSubscriptionId());

newSubscription.setVersionRange(subscription.getVersionRange());

newSubscription.setBillingCustomerId(subscription.getBillingCustomerId());

newSubscription.setBillingSubscriptionId(subscription.getBillingSubscriptionId());

log.debug("Added billing information for subscription: {} with customerId: {} and subscriptionId: {}",

newSubscription.getCacheKey(), subscription.getBillingCustomerId(), subscription.getBillingSubscriptionId());

wso2-engineering

AI Agent Log Improvement Checklist

⚠️ Warning: AI-Generated Review Comments

The log-related comments and suggestions in this review were generated by an AI tool to assist with identifying potential improvements. Purpose of reviewing the code for log improvements is to improve the troubleshooting capabilities of our products.
Please make sure to manually review and validate all suggestions before applying any changes. Not every code suggestion would make sense or add value to our purpose. Therefore, you have the freedom to decide which of the suggestions are helpful.

✅ Before merging this pull request:

Review all AI-generated comments for accuracy and relevance.
Complete and verify the table below. We need your feedback to measure the accuracy of these suggestions and the value they add. If you are rejecting a certain code suggestion, please mention the reason briefly in the suggestion for us to capture it.

Comment	Accepted (Y/N)	Reason
#### Log Improvement Suggestion No: 1
#### Log Improvement Suggestion No: 2
#### Log Improvement Suggestion No: 3
#### Log Improvement Suggestion No: 4
#### Log Improvement Suggestion No: 5
#### Log Improvement Suggestion No: 6

Adding missing file adding re generated file adding re generated file fixing formatting issue

HiranyaKavishani requested review from VirajSalaka and ruks January 23, 2026 17:57

wso2-engineering bot reviewed Jan 23, 2026

View reviewed changes

wso2-engineering bot suggested changes Jan 23, 2026

View reviewed changes

HiranyaKavishani force-pushed the monetization branch from ea5ac50 to 1458836 Compare January 23, 2026 18:53

Adding monetization fields to GW

28dfc27

Adding missing file adding re generated file adding re generated file fixing formatting issue

HiranyaKavishani force-pushed the monetization branch from 1458836 to 28dfc27 Compare January 25, 2026 04:55

Adding missing fields

d715870

HiranyaKavishani added the Type/New Feature label Jan 26, 2026

HiranyaKavishani changed the base branch from choreo to monetization-feature January 29, 2026 11:00

HiranyaKavishani requested review from HeshanSudarshana, Krishanx92 and pubudu538 as code owners January 29, 2026 11:00

HiranyaKavishani changed the base branch from monetization-feature to choreo January 29, 2026 11:00

HiranyaKavishani changed the base branch from choreo to monetization-feature January 29, 2026 11:02

HiranyaKavishani merged commit c0d6f33 into wso2:monetization-feature Jan 29, 2026
3 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Adding monetization fields to GW#3753

Adding monetization fields to GW#3753
HiranyaKavishani merged 2 commits intowso2:monetization-featurefrom
HiranyaKavishani:monetization

HiranyaKavishani commented Jan 23, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 23, 2026

Review skipped

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot Jan 23, 2026

Uh oh!

wso2-engineering bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		infoDTO.setSubscriberTenantDomain(app.getTenantDomain());
		infoDTO.setBillingCustomerId(sub.getBillingCustomerId());

Comments

Conversation

HiranyaKavishani commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Issues

Automation tests

Tested environments

Maintainers: Check before merge

Uh oh!

coderabbitai bot commented Jan 23, 2026

Review skipped

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 1

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 2

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 3

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 4

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 5

Uh oh!

wso2-engineering bot Jan 23, 2026

Choose a reason for hiding this comment

Log Improvement Suggestion No: 6

Uh oh!

wso2-engineering bot left a comment

Choose a reason for hiding this comment

AI Agent Log Improvement Checklist

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

HiranyaKavishani commented Jan 23, 2026 •

edited

Loading