Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef METRIC_PRODUCER_H |
| 18 | #define METRIC_PRODUCER_H |
| 19 | |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 20 | #include <shared_mutex> |
| 21 | |
Yao Chen | 8a8d16c | 2018-02-08 14:50:40 -0800 | [diff] [blame] | 22 | #include "HashableDimensionKey.h" |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 23 | #include "anomaly/AnomalyTracker.h" |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 24 | #include "condition/ConditionWizard.h" |
Yao Chen | b356151 | 2017-11-21 18:07:17 -0800 | [diff] [blame] | 25 | #include "config/ConfigKey.h" |
Joe Onorato | 9fc9edf | 2017-10-15 20:08:52 -0700 | [diff] [blame] | 26 | #include "matchers/matcher_util.h" |
| 27 | #include "packages/PackageInfoListener.h" |
| 28 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 29 | #include <log/logprint.h> |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 30 | #include <utils/RefBase.h> |
Yao Chen | d10f7b1 | 2017-12-18 12:53:50 -0800 | [diff] [blame] | 31 | #include <unordered_map> |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 32 | |
| 33 | namespace android { |
| 34 | namespace os { |
| 35 | namespace statsd { |
| 36 | |
| 37 | // A MetricProducer is responsible for compute one single metrics, creating stats log report, and |
David Chen | de70169 | 2017-10-05 13:16:02 -0700 | [diff] [blame] | 38 | // writing the report to dropbox. MetricProducers should respond to package changes as required in |
| 39 | // PackageInfoListener, but if none of the metrics are slicing by package name, then the update can |
| 40 | // be a no-op. |
David Chen | f12b5c6 | 2017-10-13 15:54:03 -0700 | [diff] [blame] | 41 | class MetricProducer : public virtual PackageInfoListener { |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 42 | public: |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame^] | 43 | MetricProducer(const int64_t& metricId, const ConfigKey& key, const int64_t timeBaseNs, |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 44 | const int conditionIndex, const sp<ConditionWizard>& wizard) |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 45 | : mMetricId(metricId), |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 46 | mConfigKey(key), |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame^] | 47 | mTimeBaseNs(timeBaseNs), |
| 48 | mCurrentBucketStartTimeNs(timeBaseNs), |
Yang Lu | 3eba621 | 2017-10-25 19:54:45 -0700 | [diff] [blame] | 49 | mCurrentBucketNum(0), |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 50 | mCondition(conditionIndex >= 0 ? false : true), |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 51 | mConditionSliced(false), |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 52 | mWizard(wizard), |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 53 | mConditionTrackerIndex(conditionIndex), |
| 54 | mContainANYPositionInDimensionsInWhat(false), |
| 55 | mSameConditionDimensionsInTracker(false), |
| 56 | mHasLinksToAllConditionDimensionsInTracker(false) { |
| 57 | } |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 58 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 59 | virtual ~MetricProducer(){}; |
| 60 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 61 | /** |
| 62 | * Forces this metric to split into a partial bucket right now. If we're past a full bucket, we |
| 63 | * first call the standard flushing code to flush up to the latest full bucket. Then we call |
| 64 | * the flush again when the end timestamp is forced to be now, and then after flushing, update |
| 65 | * the start timestamp to be now. |
| 66 | */ |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 67 | void notifyAppUpgrade(const int64_t& eventTimeNs, const string& apk, const int uid, |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 68 | const int64_t version) override { |
| 69 | std::lock_guard<std::mutex> lock(mMutex); |
| 70 | |
| 71 | if (eventTimeNs > getCurrentBucketEndTimeNs()) { |
| 72 | // Flush full buckets on the normal path up to the latest bucket boundary. |
| 73 | flushIfNeededLocked(eventTimeNs); |
| 74 | } |
| 75 | // Now flush a partial bucket. |
| 76 | flushCurrentBucketLocked(eventTimeNs); |
| 77 | mCurrentBucketStartTimeNs = eventTimeNs; |
| 78 | // Don't update the current bucket number so that the anomaly tracker knows this bucket |
| 79 | // is a partial bucket and can merge it with the previous bucket. |
| 80 | }; |
| 81 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 82 | void notifyAppRemoved(const int64_t& eventTimeNs, const string& apk, const int uid) override{ |
David Chen | bd12527 | 2018-04-04 19:02:50 -0700 | [diff] [blame] | 83 | // Force buckets to split on removal also. |
| 84 | notifyAppUpgrade(eventTimeNs, apk, uid, 0); |
Yao Chen | d10f7b1 | 2017-12-18 12:53:50 -0800 | [diff] [blame] | 85 | }; |
| 86 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 87 | void onUidMapReceived(const int64_t& eventTimeNs) override{ |
David Chen | bd12527 | 2018-04-04 19:02:50 -0700 | [diff] [blame] | 88 | // Purposefully don't flush partial buckets on a new snapshot. |
| 89 | // This occurs if a new user is added/removed or statsd crashes. |
Yao Chen | d10f7b1 | 2017-12-18 12:53:50 -0800 | [diff] [blame] | 90 | }; |
| 91 | |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 92 | // Consume the parsed stats log entry that already matched the "what" of the metric. |
Chenjie Yu | a7259ab | 2017-12-10 08:31:05 -0800 | [diff] [blame] | 93 | void onMatchedLogEvent(const size_t matcherIndex, const LogEvent& event) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 94 | std::lock_guard<std::mutex> lock(mMutex); |
Chenjie Yu | a7259ab | 2017-12-10 08:31:05 -0800 | [diff] [blame] | 95 | onMatchedLogEventLocked(matcherIndex, event); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 96 | } |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 97 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 98 | void onConditionChanged(const bool condition, const int64_t eventTime) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 99 | std::lock_guard<std::mutex> lock(mMutex); |
| 100 | onConditionChangedLocked(condition, eventTime); |
| 101 | } |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 102 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 103 | void onSlicedConditionMayChange(bool overallCondition, const int64_t eventTime) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 104 | std::lock_guard<std::mutex> lock(mMutex); |
Yao Chen | 427d372 | 2018-03-22 15:21:52 -0700 | [diff] [blame] | 105 | onSlicedConditionMayChangeLocked(overallCondition, eventTime); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | bool isConditionSliced() const { |
| 109 | std::lock_guard<std::mutex> lock(mMutex); |
| 110 | return mConditionSliced; |
| 111 | }; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 112 | |
Yao Chen | 288c600 | 2017-12-12 13:43:18 -0800 | [diff] [blame] | 113 | // Output the metrics data to [protoOutput]. All metrics reports end with the same timestamp. |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 114 | // This method clears all the past buckets. |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 115 | void onDumpReport(const int64_t dumpTimeNs, |
| 116 | const bool include_current_partial_bucket, |
| 117 | android::util::ProtoOutputStream* protoOutput) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 118 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 119 | return onDumpReportLocked(dumpTimeNs, include_current_partial_bucket, protoOutput); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 120 | } |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 121 | |
Yao Chen | 884c8c1 | 2018-01-26 10:36:25 -0800 | [diff] [blame] | 122 | void dumpStates(FILE* out, bool verbose) const { |
| 123 | std::lock_guard<std::mutex> lock(mMutex); |
| 124 | dumpStatesLocked(out, verbose); |
| 125 | } |
| 126 | |
David Chen | 1d7b0cd | 2017-11-15 14:20:04 -0800 | [diff] [blame] | 127 | // Returns the memory in bytes currently used to store this metric's data. Does not change |
| 128 | // state. |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 129 | size_t byteSize() const { |
| 130 | std::lock_guard<std::mutex> lock(mMutex); |
| 131 | return byteSizeLocked(); |
| 132 | } |
yro | 69007c8 | 2017-10-26 20:42:57 -0700 | [diff] [blame] | 133 | |
Bookatz | 1476ef2 | 2018-02-13 12:26:01 -0800 | [diff] [blame] | 134 | /* If alert is valid, adds an AnomalyTracker and returns it. If invalid, returns nullptr. */ |
Yangster-mac | 932ecec | 2018-02-01 10:23:52 -0800 | [diff] [blame] | 135 | virtual sp<AnomalyTracker> addAnomalyTracker(const Alert &alert, |
| 136 | const sp<AlarmMonitor>& anomalyAlarmMonitor) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 137 | std::lock_guard<std::mutex> lock(mMutex); |
Bookatz | 857aaa5 | 2017-12-19 15:29:06 -0800 | [diff] [blame] | 138 | sp<AnomalyTracker> anomalyTracker = new AnomalyTracker(alert, mConfigKey); |
| 139 | if (anomalyTracker != nullptr) { |
| 140 | mAnomalyTrackers.push_back(anomalyTracker); |
| 141 | } |
| 142 | return anomalyTracker; |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | int64_t getBuckeSizeInNs() const { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 146 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 147 | return mBucketSizeNs; |
| 148 | } |
| 149 | |
yro | 59cc24d | 2018-02-13 20:17:32 -0800 | [diff] [blame] | 150 | // Only needed for unit-testing to override guardrail. |
| 151 | void setBucketSize(int64_t bucketSize) { |
| 152 | mBucketSizeNs = bucketSize; |
| 153 | } |
| 154 | |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 155 | inline const int64_t& getMetricId() { |
| 156 | return mMetricId; |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 157 | } |
| 158 | |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 159 | // Let MetricProducer drop in-memory data to save memory. |
| 160 | // We still need to keep future data valid and anomaly tracking work, which means we will |
| 161 | // have to flush old data, informing anomaly trackers then safely drop old data. |
| 162 | // We still keep current bucket data for future metrics' validity. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 163 | void dropData(const int64_t dropTimeNs) { |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 164 | std::lock_guard<std::mutex> lock(mMutex); |
| 165 | dropDataLocked(dropTimeNs); |
| 166 | } |
| 167 | |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame^] | 168 | // For test only. |
| 169 | inline int64_t getCurrentBucketNum() const { |
| 170 | return mCurrentBucketNum; |
| 171 | } |
| 172 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 173 | protected: |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 174 | virtual void onConditionChangedLocked(const bool condition, const int64_t eventTime) = 0; |
Yao Chen | 427d372 | 2018-03-22 15:21:52 -0700 | [diff] [blame] | 175 | virtual void onSlicedConditionMayChangeLocked(bool overallCondition, |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 176 | const int64_t eventTime) = 0; |
| 177 | virtual void onDumpReportLocked(const int64_t dumpTimeNs, |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 178 | const bool include_current_partial_bucket, |
Yao Chen | 288c600 | 2017-12-12 13:43:18 -0800 | [diff] [blame] | 179 | android::util::ProtoOutputStream* protoOutput) = 0; |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 180 | virtual size_t byteSizeLocked() const = 0; |
Yao Chen | 884c8c1 | 2018-01-26 10:36:25 -0800 | [diff] [blame] | 181 | virtual void dumpStatesLocked(FILE* out, bool verbose) const = 0; |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 182 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 183 | /** |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 184 | * Flushes the current bucket if the eventTime is after the current bucket's end time. This will |
| 185 | also flush the current partial bucket in memory. |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 186 | */ |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 187 | virtual void flushIfNeededLocked(const int64_t& eventTime){}; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 188 | |
| 189 | /** |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 190 | * Flushes all the data including the current partial bucket. |
| 191 | */ |
| 192 | virtual void flushLocked(const int64_t& eventTime) { |
| 193 | flushIfNeededLocked(eventTime); |
| 194 | flushCurrentBucketLocked(eventTime); |
| 195 | }; |
| 196 | |
| 197 | /** |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 198 | * For metrics that aggregate (ie, every metric producer except for EventMetricProducer), |
| 199 | * we need to be able to flush the current buckets on demand (ie, end the current bucket and |
| 200 | * start new bucket). If this function is called when eventTimeNs is greater than the current |
| 201 | * bucket's end timestamp, than we flush up to the end of the latest full bucket; otherwise, |
| 202 | * we assume that we want to flush a partial bucket. The bucket start timestamp and bucket |
| 203 | * number are not changed by this function. This method should only be called by |
| 204 | * flushIfNeededLocked or the app upgrade handler; the caller MUST update the bucket timestamp |
| 205 | * and bucket number as needed. |
| 206 | */ |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 207 | virtual void flushCurrentBucketLocked(const int64_t& eventTimeNs){}; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 208 | |
| 209 | // Convenience to compute the current bucket's end time, which is always aligned with the |
| 210 | // start time of the metric. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 211 | int64_t getCurrentBucketEndTimeNs() const { |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame^] | 212 | return mTimeBaseNs + (mCurrentBucketNum + 1) * mBucketSizeNs; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 213 | } |
| 214 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 215 | virtual void dropDataLocked(const int64_t dropTimeNs) = 0; |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 216 | |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 217 | const int64_t mMetricId; |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 218 | |
Yao Chen | b356151 | 2017-11-21 18:07:17 -0800 | [diff] [blame] | 219 | const ConfigKey mConfigKey; |
| 220 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 221 | // The time when this metric producer was first created. The end time for the current bucket |
| 222 | // can be computed from this based on mCurrentBucketNum. |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame^] | 223 | int64_t mTimeBaseNs; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 224 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 225 | // Start time may not be aligned with the start of statsd if there is an app upgrade in the |
| 226 | // middle of a bucket. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 227 | int64_t mCurrentBucketStartTimeNs; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 228 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 229 | // Used by anomaly detector to track which bucket we are in. This is not sent with the produced |
| 230 | // report. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 231 | int64_t mCurrentBucketNum; |
Yang Lu | 3eba621 | 2017-10-25 19:54:45 -0700 | [diff] [blame] | 232 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 233 | int64_t mBucketSizeNs; |
| 234 | |
| 235 | bool mCondition; |
| 236 | |
| 237 | bool mConditionSliced; |
| 238 | |
| 239 | sp<ConditionWizard> mWizard; |
| 240 | |
| 241 | int mConditionTrackerIndex; |
| 242 | |
Yao Chen | 8a8d16c | 2018-02-08 14:50:40 -0800 | [diff] [blame] | 243 | vector<Matcher> mDimensionsInWhat; // The dimensions_in_what defined in statsd_config |
| 244 | vector<Matcher> mDimensionsInCondition; // The dimensions_in_condition defined in statsd_config |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 245 | |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 246 | bool mContainANYPositionInDimensionsInWhat; |
| 247 | |
| 248 | // True iff the condition dimensions equal to the sliced dimensions in the simple condition |
| 249 | // tracker. This field is always false for combinational condition trackers. |
| 250 | bool mSameConditionDimensionsInTracker; |
| 251 | |
| 252 | // True iff the metric to condition links cover all dimension fields in the condition tracker. |
| 253 | // This field is always false for combinational condition trackers. |
| 254 | bool mHasLinksToAllConditionDimensionsInTracker; |
| 255 | |
Yao Chen | 8a8d16c | 2018-02-08 14:50:40 -0800 | [diff] [blame] | 256 | std::vector<Metric2Condition> mMetric2ConditionLinks; |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 257 | |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 258 | std::vector<sp<AnomalyTracker>> mAnomalyTrackers; |
| 259 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 260 | /* |
| 261 | * Individual metrics can implement their own business logic here. All pre-processing is done. |
| 262 | * |
| 263 | * [matcherIndex]: the index of the matcher which matched this event. This is interesting to |
| 264 | * DurationMetric, because it has start/stop/stop_all 3 matchers. |
| 265 | * [eventKey]: the extracted dimension key for the final output. if the metric doesn't have |
| 266 | * dimensions, it will be DEFAULT_DIMENSION_KEY |
| 267 | * [conditionKey]: the keys of conditions which should be used to query the condition for this |
Stefan Lafon | a5b5191 | 2017-12-05 21:43:52 -0800 | [diff] [blame] | 268 | * target event (from MetricConditionLink). This is passed to individual metrics |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 269 | * because DurationMetric needs it to be cached. |
| 270 | * [condition]: whether condition is met. If condition is sliced, this is the result coming from |
| 271 | * query with ConditionWizard; If condition is not sliced, this is the |
| 272 | * nonSlicedCondition. |
| 273 | * [event]: the log event, just in case the metric needs its data, e.g., EventMetric. |
| 274 | */ |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 275 | virtual void onMatchedLogEventInternalLocked( |
Yangster-mac | 9369446 | 2018-01-22 20:49:31 -0800 | [diff] [blame] | 276 | const size_t matcherIndex, const MetricDimensionKey& eventKey, |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 277 | const ConditionKey& conditionKey, bool condition, |
Chenjie Yu | a7259ab | 2017-12-10 08:31:05 -0800 | [diff] [blame] | 278 | const LogEvent& event) = 0; |
yro | 2b0f886 | 2017-11-06 14:27:31 -0800 | [diff] [blame] | 279 | |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 280 | // Consume the parsed stats log entry that already matched the "what" of the metric. |
Yangster-mac | 5392888 | 2018-02-25 23:02:56 -0800 | [diff] [blame] | 281 | virtual void onMatchedLogEventLocked(const size_t matcherIndex, const LogEvent& event); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 282 | |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 283 | mutable std::mutex mMutex; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 284 | }; |
| 285 | |
| 286 | } // namespace statsd |
| 287 | } // namespace os |
| 288 | } // namespace android |
| 289 | #endif // METRIC_PRODUCER_H |