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 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 37 | // If the metric has no activation requirement, it will be active once the metric producer is |
| 38 | // created. |
| 39 | // If the metric needs to be activated by atoms, the metric producer will start |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 40 | // with kNotActive state, turn to kActive or kActiveOnBoot when the activation event arrives, become |
| 41 | // kNotActive when it reaches the duration limit (timebomb). If the activation event arrives again |
| 42 | // before or after it expires, the event producer will be re-activated and ttl will be reset. |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 43 | enum ActivationState { |
| 44 | kNotActive = 0, |
| 45 | kActive = 1, |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 46 | kActiveOnBoot = 2, |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 47 | }; |
| 48 | |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 49 | enum DumpLatency { |
| 50 | // In some cases, we only have a short time range to do the dump, e.g. statsd is being killed. |
| 51 | // We might be able to return all the data in this mode. For instance, pull metrics might need |
| 52 | // to be pulled when the current bucket is requested. |
| 53 | FAST = 1, |
| 54 | // In other cases, it is fine for a dump to take more than a few milliseconds, e.g. config |
| 55 | // updates. |
| 56 | NO_TIME_CONSTRAINTS = 2 |
| 57 | }; |
| 58 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 59 | // 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] | 60 | // writing the report to dropbox. MetricProducers should respond to package changes as required in |
| 61 | // PackageInfoListener, but if none of the metrics are slicing by package name, then the update can |
| 62 | // be a no-op. |
David Chen | f12b5c6 | 2017-10-13 15:54:03 -0700 | [diff] [blame] | 63 | class MetricProducer : public virtual PackageInfoListener { |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 64 | public: |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame] | 65 | MetricProducer(const int64_t& metricId, const ConfigKey& key, const int64_t timeBaseNs, |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 66 | const int conditionIndex, const sp<ConditionWizard>& wizard) |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 67 | : mMetricId(metricId), |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 68 | mConfigKey(key), |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame] | 69 | mTimeBaseNs(timeBaseNs), |
| 70 | mCurrentBucketStartTimeNs(timeBaseNs), |
Yang Lu | 3eba621 | 2017-10-25 19:54:45 -0700 | [diff] [blame] | 71 | mCurrentBucketNum(0), |
Olivier Gaillard | e35b282 | 2019-02-27 17:09:40 +0000 | [diff] [blame] | 72 | mCondition(initialCondition(conditionIndex)), |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 73 | mConditionSliced(false), |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 74 | mWizard(wizard), |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 75 | mConditionTrackerIndex(conditionIndex), |
| 76 | mContainANYPositionInDimensionsInWhat(false), |
Yangster-mac | 9def8e3 | 2018-04-17 13:55:51 -0700 | [diff] [blame] | 77 | mSliceByPositionALL(false), |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 78 | mSameConditionDimensionsInTracker(false), |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 79 | mHasLinksToAllConditionDimensionsInTracker(false), |
| 80 | mIsActive(true) { |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 81 | } |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 82 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 83 | virtual ~MetricProducer(){}; |
| 84 | |
Olivier Gaillard | e35b282 | 2019-02-27 17:09:40 +0000 | [diff] [blame] | 85 | ConditionState initialCondition(const int conditionIndex) const { |
| 86 | return conditionIndex >= 0 ? ConditionState::kUnknown : ConditionState::kTrue; |
| 87 | } |
| 88 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 89 | /** |
| 90 | * Forces this metric to split into a partial bucket right now. If we're past a full bucket, we |
| 91 | * first call the standard flushing code to flush up to the latest full bucket. Then we call |
| 92 | * the flush again when the end timestamp is forced to be now, and then after flushing, update |
| 93 | * the start timestamp to be now. |
| 94 | */ |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 95 | void notifyAppUpgrade(const int64_t& eventTimeNs, const string& apk, const int uid, |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 96 | const int64_t version) override { |
| 97 | std::lock_guard<std::mutex> lock(mMutex); |
| 98 | |
| 99 | if (eventTimeNs > getCurrentBucketEndTimeNs()) { |
| 100 | // Flush full buckets on the normal path up to the latest bucket boundary. |
| 101 | flushIfNeededLocked(eventTimeNs); |
| 102 | } |
| 103 | // Now flush a partial bucket. |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 104 | flushCurrentBucketLocked(eventTimeNs, eventTimeNs); |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 105 | // Don't update the current bucket number so that the anomaly tracker knows this bucket |
| 106 | // is a partial bucket and can merge it with the previous bucket. |
| 107 | }; |
| 108 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 109 | 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] | 110 | // Force buckets to split on removal also. |
| 111 | notifyAppUpgrade(eventTimeNs, apk, uid, 0); |
Yao Chen | d10f7b1 | 2017-12-18 12:53:50 -0800 | [diff] [blame] | 112 | }; |
| 113 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 114 | void onUidMapReceived(const int64_t& eventTimeNs) override{ |
David Chen | bd12527 | 2018-04-04 19:02:50 -0700 | [diff] [blame] | 115 | // Purposefully don't flush partial buckets on a new snapshot. |
| 116 | // This occurs if a new user is added/removed or statsd crashes. |
Yao Chen | d10f7b1 | 2017-12-18 12:53:50 -0800 | [diff] [blame] | 117 | }; |
| 118 | |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 119 | // 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] | 120 | void onMatchedLogEvent(const size_t matcherIndex, const LogEvent& event) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 121 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 122 | if (mIsActive) { |
| 123 | onMatchedLogEventLocked(matcherIndex, event); |
| 124 | } |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 125 | } |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 126 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 127 | void onConditionChanged(const bool condition, const int64_t eventTime) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 128 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 129 | if (mIsActive) { |
| 130 | onConditionChangedLocked(condition, eventTime); |
| 131 | } |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 132 | } |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 133 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 134 | void onSlicedConditionMayChange(bool overallCondition, const int64_t eventTime) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 135 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 136 | if (mIsActive) { |
| 137 | onSlicedConditionMayChangeLocked(overallCondition, eventTime); |
| 138 | } |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | bool isConditionSliced() const { |
| 142 | std::lock_guard<std::mutex> lock(mMutex); |
| 143 | return mConditionSliced; |
| 144 | }; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 145 | |
Yao Chen | 288c600 | 2017-12-12 13:43:18 -0800 | [diff] [blame] | 146 | // 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] | 147 | // This method clears all the past buckets. |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 148 | void onDumpReport(const int64_t dumpTimeNs, |
| 149 | const bool include_current_partial_bucket, |
Bookatz | ff71cad | 2018-09-20 17:17:49 -0700 | [diff] [blame] | 150 | const bool erase_data, |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 151 | const DumpLatency dumpLatency, |
Yangster-mac | 9def8e3 | 2018-04-17 13:55:51 -0700 | [diff] [blame] | 152 | std::set<string> *str_set, |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 153 | android::util::ProtoOutputStream* protoOutput) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 154 | std::lock_guard<std::mutex> lock(mMutex); |
Bookatz | ff71cad | 2018-09-20 17:17:49 -0700 | [diff] [blame] | 155 | return onDumpReportLocked(dumpTimeNs, include_current_partial_bucket, erase_data, |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 156 | dumpLatency, str_set, protoOutput); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 157 | } |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 158 | |
Yangster-mac | a802d73 | 2018-04-24 07:50:38 -0700 | [diff] [blame] | 159 | void clearPastBuckets(const int64_t dumpTimeNs) { |
| 160 | std::lock_guard<std::mutex> lock(mMutex); |
| 161 | return clearPastBucketsLocked(dumpTimeNs); |
| 162 | } |
| 163 | |
Yao Chen | 884c8c1 | 2018-01-26 10:36:25 -0800 | [diff] [blame] | 164 | void dumpStates(FILE* out, bool verbose) const { |
| 165 | std::lock_guard<std::mutex> lock(mMutex); |
| 166 | dumpStatesLocked(out, verbose); |
| 167 | } |
| 168 | |
David Chen | 1d7b0cd | 2017-11-15 14:20:04 -0800 | [diff] [blame] | 169 | // Returns the memory in bytes currently used to store this metric's data. Does not change |
| 170 | // state. |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 171 | size_t byteSize() const { |
| 172 | std::lock_guard<std::mutex> lock(mMutex); |
| 173 | return byteSizeLocked(); |
| 174 | } |
yro | 69007c8 | 2017-10-26 20:42:57 -0700 | [diff] [blame] | 175 | |
Bookatz | 1476ef2 | 2018-02-13 12:26:01 -0800 | [diff] [blame] | 176 | /* 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] | 177 | virtual sp<AnomalyTracker> addAnomalyTracker(const Alert &alert, |
| 178 | const sp<AlarmMonitor>& anomalyAlarmMonitor) { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 179 | std::lock_guard<std::mutex> lock(mMutex); |
Bookatz | 857aaa5 | 2017-12-19 15:29:06 -0800 | [diff] [blame] | 180 | sp<AnomalyTracker> anomalyTracker = new AnomalyTracker(alert, mConfigKey); |
| 181 | if (anomalyTracker != nullptr) { |
| 182 | mAnomalyTrackers.push_back(anomalyTracker); |
| 183 | } |
| 184 | return anomalyTracker; |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | int64_t getBuckeSizeInNs() const { |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 188 | std::lock_guard<std::mutex> lock(mMutex); |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 189 | return mBucketSizeNs; |
| 190 | } |
| 191 | |
yro | 59cc24d | 2018-02-13 20:17:32 -0800 | [diff] [blame] | 192 | // Only needed for unit-testing to override guardrail. |
| 193 | void setBucketSize(int64_t bucketSize) { |
| 194 | mBucketSizeNs = bucketSize; |
| 195 | } |
| 196 | |
Chenjie Yu | c7939cb | 2019-02-04 17:25:45 -0800 | [diff] [blame] | 197 | inline const int64_t& getMetricId() const { |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 198 | return mMetricId; |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 199 | } |
| 200 | |
Chenjie Yu | c7939cb | 2019-02-04 17:25:45 -0800 | [diff] [blame] | 201 | int64_t getRemainingTtlNs(int64_t currentTimeNs) const { |
| 202 | std::lock_guard<std::mutex> lock(mMutex); |
| 203 | return getRemainingTtlNsLocked(currentTimeNs); |
| 204 | } |
| 205 | |
| 206 | // Set metric to active for ttlNs. |
| 207 | void setActive(int64_t currentTimeNs, int64_t remainingTtlNs) { |
| 208 | std::lock_guard<std::mutex> lock(mMutex); |
| 209 | setActiveLocked(currentTimeNs, remainingTtlNs); |
| 210 | } |
| 211 | |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 212 | // Let MetricProducer drop in-memory data to save memory. |
| 213 | // We still need to keep future data valid and anomaly tracking work, which means we will |
| 214 | // have to flush old data, informing anomaly trackers then safely drop old data. |
| 215 | // We still keep current bucket data for future metrics' validity. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 216 | void dropData(const int64_t dropTimeNs) { |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 217 | std::lock_guard<std::mutex> lock(mMutex); |
| 218 | dropDataLocked(dropTimeNs); |
| 219 | } |
| 220 | |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame] | 221 | // For test only. |
| 222 | inline int64_t getCurrentBucketNum() const { |
| 223 | return mCurrentBucketNum; |
| 224 | } |
| 225 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 226 | void activate(int activationTrackerIndex, int64_t elapsedTimestampNs) { |
| 227 | std::lock_guard<std::mutex> lock(mMutex); |
| 228 | activateLocked(activationTrackerIndex, elapsedTimestampNs); |
| 229 | } |
| 230 | |
Chenjie Yu | c7939cb | 2019-02-04 17:25:45 -0800 | [diff] [blame] | 231 | bool isActive() const { |
| 232 | std::lock_guard<std::mutex> lock(mMutex); |
| 233 | return isActiveLocked(); |
| 234 | } |
| 235 | |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 236 | void prepActiveForBootIfNecessary(int64_t currentTimeNs) { |
| 237 | std::lock_guard<std::mutex> lock(mMutex); |
| 238 | prepActiveForBootIfNecessaryLocked(currentTimeNs); |
| 239 | } |
| 240 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 241 | void addActivation(int activationTrackerIndex, int64_t ttl_seconds); |
| 242 | |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 243 | inline void setActivationType(const MetricActivation::ActivationType& activationType) { |
| 244 | mActivationType = activationType; |
| 245 | } |
| 246 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 247 | void flushIfExpire(int64_t elapsedTimestampNs); |
| 248 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 249 | protected: |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 250 | virtual void onConditionChangedLocked(const bool condition, const int64_t eventTime) = 0; |
Yao Chen | 427d372 | 2018-03-22 15:21:52 -0700 | [diff] [blame] | 251 | virtual void onSlicedConditionMayChangeLocked(bool overallCondition, |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 252 | const int64_t eventTime) = 0; |
| 253 | virtual void onDumpReportLocked(const int64_t dumpTimeNs, |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 254 | const bool include_current_partial_bucket, |
Bookatz | ff71cad | 2018-09-20 17:17:49 -0700 | [diff] [blame] | 255 | const bool erase_data, |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 256 | const DumpLatency dumpLatency, |
Yangster-mac | 9def8e3 | 2018-04-17 13:55:51 -0700 | [diff] [blame] | 257 | std::set<string> *str_set, |
Yao Chen | 288c600 | 2017-12-12 13:43:18 -0800 | [diff] [blame] | 258 | android::util::ProtoOutputStream* protoOutput) = 0; |
Yangster-mac | a802d73 | 2018-04-24 07:50:38 -0700 | [diff] [blame] | 259 | virtual void clearPastBucketsLocked(const int64_t dumpTimeNs) = 0; |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 260 | virtual size_t byteSizeLocked() const = 0; |
Yao Chen | 884c8c1 | 2018-01-26 10:36:25 -0800 | [diff] [blame] | 261 | virtual void dumpStatesLocked(FILE* out, bool verbose) const = 0; |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 262 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 263 | bool evaluateActiveStateLocked(int64_t elapsedTimestampNs); |
| 264 | |
| 265 | void activateLocked(int activationTrackerIndex, int64_t elapsedTimestampNs); |
| 266 | |
Yang Lu | b472291 | 2018-11-15 11:02:03 -0800 | [diff] [blame] | 267 | inline bool isActiveLocked() const { |
| 268 | return mIsActive; |
| 269 | } |
| 270 | |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 271 | void prepActiveForBootIfNecessaryLocked(int64_t currentTimeNs); |
| 272 | |
Chenjie Yu | c7939cb | 2019-02-04 17:25:45 -0800 | [diff] [blame] | 273 | int64_t getRemainingTtlNsLocked(int64_t currentTimeNs) const; |
| 274 | |
| 275 | void setActiveLocked(int64_t currentTimeNs, int64_t remainingTtlNs); |
| 276 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 277 | /** |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 278 | * Flushes the current bucket if the eventTime is after the current bucket's end time. This will |
| 279 | also flush the current partial bucket in memory. |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 280 | */ |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 281 | virtual void flushIfNeededLocked(const int64_t& eventTime){}; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 282 | |
| 283 | /** |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 284 | * Flushes all the data including the current partial bucket. |
| 285 | */ |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 286 | virtual void flushLocked(const int64_t& eventTimeNs) { |
| 287 | flushIfNeededLocked(eventTimeNs); |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 288 | flushCurrentBucketLocked(eventTimeNs, eventTimeNs); |
Yangster-mac | e68f3a5 | 2018-04-04 00:01:43 -0700 | [diff] [blame] | 289 | }; |
| 290 | |
| 291 | /** |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 292 | * For metrics that aggregate (ie, every metric producer except for EventMetricProducer), |
| 293 | * we need to be able to flush the current buckets on demand (ie, end the current bucket and |
| 294 | * start new bucket). If this function is called when eventTimeNs is greater than the current |
| 295 | * bucket's end timestamp, than we flush up to the end of the latest full bucket; otherwise, |
| 296 | * we assume that we want to flush a partial bucket. The bucket start timestamp and bucket |
| 297 | * number are not changed by this function. This method should only be called by |
| 298 | * flushIfNeededLocked or the app upgrade handler; the caller MUST update the bucket timestamp |
| 299 | * and bucket number as needed. |
| 300 | */ |
Olivier Gaillard | 6c75ecd | 2019-02-20 09:57:33 +0000 | [diff] [blame] | 301 | virtual void flushCurrentBucketLocked(const int64_t& eventTimeNs, |
| 302 | const int64_t& nextBucketStartTimeNs) {}; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 303 | |
| 304 | // Convenience to compute the current bucket's end time, which is always aligned with the |
| 305 | // start time of the metric. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 306 | int64_t getCurrentBucketEndTimeNs() const { |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame] | 307 | return mTimeBaseNs + (mCurrentBucketNum + 1) * mBucketSizeNs; |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 308 | } |
| 309 | |
Yangster-mac | 9def8e3 | 2018-04-17 13:55:51 -0700 | [diff] [blame] | 310 | int64_t getBucketNumFromEndTimeNs(const int64_t endNs) { |
| 311 | return (endNs - mTimeBaseNs) / mBucketSizeNs - 1; |
| 312 | } |
| 313 | |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 314 | virtual void dropDataLocked(const int64_t dropTimeNs) = 0; |
Yao Chen | 06dba5d | 2018-01-26 13:38:16 -0800 | [diff] [blame] | 315 | |
Yangster-mac | 94e197c | 2018-01-02 16:03:03 -0800 | [diff] [blame] | 316 | const int64_t mMetricId; |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 317 | |
Yao Chen | b356151 | 2017-11-21 18:07:17 -0800 | [diff] [blame] | 318 | const ConfigKey mConfigKey; |
| 319 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 320 | // The time when this metric producer was first created. The end time for the current bucket |
| 321 | // can be computed from this based on mCurrentBucketNum. |
Yangster-mac | 15f6bbc | 2018-04-08 11:52:26 -0700 | [diff] [blame] | 322 | int64_t mTimeBaseNs; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 323 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 324 | // Start time may not be aligned with the start of statsd if there is an app upgrade in the |
| 325 | // middle of a bucket. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 326 | int64_t mCurrentBucketStartTimeNs; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 327 | |
David Chen | 27785a8 | 2018-01-19 17:06:45 -0800 | [diff] [blame] | 328 | // Used by anomaly detector to track which bucket we are in. This is not sent with the produced |
| 329 | // report. |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 330 | int64_t mCurrentBucketNum; |
Yang Lu | 3eba621 | 2017-10-25 19:54:45 -0700 | [diff] [blame] | 331 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 332 | int64_t mBucketSizeNs; |
| 333 | |
Olivier Gaillard | e63d9e0 | 2019-02-12 14:43:59 +0000 | [diff] [blame] | 334 | ConditionState mCondition; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 335 | |
| 336 | bool mConditionSliced; |
| 337 | |
| 338 | sp<ConditionWizard> mWizard; |
| 339 | |
| 340 | int mConditionTrackerIndex; |
| 341 | |
Yao Chen | 8a8d16c | 2018-02-08 14:50:40 -0800 | [diff] [blame] | 342 | vector<Matcher> mDimensionsInWhat; // The dimensions_in_what defined in statsd_config |
| 343 | vector<Matcher> mDimensionsInCondition; // The dimensions_in_condition defined in statsd_config |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 344 | |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 345 | bool mContainANYPositionInDimensionsInWhat; |
Yangster-mac | 9def8e3 | 2018-04-17 13:55:51 -0700 | [diff] [blame] | 346 | bool mSliceByPositionALL; |
Yangster | 13fb7e4 | 2018-03-07 17:30:49 -0800 | [diff] [blame] | 347 | |
| 348 | // True iff the condition dimensions equal to the sliced dimensions in the simple condition |
| 349 | // tracker. This field is always false for combinational condition trackers. |
| 350 | bool mSameConditionDimensionsInTracker; |
| 351 | |
| 352 | // True iff the metric to condition links cover all dimension fields in the condition tracker. |
| 353 | // This field is always false for combinational condition trackers. |
| 354 | bool mHasLinksToAllConditionDimensionsInTracker; |
| 355 | |
Yao Chen | 8a8d16c | 2018-02-08 14:50:40 -0800 | [diff] [blame] | 356 | std::vector<Metric2Condition> mMetric2ConditionLinks; |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 357 | |
Yangster-mac | e2cd6d5 | 2017-11-09 20:38:30 -0800 | [diff] [blame] | 358 | std::vector<sp<AnomalyTracker>> mAnomalyTrackers; |
| 359 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 360 | /* |
| 361 | * Individual metrics can implement their own business logic here. All pre-processing is done. |
| 362 | * |
| 363 | * [matcherIndex]: the index of the matcher which matched this event. This is interesting to |
| 364 | * DurationMetric, because it has start/stop/stop_all 3 matchers. |
| 365 | * [eventKey]: the extracted dimension key for the final output. if the metric doesn't have |
| 366 | * dimensions, it will be DEFAULT_DIMENSION_KEY |
| 367 | * [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] | 368 | * target event (from MetricConditionLink). This is passed to individual metrics |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 369 | * because DurationMetric needs it to be cached. |
| 370 | * [condition]: whether condition is met. If condition is sliced, this is the result coming from |
| 371 | * query with ConditionWizard; If condition is not sliced, this is the |
| 372 | * nonSlicedCondition. |
| 373 | * [event]: the log event, just in case the metric needs its data, e.g., EventMetric. |
| 374 | */ |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 375 | virtual void onMatchedLogEventInternalLocked( |
Yangster-mac | 9369446 | 2018-01-22 20:49:31 -0800 | [diff] [blame] | 376 | const size_t matcherIndex, const MetricDimensionKey& eventKey, |
Yangster-mac | 2087716 | 2017-12-22 17:19:39 -0800 | [diff] [blame] | 377 | const ConditionKey& conditionKey, bool condition, |
Chenjie Yu | a7259ab | 2017-12-10 08:31:05 -0800 | [diff] [blame] | 378 | const LogEvent& event) = 0; |
yro | 2b0f886 | 2017-11-06 14:27:31 -0800 | [diff] [blame] | 379 | |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 380 | // 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] | 381 | virtual void onMatchedLogEventLocked(const size_t matcherIndex, const LogEvent& event); |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 382 | |
Yangster | f2bee6f | 2017-11-29 12:01:05 -0800 | [diff] [blame] | 383 | mutable std::mutex mMutex; |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 384 | |
| 385 | struct Activation { |
| 386 | Activation() : ttl_ns(0), activation_ns(0), state(ActivationState::kNotActive) {} |
| 387 | |
| 388 | int64_t ttl_ns; |
| 389 | int64_t activation_ns; |
| 390 | ActivationState state; |
| 391 | }; |
| 392 | // When the metric producer has multiple activations, these activations are ORed to determine |
| 393 | // whether the metric producer is ready to generate metrics. |
| 394 | std::unordered_map<int, Activation> mEventActivationMap; |
| 395 | |
| 396 | bool mIsActive; |
| 397 | |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 398 | MetricActivation::ActivationType mActivationType; |
| 399 | |
Yangster-mac | 849dfdc2 | 2018-10-12 15:41:45 -0700 | [diff] [blame] | 400 | FRIEND_TEST(MetricActivationE2eTest, TestCountMetric); |
Chenjie Yu | c7939cb | 2019-02-04 17:25:45 -0800 | [diff] [blame] | 401 | |
| 402 | FRIEND_TEST(StatsLogProcessorTest, TestActiveConfigMetricDiskWriteRead); |
Chenjie Yu | a9a310e | 2019-02-06 13:40:10 -0800 | [diff] [blame] | 403 | FRIEND_TEST(StatsLogProcessorTest, TestActivationOnBoot); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 404 | }; |
| 405 | |
| 406 | } // namespace statsd |
| 407 | } // namespace os |
| 408 | } // namespace android |
| 409 | #endif // METRIC_PRODUCER_H |