File: SystemConfigFileCommitEventLogger.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (73 lines) | stat: -rw-r--r-- 2,512 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
 * Copyright (C) 2020 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 android.util;

import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.annotation.UptimeMillisLong;
import android.os.SystemClock;

/**
 * Writes an EventLog event capturing the performance of system config file writes.
 * The event log entry is formatted like this:
 * <code>525000 commit_sys_config_file (name|3),(time|2|3)</code>, where <code>name</code> is
 * a short unique name representing the type of configuration file and <code>time</code> is
 * duration in the {@link SystemClock#uptimeMillis()} time base.
 *
 * @hide
 */
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public class SystemConfigFileCommitEventLogger {
    private final String mName;
    private long mStartTime;

    /**
     * @param name The short name of the config file that is included in the event log event,
     *             e.g. "jobs", "appops", "uri-grants" etc.
     */
    public SystemConfigFileCommitEventLogger(@NonNull String name) {
        mName = name;
    }

    /**
     * Override the start timestamp.  Use this method when it's desired to include the time
     * taken by the preparation of the configuration data in the overall duration of the
     * "commitSysConfigFile" event.
     *
     * @param startTime Overridden start time, in system uptime milliseconds
     */
    public void setStartTime(@UptimeMillisLong long startTime) {
        mStartTime = startTime;
    }

    /**
     * Invoked just before the configuration file writing begins.
     */
    void onStartWrite() {
        if (mStartTime == 0) {
            mStartTime = SystemClock.uptimeMillis();
        }
    }

    /**
     * Invoked just after the configuration file writing ends.
     */
    void onFinishWrite() {
        com.android.internal.logging.EventLogTags.writeCommitSysConfigFile(mName,
                SystemClock.uptimeMillis() - mStartTime);
    }
}