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

Commit 89bc2e2f authored by Hakjun Choi's avatar Hakjun Choi
Browse files

[Satellite] framework side implementatation for satellite service metrics 

Bug: 270860124
Test: atest PersistAtomsStorageTest, SatelliteStatsTest
Test: e2e call / sms / mms regression test with pixel

Merged-In: I5c63068ed80de03222cf1cc43e21a00daf8acbfd
Change-Id: I5c63068ed80de03222cf1cc43e21a00daf8acbfd
parent dc5c6fe9

proto/src/persist_atoms.proto

+91 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ option java_outer_classname = "PersistAtomsProto"; 


// Holds atoms to store on persist storage in case of power cycle or process crash.

// NOTE: using int64 rather than google.protobuf.Timestamp for timestamps simplifies implementation.

// Next id: 53

// Next id: 70

message PersistAtoms {

    /* Aggregated RAT usage during the call. */

    repeated VoiceCallRatUsage voice_call_rat_usage = 1;
@@ -189,6 +189,42 @@ message PersistAtoms { 


    /* Number of time the user toggled the data switch feature since the last collection. */

    optional int32 auto_data_switch_toggle_count = 55;



    /** Snapshot of satellite controller. */

    repeated SatelliteController satellite_controller = 58;



    /* Timestamp of last satellite_controller pull. */

    optional int64 satellite_controller_pull_timestamp_millis = 59;



    /** Snapshot of satellite controller. */

    repeated SatelliteSession satellite_session = 60;



    /* Timestamp of last satellite_controller pull. */

    optional int64 satellite_session_pull_timestamp_millis = 61;



    /** Snapshot of satellite incoming datagram. */

    repeated SatelliteIncomingDatagram satellite_incoming_datagram = 62;



    /* Timestamp of last satellite_incoming_datagram pull. */

    optional int64 satellite_incoming_datagram_pull_timestamp_millis = 63;



    /** Snapshot of satellite outgoing datagram. */

    repeated SatelliteOutgoingDatagram satellite_outgoing_datagram = 64;



    /* Timestamp of last satellite_outgoing_datagram pull. */

    optional int64 satellite_outgoing_datagram_pull_timestamp_millis = 65;



    /** Snapshot of satellite provision datagram. */

    repeated SatelliteProvision satellite_provision = 66;



    /* Timestamp of last satellite_provision pull. */

    optional int64 satellite_provision_pull_timestamp_millis = 67;



    /** Snapshot of satellite SOS message recommender. */

    repeated SatelliteSosMessageRecommender satellite_sos_message_recommender = 68;



    /* Timestamp of last satellite_sos_message_recommender pull. */

    optional int64 satellite_sos_message_recommender_pull_timestamp_millis = 69;

}



// The canonical versions of the following enums live in:
@@ -538,3 +574,57 @@ message OutgoingShortCodeSms { 
    optional int32 xml_version = 2;

    optional int32 short_code_sms_count = 3;

}



message SatelliteController {

    optional int32 count_of_satellite_service_enablements_success = 1;

    optional int32 count_of_satellite_service_enablements_fail = 2;

    optional int32 count_of_outgoing_datagram_success = 3;

    optional int32 count_of_outgoing_datagram_fail = 4;

    optional int32 count_of_incoming_datagram_success = 5;

    optional int32 count_of_incoming_datagram_fail = 6;

    optional int32 count_of_datagram_type_sos_sms_success = 7;

    optional int32 count_of_datagram_type_sos_sms_fail = 8;

    optional int32 count_of_datagram_type_location_sharing_success = 9;

    optional int32 count_of_datagram_type_location_sharing_fail = 10;

    optional int32 count_of_provision_success = 11;

    optional int32 count_of_provision_fail = 12;

    optional int32 count_of_deprovision_success = 13;

    optional int32 count_of_deprovision_fail = 14;

    optional int32 total_service_uptime_sec = 15;

    optional int32 total_battery_consumption_percent = 16;

    optional int32 total_battery_charged_time_sec = 17;

}



message SatelliteSession {

    optional int32 satellite_service_initialization_result = 1;

    optional int32 satellite_technology = 2;

    optional int32 count = 3;

}



message SatelliteIncomingDatagram {

    optional int32 result_code = 1;

    optional int32 datagram_size_bytes = 2;

    optional int64 datagram_transfer_time_millis = 3;

}



message SatelliteOutgoingDatagram {

    optional int32 datagram_type = 1;

    optional int32 result_code = 2;

    optional int32 datagram_size_bytes = 3;

    optional int64 datagram_transfer_time_millis = 4;

}



message SatelliteProvision {

    optional int32 result_code = 1;

    optional int32 provisioning_time_sec = 2;

    optional bool is_provision_request = 3;

    optional bool is_canceled = 4;

}



message SatelliteSosMessageRecommender {

    optional bool is_display_sos_message_sent = 1;

    optional int32 count_of_timer_started = 2;

    optional bool is_ims_registered = 3;

    optional int32 cellular_service_state = 4;

    optional int32 count = 5;

}

src/java/com/android/internal/telephony/metrics/MetricsCollector.java

+184 −5
Original line number Diff line number Diff line
@@ -35,6 +35,12 @@ import static com.android.internal.telephony.TelephonyStatsLog.PER_SIM_STATUS; 
import static com.android.internal.telephony.TelephonyStatsLog.PRESENCE_NOTIFY_EVENT;

import static com.android.internal.telephony.TelephonyStatsLog.RCS_ACS_PROVISIONING_STATS;

import static com.android.internal.telephony.TelephonyStatsLog.RCS_CLIENT_PROVISIONING_STATS;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_CONTROLLER;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_INCOMING_DATAGRAM;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_OUTGOING_DATAGRAM;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_PROVISION;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_SESSION;

import static com.android.internal.telephony.TelephonyStatsLog.SATELLITE_SOS_MESSAGE_RECOMMENDER;

import static com.android.internal.telephony.TelephonyStatsLog.SIM_SLOT_STATE;

import static com.android.internal.telephony.TelephonyStatsLog.SIP_DELEGATE_STATS;

import static com.android.internal.telephony.TelephonyStatsLog.SIP_MESSAGE_RESPONSE;
@@ -75,6 +81,12 @@ import com.android.internal.telephony.nano.PersistAtomsProto.OutgoingSms; 
import com.android.internal.telephony.nano.PersistAtomsProto.PresenceNotifyEvent;

import com.android.internal.telephony.nano.PersistAtomsProto.RcsAcsProvisioningStats;

import com.android.internal.telephony.nano.PersistAtomsProto.RcsClientProvisioningStats;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteController;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteIncomingDatagram;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteOutgoingDatagram;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteProvision;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteSession;

import com.android.internal.telephony.nano.PersistAtomsProto.SatelliteSosMessageRecommender;

import com.android.internal.telephony.nano.PersistAtomsProto.SipDelegateStats;

import com.android.internal.telephony.nano.PersistAtomsProto.SipMessageResponse;

import com.android.internal.telephony.nano.PersistAtomsProto.SipTransportFeatureTagStats;
@@ -176,6 +188,12 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
            registerAtom(GBA_EVENT);

            registerAtom(PER_SIM_STATUS);

            registerAtom(OUTGOING_SHORT_CODE_SMS);

            registerAtom(SATELLITE_CONTROLLER);

            registerAtom(SATELLITE_SESSION);

            registerAtom(SATELLITE_INCOMING_DATAGRAM);

            registerAtom(SATELLITE_OUTGOING_DATAGRAM);

            registerAtom(SATELLITE_PROVISION);

            registerAtom(SATELLITE_SOS_MESSAGE_RECOMMENDER);

            Rlog.d(TAG, "registered");

        } else {

            Rlog.e(TAG, "could not get StatsManager, atoms not registered");
@@ -252,6 +270,18 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
                return pullPerSimStatus(data);

            case OUTGOING_SHORT_CODE_SMS:

                return pullOutgoingShortCodeSms(data);

            case SATELLITE_CONTROLLER:

                return pullSatelliteController(data);

            case SATELLITE_SESSION:

                return pullSatelliteSession(data);

            case SATELLITE_INCOMING_DATAGRAM:

                return pullSatelliteIncomingDatagram(data);

            case SATELLITE_OUTGOING_DATAGRAM:

                return pullSatelliteOutgoingDatagram(data);

            case SATELLITE_PROVISION:

                return pullSatelliteProvision(data);

            case SATELLITE_SOS_MESSAGE_RECOMMENDER:

                return pullSatelliteSosMessageRecommender(data);

            default:

                Rlog.e(TAG, String.format("unexpected atom ID %d", atomTag));

                return StatsManager.PULL_SKIP;
@@ -309,11 +339,7 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
        }

    }



    private void concludeAll() {

        concludeDataCallSessionStats();

        concludeImsStats();

        concludeServiceStateStats();



    private void concludeRcsStats() {

        RcsStats rcsStats = RcsStats.getInstance();

        if (rcsStats != null) {

            rcsStats.concludeSipTransportFeatureTagsStat();
@@ -323,6 +349,13 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
        }

    }



    private void concludeAll() {

        concludeDataCallSessionStats();

        concludeImsStats();

        concludeServiceStateStats();

        concludeRcsStats();

    }



    private static int pullSimSlotState(List<StatsEvent> data) {

        SimSlotState state;

        try {
@@ -750,6 +783,86 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
        }

    }



    private int pullSatelliteController(List<StatsEvent> data) {

        SatelliteController[] controllerAtoms =

                mStorage.getSatelliteControllerStats(MIN_COOLDOWN_MILLIS);

        if (controllerAtoms != null) {

            Arrays.stream(controllerAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_CONTROLLER pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }



    private int pullSatelliteSession(List<StatsEvent> data) {

        SatelliteSession[] sessionAtoms =

                mStorage.getSatelliteSessionStats(MIN_COOLDOWN_MILLIS);

        if (sessionAtoms != null) {

            Arrays.stream(sessionAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_SESSION pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }



    private int pullSatelliteIncomingDatagram(List<StatsEvent> data) {

        SatelliteIncomingDatagram[] incomingDatagramAtoms =

                mStorage.getSatelliteIncomingDatagramStats(MIN_COOLDOWN_MILLIS);

        if (incomingDatagramAtoms != null) {

            Arrays.stream(incomingDatagramAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_INCOMING_DATAGRAM pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }





    private int pullSatelliteOutgoingDatagram(List<StatsEvent> data) {

        SatelliteOutgoingDatagram[] outgoingDatagramAtoms =

                mStorage.getSatelliteOutgoingDatagramStats(MIN_COOLDOWN_MILLIS);

        if (outgoingDatagramAtoms != null) {

            Arrays.stream(outgoingDatagramAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_OUTGOING_DATAGRAM pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }





    private int pullSatelliteProvision(List<StatsEvent> data) {

        SatelliteProvision[] provisionAtoms =

                mStorage.getSatelliteProvisionStats(MIN_COOLDOWN_MILLIS);

        if (provisionAtoms != null) {

            Arrays.stream(provisionAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_PROVISION pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }



    private int pullSatelliteSosMessageRecommender(List<StatsEvent> data) {

        SatelliteSosMessageRecommender[] sosMessageRecommenderAtoms =

                mStorage.getSatelliteSosMessageRecommenderStats(MIN_COOLDOWN_MILLIS);

        if (sosMessageRecommenderAtoms != null) {

            Arrays.stream(sosMessageRecommenderAtoms)

                    .forEach(persistAtom -> data.add(buildStatsEvent(persistAtom)));

            return StatsManager.PULL_SUCCESS;

        } else {

            Rlog.w(TAG, "SATELLITE_SOS_MESSAGE_RECOMMENDER pull too frequent, skipping");

            return StatsManager.PULL_SKIP;

        }

    }



    /** Registers a pulled atom ID {@code atomId}. */

    private void registerAtom(int atomId) {

        mStatsManager.setPullAtomCallback(atomId, /* metadata= */ null,
@@ -1099,6 +1212,72 @@ public class MetricsCollector implements StatsManager.StatsPullAtomCallback { 
                shortCodeSms.shortCodeSmsCount);

    }



    private static StatsEvent buildStatsEvent(SatelliteController satelliteController) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_CONTROLLER,

                satelliteController.countOfSatelliteServiceEnablementsSuccess,

                satelliteController.countOfSatelliteServiceEnablementsFail,

                satelliteController.countOfOutgoingDatagramSuccess,

                satelliteController.countOfOutgoingDatagramFail,

                satelliteController.countOfIncomingDatagramSuccess,

                satelliteController.countOfIncomingDatagramFail,

                satelliteController.countOfDatagramTypeSosSmsSuccess,

                satelliteController.countOfDatagramTypeSosSmsFail,

                satelliteController.countOfDatagramTypeLocationSharingSuccess,

                satelliteController.countOfDatagramTypeLocationSharingFail,

                satelliteController.countOfProvisionSuccess,

                satelliteController.countOfProvisionFail,

                satelliteController.countOfDeprovisionSuccess,

                satelliteController.countOfDeprovisionFail,

                satelliteController.totalServiceUptimeSec,

                satelliteController.totalBatteryConsumptionPercent,

                satelliteController.totalBatteryChargedTimeSec);

    }



    private static StatsEvent buildStatsEvent(SatelliteSession satelliteSession) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_SESSION,

                satelliteSession.satelliteServiceInitializationResult,

                satelliteSession.satelliteTechnology,

                satelliteSession.count);

    }



    private static StatsEvent buildStatsEvent(SatelliteIncomingDatagram stats) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_INCOMING_DATAGRAM,

                stats.resultCode,

                stats.datagramSizeBytes,

                stats.datagramTransferTimeMillis);

    }



    private static StatsEvent buildStatsEvent(SatelliteOutgoingDatagram stats) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_OUTGOING_DATAGRAM,

                stats.datagramType,

                stats.resultCode,

                stats.datagramSizeBytes,

                stats.datagramTransferTimeMillis);

    }



    private static StatsEvent buildStatsEvent(SatelliteProvision stats) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_PROVISION,

                stats.resultCode,

                stats.provisioningTimeSec,

                stats.isProvisionRequest,

                stats.isCanceled);

    }



    private static StatsEvent buildStatsEvent(SatelliteSosMessageRecommender stats) {

        return TelephonyStatsLog.buildStatsEvent(

                SATELLITE_SOS_MESSAGE_RECOMMENDER,

                stats.isDisplaySosMessageSent,

                stats.countOfTimerStarted,

                stats.isImsRegistered,

                stats.cellularServiceState,

                stats.count);

    }



    /** Returns all phones in {@link PhoneFactory}, or an empty array if phones not made yet. */

    private static Phone[] getPhonesIfAny() {

        try {

src/java/com/android/internal/telephony/metrics/PersistAtomsStorage.java

+283 −3

File changed.

Preview size limit exceeded, changes collapsed.

src/java/com/android/internal/telephony/metrics/SatelliteStats.java

0 → 100644
+905 −0

File added.

Preview size limit exceeded, changes collapsed.

tests/telephonytests/src/com/android/internal/telephony/metrics/PersistAtomsStorageTest.java

+874 −55

File changed.

Preview size limit exceeded, changes collapsed.