core/java/com/android/internal/logging/MetricsLogger.java

/*
 * Copyright (C) 2015 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.
 */
package com.android.internal.logging;


import android.content.Context;
import android.os.Build;
import android.view.View;

/**
 * Log all the things.
 *
 * @hide
 */
public class MetricsLogger implements MetricsConstants {
    // Temporary constants go here, to await migration to MetricsConstants.
    public static final int QS_LOCK_TILE = 257;
    public static final int QS_USER_TILE = 258;
    public static final int QS_BATTERY_TILE = 259;
    public static final int NOTIFICATION_ZEN_MODE_VISUAL_INTERRUPTIONS = 260;
    public static final int ACTION_ZEN_ALLOW_PEEK = 261;
    public static final int ACTION_ZEN_ALLOW_LIGHTS = 262;
    public static final int NOTIFICATION_TOPIC_NOTIFICATION = 263;
    public static final int ACTION_DEFAULT_SMS_APP_CHANGED = 264;
    public static final int QS_COLOR_MATRIX = 265;
    public static final int QS_CUSTOM = 266;
    public static final int ACTION_ZEN_ALLOW_SCREEN_ON = 267;

    /**
     * Logged when the user docks a window from recents by longpressing a task and dragging it to
     * the dock area.
     */
    public static final int ACTION_WINDOW_DOCK_DRAG_DROP = 265;

    /**
     * Logged when the user docks a fullscreen window by long pressing recents which also opens
     * recents on the lower/right side.
     */
    public static final int ACTION_WINDOW_DOCK_LONGPRESS = 266;

    /**
     * Logged when the user docks a window by dragging from the navbar which also opens recents on
     * the lower/right side.
     */
    public static final int ACTION_WINDOW_DOCK_SWIPE = 267;

    public static void visible(Context context, int category) throws IllegalArgumentException {
        if (Build.IS_DEBUGGABLE && category == VIEW_UNKNOWN) {
            throw new IllegalArgumentException("Must define metric category");
        }
        EventLogTags.writeSysuiViewVisibility(category, 100);
    }

    public static void hidden(Context context, int category) throws IllegalArgumentException {
        if (Build.IS_DEBUGGABLE && category == VIEW_UNKNOWN) {
            throw new IllegalArgumentException("Must define metric category");
        }
        EventLogTags.writeSysuiViewVisibility(category, 0);
    }

    public static void visibility(Context context, int category, boolean visibile)
            throws IllegalArgumentException {
        if (visibile) {
            visible(context, category);
        } else {
            hidden(context, category);
        }
    }

    public static void visibility(Context context, int category, int vis)
            throws IllegalArgumentException {
        visibility(context, category, vis == View.VISIBLE);
    }

    public static void action(Context context, int category) {
        action(context, category, "");
    }

    public static void action(Context context, int category, int value) {
        action(context, category, Integer.toString(value));
    }

    public static void action(Context context, int category, boolean value) {
        action(context, category, Boolean.toString(value));
    }

    public static void action(Context context, int category, String pkg) {
        if (Build.IS_DEBUGGABLE && category == VIEW_UNKNOWN) {
            throw new IllegalArgumentException("Must define metric category");
        }
        EventLogTags.writeSysuiAction(category, pkg);
    }

    /** Add an integer value to the monotonically increasing counter with the given name. */
    public static void count(Context context, String name, int value) {
        EventLogTags.writeSysuiCount(name, value);
    }

    /** Increment the bucket with the integer label on the histogram with the given name. */
    public static void histogram(Context context, String name, int bucket) {
        EventLogTags.writeSysuiHistogram(name, bucket);
    }
}