/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
syntax = "proto2";
package android.os.statsd.ondevicepersonalization;
import "frameworks/proto_logging/stats/atoms.proto";
import "frameworks/proto_logging/stats/atom_field_options.proto";
option java_package = "com.android.os.ondevicepersonalization";
option java_multiple_files = true;
extend Atom {
  optional OnDevicePersonalizationApiCalled ondevicepersonalization_api_called =
            711 [(module) = "ondevicepersonalization", (truncate_timestamp) = true];
}
extend Atom {
    optional OnDevicePersonalizationTraceEvent ondevicepersonalization_trace_event =
      952 [(module) = "ondevicepersonalization", (truncate_timestamp) = true];
}
/**
 * Logs when a public ODP api is called.
 */
message OnDevicePersonalizationApiCalled {
    enum OnDevicePersonalizationApiClassType {
        UNKNOWN = 0;
        DOWNLOADING = 1;
        SERVING = 2;
        OPTIMIZATION = 3;
        REPORTING = 4;
    }
    enum OnDevicePersonalizationApiName {
        API_NAME_UNKNOWN = 0;
        EXECUTE = 1;
        REQUEST_SURFACE_PACKAGE = 2;
        SERVICE_ON_EXECUTE = 3;
        SERVICE_ON_DOWNLOAD_COMPLETED = 4;
        SERVICE_ON_RENDER = 5;
        SERVICE_ON_EVENT = 6;
        SERVICE_ON_TRAINING_EXAMPLE = 7;
        SERVICE_ON_WEB_TRIGGER = 8;
        REMOTE_DATA_GET = 9;
        REMOTE_DATA_KEYSET = 10;
        LOCAL_DATA_GET = 11;
        LOCAL_DATA_KEYSET = 12;
        LOCAL_DATA_PUT = 13;
        LOCAL_DATA_REMOVE = 14;
        EVENT_URL_CREATE_WITH_RESPONSE = 15;
        EVENT_URL_CREATE_WITH_REDIRECT = 16;
        LOG_READER_GET_REQUESTS = 17;
        LOG_READER_GET_JOINED_EVENTS = 18;
        FEDERATED_COMPUTE_SCHEDULE = 19;
        MODEL_MANAGER_RUN = 20;
        FEDERATED_COMPUTE_CANCEL = 21;
        NOTIFY_MEASUREMENT_EVENT = 22;
        ADSERVICES_GET_COMMON_STATES = 23;
        IS_FEATURE_ENABLED = 24;
    }
    optional OnDevicePersonalizationApiClassType api_class = 1;
    optional OnDevicePersonalizationApiName api_name = 2;
    // end to end latency of the operation
    optional int32 latency_millis = 3;
    // response_code is the error/failure code for the given api.
    optional int32 response_code = 4;
    // latency excluding time spent in user code
    optional int32 overhead_latency_millis = 5;
    // latency between call and service entry
    optional int32 rpc_call_latency_millis = 6;
    // latency between service return and callback
    optional int32 rpc_return_latency_millis = 7;
     // Log the package name that calls ODP API. Default is 0.
    optional int32 app_uid = 8 [(is_uid) = true];
    // Log the sdk package name that passed by app in API request.
    optional string sdk_package_name = 9;
}

/**
 * Logs trace events from internal processing in the ODP service.
 */
message OnDevicePersonalizationTraceEvent {
    enum TaskType {
        TASK_TYPE_UNKNOWN = 0;
        EXECUTE = 1;
        RENDER = 2;
        DOWNLOAD = 3;
        WEBVIEW = 4;
        TRAINING = 5;
        MAINTENANCE = 6;
        WEB_TRIGGER = 7;
    }
    enum EventType {
        UNKNOWN = 0;
        WRITE_REQUEST_LOG = 1;
        WRITE_EVENT_LOG = 2;
    }
    // task type to trace for internal processing in ODP service
    optional TaskType task_type = 1;
    // event type to trace for internal processing in ODP service
    optional EventType event_type = 2;
    // status of the operation
    optional int32 status = 3;
    // end to end latency of the operation
    optional int32 latency_millis = 4;
    // isolated service package name
    optional string service_package_name = 5;
}