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 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 17 | #define DEBUG true // STOPSHIP if true |
Joe Onorato | 9fc9edf | 2017-10-15 20:08:52 -0700 | [diff] [blame] | 18 | #include "Log.h" |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 19 | |
Bookatz | a4bc9c4 | 2017-10-04 11:45:57 -0700 | [diff] [blame] | 20 | #include "CountAnomalyTracker.h" |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 21 | #include "CountMetricProducer.h" |
| 22 | #include "stats_util.h" |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 23 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 24 | #include <limits.h> |
| 25 | #include <stdlib.h> |
| 26 | |
yro | 2b0f886 | 2017-11-06 14:27:31 -0800 | [diff] [blame^] | 27 | using android::util::FIELD_TYPE_BOOL; |
| 28 | using android::util::FIELD_TYPE_FLOAT; |
| 29 | using android::util::FIELD_TYPE_INT32; |
| 30 | using android::util::FIELD_TYPE_INT64; |
| 31 | using android::util::FIELD_TYPE_MESSAGE; |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 32 | using android::util::ProtoOutputStream; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 33 | using std::map; |
| 34 | using std::string; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 35 | using std::unordered_map; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 36 | using std::vector; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 37 | |
| 38 | namespace android { |
| 39 | namespace os { |
| 40 | namespace statsd { |
| 41 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 42 | // for StatsLogReport |
| 43 | const int FIELD_ID_METRIC_ID = 1; |
| 44 | const int FIELD_ID_START_REPORT_NANOS = 2; |
| 45 | const int FIELD_ID_END_REPORT_NANOS = 3; |
| 46 | const int FIELD_ID_COUNT_METRICS = 5; |
| 47 | // for CountMetricDataWrapper |
| 48 | const int FIELD_ID_DATA = 1; |
| 49 | // for CountMetricData |
| 50 | const int FIELD_ID_DIMENSION = 1; |
| 51 | const int FIELD_ID_BUCKET_INFO = 2; |
| 52 | // for KeyValuePair |
| 53 | const int FIELD_ID_KEY = 1; |
| 54 | const int FIELD_ID_VALUE_STR = 2; |
| 55 | const int FIELD_ID_VALUE_INT = 3; |
| 56 | const int FIELD_ID_VALUE_BOOL = 4; |
| 57 | const int FIELD_ID_VALUE_FLOAT = 5; |
| 58 | // for CountBucketInfo |
| 59 | const int FIELD_ID_START_BUCKET_NANOS = 1; |
| 60 | const int FIELD_ID_END_BUCKET_NANOS = 2; |
| 61 | const int FIELD_ID_COUNT = 3; |
| 62 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 63 | // TODO: add back AnomalyTracker. |
| 64 | CountMetricProducer::CountMetricProducer(const CountMetric& metric, const int conditionIndex, |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 65 | const sp<ConditionWizard>& wizard, |
| 66 | const uint64_t startTimeNs) |
| 67 | : MetricProducer(startTimeNs, conditionIndex, wizard), mMetric(metric) { |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 68 | // TODO: evaluate initial conditions. and set mConditionMet. |
| 69 | if (metric.has_bucket() && metric.bucket().has_bucket_size_millis()) { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 70 | mBucketSizeNs = metric.bucket().bucket_size_millis() * 1000 * 1000; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 71 | } else { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 72 | mBucketSizeNs = LLONG_MAX; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 73 | } |
| 74 | |
Bookatz | d3606c7 | 2017-10-19 10:13:49 -0700 | [diff] [blame] | 75 | mAnomalyTrackers.reserve(metric.alerts_size()); |
| 76 | for (int i = 0; i < metric.alerts_size(); i++) { |
| 77 | const Alert& alert = metric.alerts(i); |
| 78 | if (alert.trigger_if_sum_gt() > 0 && alert.number_of_buckets() > 0) { |
| 79 | mAnomalyTrackers.push_back(std::make_unique<CountAnomalyTracker>(alert)); |
| 80 | } else { |
| 81 | ALOGW("Ignoring invalid count metric alert: threshold=%lld num_buckets= %d", |
| 82 | alert.trigger_if_sum_gt(), alert.number_of_buckets()); |
| 83 | } |
| 84 | } |
| 85 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 86 | // TODO: use UidMap if uid->pkg_name is required |
| 87 | mDimension.insert(mDimension.begin(), metric.dimension().begin(), metric.dimension().end()); |
| 88 | |
| 89 | if (metric.links().size() > 0) { |
| 90 | mConditionLinks.insert(mConditionLinks.begin(), metric.links().begin(), |
| 91 | metric.links().end()); |
| 92 | mConditionSliced = true; |
| 93 | } |
| 94 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 95 | startNewProtoOutputStream(mStartTimeNs); |
| 96 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 97 | VLOG("metric %lld created. bucket size %lld start_time: %lld", metric.metric_id(), |
| 98 | (long long)mBucketSizeNs, (long long)mStartTimeNs); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 99 | } |
| 100 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 101 | CountMetricProducer::~CountMetricProducer() { |
| 102 | VLOG("~CountMetricProducer() called"); |
| 103 | } |
| 104 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 105 | void CountMetricProducer::startNewProtoOutputStream(long long startTime) { |
| 106 | mProto = std::make_unique<ProtoOutputStream>(); |
| 107 | mProto->write(FIELD_TYPE_INT32 | FIELD_ID_METRIC_ID, mMetric.metric_id()); |
| 108 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_START_REPORT_NANOS, startTime); |
| 109 | mProtoToken = mProto->start(FIELD_TYPE_MESSAGE | FIELD_ID_COUNT_METRICS); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 110 | } |
| 111 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 112 | void CountMetricProducer::finish() { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 113 | } |
| 114 | |
Yao Chen | 5154a37 | 2017-10-30 22:57:06 -0700 | [diff] [blame] | 115 | void CountMetricProducer::onSlicedConditionMayChange(const uint64_t eventTime) { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 116 | VLOG("Metric %lld onSlicedConditionMayChange", mMetric.metric_id()); |
| 117 | } |
| 118 | |
| 119 | StatsLogReport CountMetricProducer::onDumpReport() { |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 120 | long long endTime = time(nullptr) * NS_PER_SEC; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 121 | |
| 122 | // Dump current bucket if it's stale. |
| 123 | // If current bucket is still on-going, don't force dump current bucket. |
| 124 | // In finish(), We can force dump current bucket. |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 125 | flushCounterIfNeeded(endTime); |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 126 | VLOG("metric %lld dump report now...", mMetric.metric_id()); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 127 | |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 128 | for (const auto& counter : mPastBuckets) { |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 129 | const HashableDimensionKey& hashableKey = counter.first; |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 130 | VLOG(" dimension key %s", hashableKey.c_str()); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 131 | auto it = mDimensionKeyMap.find(hashableKey); |
| 132 | if (it == mDimensionKeyMap.end()) { |
| 133 | ALOGE("Dimension key %s not found?!?! skip...", hashableKey.c_str()); |
| 134 | continue; |
| 135 | } |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 136 | long long wrapperToken = mProto->start(FIELD_TYPE_MESSAGE | FIELD_ID_DATA); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 137 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 138 | // First fill dimension (KeyValuePairs). |
| 139 | for (const auto& kv : it->second) { |
| 140 | long long dimensionToken = mProto->start(FIELD_TYPE_MESSAGE | FIELD_ID_DIMENSION); |
| 141 | mProto->write(FIELD_TYPE_INT32 | FIELD_ID_KEY, kv.key()); |
| 142 | if (kv.has_value_str()) { |
| 143 | mProto->write(FIELD_TYPE_INT32 | FIELD_ID_VALUE_STR, kv.value_str()); |
| 144 | } else if (kv.has_value_int()) { |
| 145 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_VALUE_INT, kv.value_int()); |
| 146 | } else if (kv.has_value_bool()) { |
| 147 | mProto->write(FIELD_TYPE_BOOL | FIELD_ID_VALUE_BOOL, kv.value_bool()); |
| 148 | } else if (kv.has_value_float()) { |
| 149 | mProto->write(FIELD_TYPE_FLOAT | FIELD_ID_VALUE_FLOAT, kv.value_float()); |
| 150 | } |
| 151 | mProto->end(dimensionToken); |
| 152 | } |
| 153 | |
| 154 | // Then fill bucket_info (CountBucketInfo). |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 155 | for (const auto& bucket : counter.second) { |
| 156 | long long bucketInfoToken = mProto->start(FIELD_TYPE_MESSAGE | FIELD_ID_BUCKET_INFO); |
| 157 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_START_BUCKET_NANOS, |
| 158 | (long long)bucket.mBucketStartNs); |
| 159 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_END_BUCKET_NANOS, |
| 160 | (long long)bucket.mBucketEndNs); |
| 161 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_COUNT, (long long)bucket.mCount); |
| 162 | mProto->end(bucketInfoToken); |
| 163 | VLOG("\t bucket [%lld - %lld] count: %lld", (long long)bucket.mBucketStartNs, |
| 164 | (long long)bucket.mBucketEndNs, (long long)bucket.mCount); |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 165 | } |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 166 | mProto->end(wrapperToken); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 167 | } |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 168 | |
| 169 | mProto->end(mProtoToken); |
| 170 | mProto->write(FIELD_TYPE_INT64 | FIELD_ID_END_REPORT_NANOS, |
| 171 | (long long)mCurrentBucketStartTimeNs); |
| 172 | |
yro | 2b0f886 | 2017-11-06 14:27:31 -0800 | [diff] [blame^] | 173 | VLOG("metric %lld dump report now...", mMetric.metric_id()); |
| 174 | std::unique_ptr<uint8_t[]> buffer = serializeProto(); |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 175 | |
| 176 | startNewProtoOutputStream(endTime); |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 177 | mPastBuckets.clear(); |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 178 | mByteSize = 0; |
| 179 | |
| 180 | // TODO: Once we migrate all MetricProducers to use ProtoOutputStream, we should return this: |
| 181 | // return std::move(buffer); |
| 182 | return StatsLogReport(); |
| 183 | |
| 184 | // TODO: Clear mDimensionKeyMap once the report is dumped. |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 185 | } |
| 186 | |
Yao Chen | 5154a37 | 2017-10-30 22:57:06 -0700 | [diff] [blame] | 187 | void CountMetricProducer::onConditionChanged(const bool conditionMet, const uint64_t eventTime) { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 188 | VLOG("Metric %lld onConditionChanged", mMetric.metric_id()); |
Yao Chen | caf339d | 2017-10-06 16:01:10 -0700 | [diff] [blame] | 189 | mCondition = conditionMet; |
| 190 | } |
| 191 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 192 | void CountMetricProducer::onMatchedLogEventInternal( |
| 193 | const size_t matcherIndex, const HashableDimensionKey& eventKey, |
| 194 | const map<string, HashableDimensionKey>& conditionKey, bool condition, |
Chenjie Yu | b3dda41 | 2017-10-24 13:41:59 -0700 | [diff] [blame] | 195 | const LogEvent& event, bool scheduledPull) { |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 196 | uint64_t eventTimeNs = event.GetTimestampNs(); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 197 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 198 | flushCounterIfNeeded(eventTimeNs); |
| 199 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 200 | if (condition == false) { |
| 201 | return; |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 202 | } |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 203 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 204 | auto it = mCurrentSlicedCounter.find(eventKey); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 205 | |
| 206 | if (it == mCurrentSlicedCounter.end()) { |
| 207 | // create a counter for the new key |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 208 | mCurrentSlicedCounter[eventKey] = 1; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 209 | |
| 210 | } else { |
| 211 | // increment the existing value |
| 212 | auto& count = it->second; |
| 213 | count++; |
| 214 | } |
| 215 | |
Bookatz | d3606c7 | 2017-10-19 10:13:49 -0700 | [diff] [blame] | 216 | // TODO: Re-add anomaly detection (similar to): |
| 217 | // for (auto& tracker : mAnomalyTrackers) { |
| 218 | // tracker->checkAnomaly(mCounter); |
| 219 | // } |
| 220 | |
Yao Chen | b704177 | 2017-10-20 16:59:25 -0700 | [diff] [blame] | 221 | VLOG("metric %lld %s->%d", mMetric.metric_id(), eventKey.c_str(), |
| 222 | mCurrentSlicedCounter[eventKey]); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 223 | } |
| 224 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 225 | // When a new matched event comes in, we check if event falls into the current |
| 226 | // bucket. If not, flush the old counter to past buckets and initialize the new bucket. |
| 227 | void CountMetricProducer::flushCounterIfNeeded(const uint64_t eventTimeNs) { |
| 228 | if (mCurrentBucketStartTimeNs + mBucketSizeNs > eventTimeNs) { |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 229 | return; |
| 230 | } |
| 231 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 232 | // adjust the bucket start time |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 233 | int64_t numBucketsForward = (eventTimeNs - mCurrentBucketStartTimeNs) / mBucketSizeNs; |
Bookatz | a4bc9c4 | 2017-10-04 11:45:57 -0700 | [diff] [blame] | 234 | |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 235 | CountBucket info; |
| 236 | info.mBucketStartNs = mCurrentBucketStartTimeNs; |
| 237 | info.mBucketEndNs = mCurrentBucketStartTimeNs + mBucketSizeNs; |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 238 | for (const auto& counter : mCurrentSlicedCounter) { |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 239 | info.mCount = counter.second; |
| 240 | auto& bucketList = mPastBuckets[counter.first]; |
| 241 | bucketList.push_back(info); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 242 | VLOG("metric %lld, dump key value: %s -> %d", mMetric.metric_id(), counter.first.c_str(), |
| 243 | counter.second); |
Yao Chen | 93fe3a3 | 2017-11-02 13:52:59 -0700 | [diff] [blame] | 244 | mByteSize += sizeof(info); |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 245 | } |
| 246 | |
Bookatz | d3606c7 | 2017-10-19 10:13:49 -0700 | [diff] [blame] | 247 | // TODO: Re-add anomaly detection (similar to): |
| 248 | // for (auto& tracker : mAnomalyTrackers) { |
| 249 | // tracker->addPastBucket(mCounter, numBucketsForward); |
| 250 | //} |
| 251 | |
Yao Chen | 729093d | 2017-10-16 10:33:26 -0700 | [diff] [blame] | 252 | // Reset counters |
| 253 | mCurrentSlicedCounter.clear(); |
| 254 | |
| 255 | mCurrentBucketStartTimeNs = mCurrentBucketStartTimeNs + numBucketsForward * mBucketSizeNs; |
| 256 | VLOG("metric %lld: new bucket start time: %lld", mMetric.metric_id(), |
| 257 | (long long)mCurrentBucketStartTimeNs); |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 258 | } |
| 259 | |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 260 | // Rough estimate of CountMetricProducer buffer stored. This number will be |
| 261 | // greater than actual data size as it contains each dimension of |
| 262 | // CountMetricData is duplicated. |
yro | 69007c8 | 2017-10-26 20:42:57 -0700 | [diff] [blame] | 263 | size_t CountMetricProducer::byteSize() { |
yro | 24809bd | 2017-10-31 23:06:53 -0700 | [diff] [blame] | 264 | return mByteSize; |
yro | 69007c8 | 2017-10-26 20:42:57 -0700 | [diff] [blame] | 265 | } |
| 266 | |
Yao Chen | 44cf27c | 2017-09-14 22:32:50 -0700 | [diff] [blame] | 267 | } // namespace statsd |
| 268 | } // namespace os |
yro | 69007c8 | 2017-10-26 20:42:57 -0700 | [diff] [blame] | 269 | } // namespace android |