Add Audience as span attribute for AAD/MSA/Common, Fixes #2970888

common4j/src/main/com/microsoft/identity/common/java/authorities/AzureActiveDirectoryAudience.java

@@ -53,6 +53,16 @@ public abstract class AzureActiveDirectoryAudience {
     public static final String ALL = "common";
     public static final String MSA_MEGA_TENANT_ID = "9188040d-6c67-4c5b-b112-36a304b66dad";
 
+    // The values here are audience values reported in telemetry
+    // rather than the values used to send to eSTS.
+    public enum AudienceTelemetryConstant {
+        MSA_AUDIENCE_FOR_REPORTING,
+        COMMON_AUDIENCE_FOR_REPORTING,
+        AAD_AUDIENCE_FOR_REPORTING,
+        UNKNOWN_AUDIENCE_FOR_REPORTING;
+    }
+
+
     public String getCloudUrl() {
         if (mCloudUrl == null) {
             return AzureActiveDirectory.getDefaultCloudUrl();
@@ -154,6 +164,32 @@ public void setTenantId(String tenantId) {
         mTenantId = tenantId;
     }
 
+    /**
+     * Determines the audience type (MSA, Common, AAD, or Unknown) from the given
+     * {@link AzureActiveDirectoryAuthority}.
+     *
+     * @param authority The authority from which the audience is derived.
+     * @return The audience type: "MSA", "Common", "AAD", or "Unknown".
+     */
+    public static String getAudienceFromAuthority( final AzureActiveDirectoryAuthority authority) {
+
+        if (authority == null || StringUtil.isNullOrEmpty(authority.getAudience().getTenantId())) {
+            return AudienceTelemetryConstant.UNKNOWN_AUDIENCE_FOR_REPORTING.name();
+        }
+
+        final String audienceToCheck = authority.getAudience().mTenantId.toLowerCase(Locale.ROOT);
+
+        switch (audienceToCheck) {
+            case CONSUMERS:
+            case MSA_MEGA_TENANT_ID:
+                return AudienceTelemetryConstant.MSA_AUDIENCE_FOR_REPORTING.name();
+            case ALL:
+                return AudienceTelemetryConstant.COMMON_AUDIENCE_FOR_REPORTING.name();
+            default:
+                return AudienceTelemetryConstant.AAD_AUDIENCE_FOR_REPORTING.name();
+        }
+    }
+
     public static AzureActiveDirectoryAudience getAzureActiveDirectoryAudience(final String cloudUrl,
                                                                                final String tenantId) {
         final String methodName = ":getAzureActiveDirectoryAudience";