Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 569728be authored by Arpan Kaphle's avatar Arpan Kaphle Committed by Automerger Merge Worker
Browse files

Merge "Candidate Phase Metric Collector Data Type" into udc-dev am: 5b5b8108 

Original change: https://googleplex-android-review.googlesource.com/c/platform/frameworks/base/+/21891885



Change-Id: Iaf3ad24d17a1dfbad462510c5cf2eac509e01ad6
Signed-off-by: default avatarAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
parents 1edb7058 5b5b8108

services/credentials/java/com/android/server/credentials/MetricUtilities.java

+2 −2
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import android.util.Log; 
import com.android.internal.util.FrameworkStatsLog;

import com.android.server.credentials.metrics.ApiName;

import com.android.server.credentials.metrics.ApiStatus;

import com.android.server.credentials.metrics.CandidateProviderMetric;

import com.android.server.credentials.metrics.CandidatePhaseMetric;

import com.android.server.credentials.metrics.ChosenProviderMetric;



import java.util.Map;
@@ -98,7 +98,7 @@ public class MetricUtilities { 
            int[] candidateStatusList = new int[providerSize];

            int index = 0;

            for (var session : providerSessions) {

                CandidateProviderMetric metric = session.mCandidateProviderMetric;

                CandidatePhaseMetric metric = session.mCandidateProviderMetric;

                candidateUidList[index] = metric.getCandidateUid();

                candidateQueryRoundTripTimeList[index] = metric.getQueryLatencyMicroseconds();

                candidateStatusList[index] = metric.getProviderQueryStatus();

services/credentials/java/com/android/server/credentials/ProviderSession.java

+3 −3
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ import android.os.ICancellationSignal; 
import android.os.RemoteException;

import android.util.Log;



import com.android.server.credentials.metrics.CandidateProviderMetric;

import com.android.server.credentials.metrics.CandidatePhaseMetric;

import com.android.server.credentials.metrics.ProviderStatusForMetrics;



import java.util.UUID;
@@ -59,7 +59,7 @@ public abstract class ProviderSession<T, R> 
    @Nullable protected R mProviderResponse;

    @NonNull protected Boolean mProviderResponseSet = false;

    // Specific candidate provider metric for the provider this session handles

    @Nullable protected CandidateProviderMetric mCandidateProviderMetric;

    @Nullable protected CandidatePhaseMetric mCandidateProviderMetric;

    @NonNull private int mProviderSessionUid;



    /**
@@ -126,7 +126,7 @@ public abstract class ProviderSession<T, R> 
        mUserId = userId;

        mComponentName = info.getServiceInfo().getComponentName();

        mRemoteCredentialService = remoteCredentialService;

        mCandidateProviderMetric = new CandidateProviderMetric();

        mCandidateProviderMetric = new CandidatePhaseMetric();

        mProviderSessionUid = MetricUtilities.getPackageUid(mContext, mComponentName);

    }

services/credentials/java/com/android/server/credentials/RequestSession.java

+2 −2
Original line number Diff line number Diff line
@@ -36,7 +36,7 @@ import android.util.Log; 
import com.android.internal.R;

import com.android.server.credentials.metrics.ApiName;

import com.android.server.credentials.metrics.ApiStatus;

import com.android.server.credentials.metrics.CandidateProviderMetric;

import com.android.server.credentials.metrics.CandidatePhaseMetric;

import com.android.server.credentials.metrics.ChosenProviderMetric;



import java.util.ArrayList;
@@ -218,7 +218,7 @@ abstract class RequestSession<T, U> implements CredentialManagerUi.CredentialMan 
     * @param componentName the componentName to associate with a provider

     */

    protected void setChosenMetric(ComponentName componentName) {

        CandidateProviderMetric metric = this.mProviders.get(componentName.flattenToString())

        CandidatePhaseMetric metric = this.mProviders.get(componentName.flattenToString())

                .mCandidateProviderMetric;

        mChosenProviderMetric.setChosenUid(metric.getCandidateUid());

        mChosenProviderMetric.setFinalFinishTimeNanoseconds(System.nanoTime());

services/credentials/java/com/android/server/credentials/metrics/CandidateProviderMetric.java→services/credentials/java/com/android/server/credentials/metrics/CandidatePhaseMetric.java

+246 −0
Original line number Diff line number Diff line
@@ -16,6 +16,10 @@ 


package com.android.server.credentials.metrics;



import android.util.Log;



import com.android.server.credentials.MetricUtilities;



/**

 * The central candidate provider metric object that mimics our defined metric setup.

 * Some types are redundant across these metric collectors, but that has debug use-cases as
@@ -23,23 +27,59 @@ package com.android.server.credentials.metrics; 
 * into the next).

 * TODO(b/270403549) - iterate on this in V3+

 */

public class CandidateProviderMetric {

public class CandidatePhaseMetric {



    private static final String TAG = "CandidateProviderMetric";

    // Since this will always be the second in the split sequence, this is statically 2

    private static final int SESSION_ID = 2;

    // The sequence number of this emit of the API call, default -1, equal for all candidates

    private int mSequenceId = -1;

    // Indicates if this provider returned from the query phase, default false

    private boolean mQueryReturned = false;



    // The candidate provider uid

    private int mCandidateUid = -1;



    // Raw timestamp in nanoseconds, will be converted to microseconds for logging



    //For reference, the initial log timestamp when the service started running the API call

    private long mServiceBeganTimeNanoseconds = -1;

    // The moment when the query phase began

    private long mStartQueryTimeNanoseconds = -1;

    // The moment when the query phase ended

    private long mQueryFinishTimeNanoseconds = -1;



    // The status of this particular provider

    private int mProviderQueryStatus = -1;



    public CandidateProviderMetric() {

    // Indicates if an exception was thrown by this provider, false by default

    private boolean mHasException = false;

    // Indicates the number of total entries available. We can also locally store the entries, but

    // cannot emit them in the current split form. TODO(b/271135048) - possibly readjust candidate

    // entries. Also, it may be okay to remove this and instead aggregate from inner counts.

    // Defaults to -1

    private int mNumEntriesTotal = -1;

    // The count of action entries from this provider, defaults to -1

    private int mActionEntryCount = -1;

    // The count of credential entries from this provider, defaults to -1

    private int mCredentialEntryCount = -1;

    // The *type-count* of the credential entries, defaults to -1

    private int mCredentialEntryTypeCount = -1;

    // The count of remote entries from this provider, defaults to -1

    private int mRemoteEntryCount = -1;

    // The count of authentication entries from this provider, defaults to -1

    private int mAuthenticationEntryCount = -1;



    public CandidatePhaseMetric() {

    }



    /* ---------- Latencies ---------- */



    /* -- Timestamps -- */



    public void setServiceBeganTimeNanoseconds(long serviceBeganTimeNanoseconds) {

        this.mServiceBeganTimeNanoseconds = serviceBeganTimeNanoseconds;

    }



    public void setStartQueryTimeNanoseconds(long startQueryTimeNanoseconds) {

        this.mStartQueryTimeNanoseconds = startQueryTimeNanoseconds;

    }
@@ -48,6 +88,10 @@ public class CandidateProviderMetric { 
        this.mQueryFinishTimeNanoseconds = queryFinishTimeNanoseconds;

    }



    public long getServiceBeganTimeNanoseconds() {

        return this.mServiceBeganTimeNanoseconds;

    }



    public long getStartQueryTimeNanoseconds() {

        return this.mStartQueryTimeNanoseconds;

    }
@@ -56,6 +100,8 @@ public class CandidateProviderMetric { 
        return this.mQueryFinishTimeNanoseconds;

    }



    /* -- Actual time delta latencies (for local utility) -- */



    /**

     * Returns the latency in microseconds for the query phase.

     */
@@ -64,8 +110,24 @@ public class CandidateProviderMetric { 
                - this.getStartQueryTimeNanoseconds()) / 1000);

    }



    // TODO (in direct next dependent CL, so this is transient) - add reference timestamp in micro

    // seconds for this too.

    /* --- Time Stamp Conversion to Microseconds from Reference --- */



    /**

     * We collect raw timestamps in nanoseconds for ease of collection. However, given the scope

     * of our logging timeframe, and size considerations of the metric, we require these to give us

     * the microsecond timestamps from the start reference point.

     *

     * @param specificTimestamp the timestamp to consider, must be greater than the reference

     * @return the microsecond integer timestamp from service start to query began

     */

    public int getTimestampFromReferenceStartMicroseconds(long specificTimestamp) {

        if (specificTimestamp < this.mServiceBeganTimeNanoseconds) {

            Log.i(TAG, "The timestamp is before service started, falling back to default int");

            return MetricUtilities.DEFAULT_INT_32;

        }

        return (int) ((specificTimestamp

                - this.mServiceBeganTimeNanoseconds) / 1000);

    }



    /* ------------- Provider Query Status ------------ */
@@ -86,4 +148,99 @@ public class CandidateProviderMetric { 
    public int getCandidateUid() {

        return this.mCandidateUid;

    }



    /* -------------- Session Id ---------------- */

    public int getSessionId() {

        return SESSION_ID;

    }



    /* -------------- Sequence Id ---------------- */



    public void setSequenceId(int sequenceId) {

        mSequenceId = sequenceId;

    }



    public int getSequenceId() {

        return mSequenceId;

    }



    /* -------------- Query Returned Status ---------------- */



    public void setQueryReturned(boolean queryReturned) {

        mQueryReturned = queryReturned;

    }



    public boolean isQueryReturned() {

        return mQueryReturned;

    }



    /* -------------- Has Exception Status ---------------- */



    public void setHasException(boolean hasException) {

        mHasException = hasException;

    }



    public boolean isHasException() {

        return mHasException;

    }



    /* -------------- Number of Entries ---------------- */



    public void setNumEntriesTotal(int numEntriesTotal) {

        mNumEntriesTotal = numEntriesTotal;

    }



    public int getNumEntriesTotal() {

        return mNumEntriesTotal;

    }



    /* -------------- Count of Action Entries ---------------- */



    public void setActionEntryCount(int actionEntryCount) {

        mActionEntryCount = actionEntryCount;

    }



    public int getActionEntryCount() {

        return mActionEntryCount;

    }



    /* -------------- Count of Credential Entries ---------------- */



    public void setCredentialEntryCount(int credentialEntryCount) {

        mCredentialEntryCount = credentialEntryCount;

    }



    public int getCredentialEntryCount() {

        return mCredentialEntryCount;

    }



    /* -------------- Count of Credential Entry Types ---------------- */



    public void setCredentialEntryTypeCount(int credentialEntryTypeCount) {

        mCredentialEntryTypeCount = credentialEntryTypeCount;

    }



    public int getCredentialEntryTypeCount() {

        return mCredentialEntryTypeCount;

    }



    /* -------------- Count of Remote Entries ---------------- */



    public void setRemoteEntryCount(int remoteEntryCount) {

        mRemoteEntryCount = remoteEntryCount;

    }



    public int getRemoteEntryCount() {

        return mRemoteEntryCount;

    }



    /* -------------- Count of Authentication Entries ---------------- */



    public void setAuthenticationEntryCount(int authenticationEntryCount) {

        mAuthenticationEntryCount = authenticationEntryCount;

    }



    public int getAuthenticationEntryCount() {

        return mAuthenticationEntryCount;

    }

}

services/credentials/java/com/android/server/credentials/metrics/ChosenProviderMetric.java

+4 −4
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ public class ChosenProviderMetric { 
    /* ---------------- Latencies ------------------ */





    /* ----- Direct Latencies ------- */

    /* ----- Direct Delta Latencies for Local Utility ------- */



    /**

     * In order for a chosen provider to be selected, the call must have successfully begun.
@@ -85,7 +85,7 @@ public class ChosenProviderMetric { 
     * metric.

     *

     * @param queryPhaseLatencyMicroseconds the millisecond latency for the query phase, typically

     *                                      passed in through the {@link CandidateProviderMetric}

     *                                      passed in through the {@link CandidatePhaseMetric}

     */

    public void setQueryPhaseLatencyMicroseconds(int queryPhaseLatencyMicroseconds) {

        mQueryPhaseLatencyMicroseconds = queryPhaseLatencyMicroseconds;
@@ -106,7 +106,7 @@ public class ChosenProviderMetric { 


    /**

     * Returns the full provider (invocation to response) latency in microseconds. Expects the

     * start time to be provided, such as from {@link CandidateProviderMetric}.

     * start time to be provided, such as from {@link CandidatePhaseMetric}.

     */

    public int getEntireProviderLatencyMicroseconds() {

        return (int) ((this.mFinalFinishTimeNanoseconds
@@ -172,7 +172,7 @@ public class ChosenProviderMetric { 
        return mFinalFinishTimeNanoseconds;

    }



    /* --- Time Stamp Conversion to Microseconds --- */

    /* --- Time Stamp Conversion to Microseconds from Reference Point --- */



    /**

     * We collect raw timestamps in nanoseconds for ease of collection. However, given the scope