aboutsummaryrefslogtreecommitdiff
path: root/src/com/android/tv/perf/PerformanceMonitor.java
diff options
context:
space:
mode:
authorandroid-build-team Robot <android-build-team-robot@google.com>2017-10-05 07:30:20 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>2017-10-05 07:30:20 +0000
commitbb2e798ef4d546dd54cd9e95796403062b860c15 (patch)
treed31e2adc1f9cce4f27ca07d30bee921032e33a3c /src/com/android/tv/perf/PerformanceMonitor.java
parentbc7f430decab0bc34a533811efe457d4615f28aa (diff)
parent6ebde20b03db4c0d57f67acaac11832b610b966b (diff)
downloadTV-bb2e798ef4d546dd54cd9e95796403062b860c15.tar.gz
Snap for 4378450 from 6ebde20b03db4c0d57f67acaac11832b610b966b to oc-mr1-releaseandroid-wear-8.1.0_r1android-vts-8.1_r9android-vts-8.1_r8android-vts-8.1_r7android-vts-8.1_r6android-vts-8.1_r5android-vts-8.1_r4android-vts-8.1_r3android-vts-8.1_r14android-vts-8.1_r13android-vts-8.1_r12android-vts-8.1_r11android-vts-8.1_r10android-security-8.1.0_r93android-security-8.1.0_r92android-security-8.1.0_r91android-security-8.1.0_r90android-security-8.1.0_r89android-security-8.1.0_r88android-security-8.1.0_r87android-security-8.1.0_r86android-security-8.1.0_r85android-security-8.1.0_r84android-security-8.1.0_r83android-security-8.1.0_r82android-cts-8.1_r9android-cts-8.1_r8android-cts-8.1_r7android-cts-8.1_r6android-cts-8.1_r5android-cts-8.1_r4android-cts-8.1_r3android-cts-8.1_r25android-cts-8.1_r24android-cts-8.1_r23android-cts-8.1_r22android-cts-8.1_r21android-cts-8.1_r20android-cts-8.1_r2android-cts-8.1_r19android-cts-8.1_r18android-cts-8.1_r17android-cts-8.1_r16android-cts-8.1_r15android-cts-8.1_r14android-cts-8.1_r13android-cts-8.1_r12android-cts-8.1_r11android-cts-8.1_r10android-cts-8.1_r1android-8.1.0_r81android-8.1.0_r80android-8.1.0_r79android-8.1.0_r78android-8.1.0_r77android-8.1.0_r76android-8.1.0_r75android-8.1.0_r74android-8.1.0_r73android-8.1.0_r72android-8.1.0_r71android-8.1.0_r70android-8.1.0_r69android-8.1.0_r68android-8.1.0_r66android-8.1.0_r6android-8.1.0_r5android-8.1.0_r4android-8.1.0_r3android-8.1.0_r23android-8.1.0_r19android-8.1.0_r16android-8.1.0_r15android-8.1.0_r12android-8.1.0_r11android-8.1.0_r10android-8.1.0_r1security-oc-mr1-releaseoreo-mr1-wear-releaseoreo-mr1-vts-releaseoreo-mr1-security-releaseoreo-mr1-s1-releaseoreo-mr1-releaseoreo-mr1-cuttlefish-testingoreo-mr1-cts-releaseoreo-m4-s1-release
Change-Id: I07f19344c030a9c2b0fd7ba425f7bf7462575f92
Diffstat (limited to 'src/com/android/tv/perf/PerformanceMonitor.java')
-rw-r--r--src/com/android/tv/perf/PerformanceMonitor.java99
1 files changed, 99 insertions, 0 deletions
diff --git a/src/com/android/tv/perf/PerformanceMonitor.java b/src/com/android/tv/perf/PerformanceMonitor.java
new file mode 100644
index 00000000..40368b41
--- /dev/null
+++ b/src/com/android/tv/perf/PerformanceMonitor.java
@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2017 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.tv.perf;
+
+import android.content.Context;
+
+import static com.android.tv.perf.EventNames.EventName;
+
+/** Measures Performance. */
+public interface PerformanceMonitor {
+
+ /**
+ * Starts monitoring application's lifecylce for interesting memory events, captures and records
+ * memory usage data whenever these events are fired.
+ */
+ void startMemoryMonitor();
+
+ /**
+ * Collects and records memory usage for a specific custom event
+ *
+ * @param eventName to record
+ */
+ void recordMemory(@EventName String eventName);
+
+ /**
+ * Starts a timer for a global event to allow measuring the event's latency across activities If
+ * multiple events with the same name are started, only the last event is retained.
+ *
+ * @param eventName for which the timer starts
+ */
+ void startGlobalTimer(@EventName String eventName);
+
+ /**
+ * Stops a cross activities timer for a specific eventName and records the timer duration. If no
+ * timer found for the event specified an error will be logged, and recording will be skipped.
+ *
+ * @param eventName for which the timer stops
+ */
+ void stopGlobalTimer(@EventName String eventName);
+
+ /**
+ * Starts a timer to record latency of a specific scenario or event. Use this method to track
+ * latency in the same method/class
+ *
+ * @return TimerEvent object to be used for stopping/recording the timer for a specific event.
+ * If PerformanceMonitor is not initialized for any reason, an empty TimerEvent will be
+ * returned.
+ */
+ TimerEvent startTimer();
+
+
+ /**
+ * Stops timer for a specific event and records the timer duration. passing a null TimerEvent
+ * will cause this operation to be skipped.
+ *
+ * @param event that needs to be stopped
+ * @param eventName for which the timer stops. This must be constant with no PII.
+ */
+ void stopTimer(TimerEvent event, @EventName String eventName);
+
+ /**
+ * Starts recording jank for a specific scenario or event.
+ *
+ * <p>If jank recording was started already for an event with the current name, but was never
+ * stopped, the previously recorded event will be skipped.
+ *
+ * @param eventName of the event for which tracking is started
+ */
+ void startJankRecorder(@EventName String eventName);
+
+ /**
+ * Stops recording jank for a specific event and records the jank event.
+ *
+ * @param eventName of the event that needs to be stopped
+ */
+ void stopJankRecorder(@EventName String eventName);
+
+ /**
+ * Starts activity to display PerformanceMonitor events recorded in local database for debug
+ * purpose.
+ *
+ * @return true if the activity is available to start
+ */
+ boolean startPerformanceMonitorEventDebugActivity(Context context);
+}