blob: 42bbd8eb4d35b58608df0d45d50249fdc94d36ce [file] [log] [blame]
Yangster1d4d6862017-10-31 12:58:51 -07001/*
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 Chen3c0b95c2017-12-16 14:34:20 -080017#define DEBUG false // STOPSHIP if true
Yangster1d4d6862017-10-31 12:58:51 -070018#include "Log.h"
19
Chenjie Yuc5875052018-03-09 10:13:11 -080020#include "../guardrail/StatsdStats.h"
Yangster1d4d6862017-10-31 12:58:51 -070021#include "GaugeMetricProducer.h"
Chenjie Yuc5875052018-03-09 10:13:11 -080022#include "../stats_log_util.h"
Yangster1d4d6862017-10-31 12:58:51 -070023
yrob0378b02017-11-09 20:36:25 -080024using android::util::FIELD_COUNT_REPEATED;
yro2b0f8862017-11-06 14:27:31 -080025using android::util::FIELD_TYPE_BOOL;
26using android::util::FIELD_TYPE_FLOAT;
27using android::util::FIELD_TYPE_INT32;
28using android::util::FIELD_TYPE_INT64;
29using android::util::FIELD_TYPE_MESSAGE;
Yangster-macd1815dc2017-11-13 21:43:15 -080030using android::util::FIELD_TYPE_STRING;
yro2b0f8862017-11-06 14:27:31 -080031using android::util::ProtoOutputStream;
Yangster1d4d6862017-10-31 12:58:51 -070032using std::map;
33using std::string;
34using std::unordered_map;
35using std::vector;
Chenjie Yud9dfda72017-12-11 17:41:20 -080036using std::make_shared;
37using std::shared_ptr;
Yangster1d4d6862017-10-31 12:58:51 -070038
39namespace android {
40namespace os {
41namespace statsd {
42
yro2b0f8862017-11-06 14:27:31 -080043// for StatsLogReport
Yangster-mac94e197c2018-01-02 16:03:03 -080044const int FIELD_ID_ID = 1;
yro2b0f8862017-11-06 14:27:31 -080045const int FIELD_ID_GAUGE_METRICS = 8;
Yangster-mac9def8e32018-04-17 13:55:51 -070046const int FIELD_ID_TIME_BASE = 9;
47const int FIELD_ID_BUCKET_SIZE = 10;
48const int FIELD_ID_DIMENSION_PATH_IN_WHAT = 11;
Howard Ro9440e092018-12-16 19:15:21 -080049const int FIELD_ID_IS_ACTIVE = 14;
yro2b0f8862017-11-06 14:27:31 -080050// for GaugeMetricDataWrapper
51const int FIELD_ID_DATA = 1;
David Chen81245fd2018-04-12 14:33:37 -070052const int FIELD_ID_SKIPPED = 2;
tsaichristineb87ca152019-12-09 15:19:41 -080053// for SkippedBuckets
Yangster-mac9def8e32018-04-17 13:55:51 -070054const int FIELD_ID_SKIPPED_START_MILLIS = 3;
55const int FIELD_ID_SKIPPED_END_MILLIS = 4;
tsaichristineb87ca152019-12-09 15:19:41 -080056const int FIELD_ID_SKIPPED_DROP_EVENT = 5;
57// for DumpEvent Proto
58const int FIELD_ID_BUCKET_DROP_REASON = 1;
59const int FIELD_ID_DROP_TIME = 2;
yro2b0f8862017-11-06 14:27:31 -080060// for GaugeMetricData
Yangster-mac468ff042018-01-17 12:26:34 -080061const int FIELD_ID_DIMENSION_IN_WHAT = 1;
Yangster-mac468ff042018-01-17 12:26:34 -080062const int FIELD_ID_BUCKET_INFO = 3;
Yangster-mac9def8e32018-04-17 13:55:51 -070063const int FIELD_ID_DIMENSION_LEAF_IN_WHAT = 4;
yro2b0f8862017-11-06 14:27:31 -080064// for GaugeBucketInfo
Chenjie Yud9dfda72017-12-11 17:41:20 -080065const int FIELD_ID_ATOM = 3;
Yangster-mac330af582018-02-08 15:24:38 -080066const int FIELD_ID_ELAPSED_ATOM_TIMESTAMP = 4;
Yangster-mac9def8e32018-04-17 13:55:51 -070067const int FIELD_ID_BUCKET_NUM = 6;
68const int FIELD_ID_START_BUCKET_ELAPSED_MILLIS = 7;
69const int FIELD_ID_END_BUCKET_ELAPSED_MILLIS = 8;
yro2b0f8862017-11-06 14:27:31 -080070
Chenjie Yu0bd73db2018-12-16 07:37:04 -080071GaugeMetricProducer::GaugeMetricProducer(
72 const ConfigKey& key, const GaugeMetric& metric, const int conditionIndex,
73 const sp<ConditionWizard>& wizard, const int whatMatcherIndex,
74 const sp<EventMatcherWizard>& matcherWizard, const int pullTagId, const int triggerAtomId,
75 const int atomId, const int64_t timeBaseNs, const int64_t startTimeNs,
Ruchir Rastogi21a287b2019-10-02 12:04:33 -070076 const sp<StatsPullerManager>& pullerManager,
77 const unordered_map<int, shared_ptr<Activation>>& eventActivationMap,
Tej Singh3be093b2020-03-04 20:08:38 -080078 const unordered_map<int, vector<shared_ptr<Activation>>>& eventDeactivationMap)
Ruchir Rastogi21a287b2019-10-02 12:04:33 -070079 : MetricProducer(metric.id(), key, timeBaseNs, conditionIndex, wizard, eventActivationMap,
Tej Singh3be093b2020-03-04 20:08:38 -080080 eventDeactivationMap, /*slicedStateAtoms=*/{}, /*stateGroupMap=*/{}),
Yangster-mac32f07af2018-10-13 17:08:11 -070081 mWhatMatcherIndex(whatMatcherIndex),
82 mEventMatcherWizard(matcherWizard),
Chenjie Yue2219202018-06-08 10:07:51 -070083 mPullerManager(pullerManager),
Chenjie Yuc5875052018-03-09 10:13:11 -080084 mPullTagId(pullTagId),
Chenjie Yu88588972018-08-03 09:49:22 -070085 mTriggerAtomId(triggerAtomId),
86 mAtomId(atomId),
Chenjie Yue1361ed2018-07-23 17:33:09 -070087 mIsPulled(pullTagId != -1),
David Chen81245fd2018-04-12 14:33:37 -070088 mMinBucketSizeNs(metric.min_bucket_size_nanos()),
Chenjie Yu0bd73db2018-12-16 07:37:04 -080089 mMaxPullDelayNs(metric.max_pull_delay_sec() > 0 ? metric.max_pull_delay_sec() * NS_PER_SEC
90 : StatsdStats::kPullMaxDelayNs),
Chenjie Yuc5875052018-03-09 10:13:11 -080091 mDimensionSoftLimit(StatsdStats::kAtomDimensionKeySizeLimitMap.find(pullTagId) !=
92 StatsdStats::kAtomDimensionKeySizeLimitMap.end()
93 ? StatsdStats::kAtomDimensionKeySizeLimitMap.at(pullTagId).first
94 : StatsdStats::kDimensionKeySizeSoftLimit),
95 mDimensionHardLimit(StatsdStats::kAtomDimensionKeySizeLimitMap.find(pullTagId) !=
96 StatsdStats::kAtomDimensionKeySizeLimitMap.end()
97 ? StatsdStats::kAtomDimensionKeySizeLimitMap.at(pullTagId).second
Yangster-mac50b0c9a2018-05-10 17:13:12 -070098 : StatsdStats::kDimensionKeySizeHardLimit),
Chenjie Yucd1b7972019-01-16 20:38:15 -080099 mGaugeAtomsPerDimensionLimit(metric.max_num_gauge_atoms_per_bucket()),
100 mSplitBucketForAppUpgrade(metric.split_bucket_for_app_upgrade()) {
Yangster-mac34ea1102018-01-29 12:40:55 -0800101 mCurrentSlicedBucket = std::make_shared<DimToGaugeAtomsMap>();
Yangster-mac20877162017-12-22 17:19:39 -0800102 mCurrentSlicedBucketForAnomaly = std::make_shared<DimToValMap>();
Yangster-macb8144812018-01-04 10:56:23 -0800103 int64_t bucketSizeMills = 0;
104 if (metric.has_bucket()) {
yro59cc24d2018-02-13 20:17:32 -0800105 bucketSizeMills = TimeUnitToBucketSizeInMillisGuardrailed(key.GetUid(), metric.bucket());
Yangster1d4d6862017-10-31 12:58:51 -0700106 } else {
Yangster-macb8144812018-01-04 10:56:23 -0800107 bucketSizeMills = TimeUnitToBucketSizeInMillis(ONE_HOUR);
Yangster1d4d6862017-10-31 12:58:51 -0700108 }
Yangster-macb8144812018-01-04 10:56:23 -0800109 mBucketSizeNs = bucketSizeMills * 1000000;
Yangster1d4d6862017-10-31 12:58:51 -0700110
Yangster-mac34ea1102018-01-29 12:40:55 -0800111 mSamplingType = metric.sampling_type();
Yao Chen8a8d16c2018-02-08 14:50:40 -0800112 if (!metric.gauge_fields_filter().include_all()) {
113 translateFieldMatcher(metric.gauge_fields_filter().fields(), &mFieldMatchers);
114 }
Chenjie Yud9dfda72017-12-11 17:41:20 -0800115
Yao Chen8a8d16c2018-02-08 14:50:40 -0800116 if (metric.has_dimensions_in_what()) {
117 translateFieldMatcher(metric.dimensions_in_what(), &mDimensionsInWhat);
Yangster13fb7e42018-03-07 17:30:49 -0800118 mContainANYPositionInDimensionsInWhat = HasPositionANY(metric.dimensions_in_what());
Yao Chen8a8d16c2018-02-08 14:50:40 -0800119 }
120
Yangster1d4d6862017-10-31 12:58:51 -0700121 if (metric.links().size() > 0) {
Yao Chen8a8d16c2018-02-08 14:50:40 -0800122 for (const auto& link : metric.links()) {
123 Metric2Condition mc;
124 mc.conditionId = link.condition();
125 translateFieldMatcher(link.fields_in_what(), &mc.metricFields);
126 translateFieldMatcher(link.fields_in_condition(), &mc.conditionFields);
127 mMetric2ConditionLinks.push_back(mc);
128 }
tsaichristine76853372019-08-06 17:17:03 -0700129 mConditionSliced = true;
Yangster1d4d6862017-10-31 12:58:51 -0700130 }
tsaichristine76853372019-08-06 17:17:03 -0700131 mSliceByPositionALL = HasPositionALL(metric.dimensions_in_what());
Yangster1d4d6862017-10-31 12:58:51 -0700132
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700133 flushIfNeededLocked(startTimeNs);
Yangster1d4d6862017-10-31 12:58:51 -0700134 // Kicks off the puller immediately.
Chenjie Yue1361ed2018-07-23 17:33:09 -0700135 if (mIsPulled && mSamplingType == GaugeMetric::RANDOM_ONE_SAMPLE) {
Tej Singh3be093b2020-03-04 20:08:38 -0800136 mPullerManager->RegisterReceiver(mPullTagId, mConfigKey, this, getCurrentBucketEndTimeNs(),
Chenjie Yue2219202018-06-08 10:07:51 -0700137 mBucketSizeNs);
Yangster1d4d6862017-10-31 12:58:51 -0700138 }
139
Ruchir Rastogi21a287b2019-10-02 12:04:33 -0700140 // Adjust start for partial first bucket and then pull if needed
Chenjie Yue1361ed2018-07-23 17:33:09 -0700141 mCurrentBucketStartTimeNs = startTimeNs;
Chenjie Yue1361ed2018-07-23 17:33:09 -0700142
Yao Chen427d3722018-03-22 15:21:52 -0700143 VLOG("Gauge metric %lld created. bucket size %lld start_time: %lld sliced %d",
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700144 (long long)metric.id(), (long long)mBucketSizeNs, (long long)mTimeBaseNs,
Yao Chen427d3722018-03-22 15:21:52 -0700145 mConditionSliced);
Yangster1d4d6862017-10-31 12:58:51 -0700146}
147
148GaugeMetricProducer::~GaugeMetricProducer() {
149 VLOG("~GaugeMetricProducer() called");
Chenjie Yue1361ed2018-07-23 17:33:09 -0700150 if (mIsPulled && mSamplingType == GaugeMetric::RANDOM_ONE_SAMPLE) {
Tej Singh3be093b2020-03-04 20:08:38 -0800151 mPullerManager->UnRegisterReceiver(mPullTagId, mConfigKey, this);
Chenjie Yu032fefc2017-12-01 23:30:59 -0800152 }
Yangster1d4d6862017-10-31 12:58:51 -0700153}
154
Yangster-maca78d0082018-03-12 12:02:56 -0700155void GaugeMetricProducer::dumpStatesLocked(FILE* out, bool verbose) const {
156 if (mCurrentSlicedBucket == nullptr ||
157 mCurrentSlicedBucket->size() == 0) {
158 return;
159 }
160
161 fprintf(out, "GaugeMetric %lld dimension size %lu\n", (long long)mMetricId,
162 (unsigned long)mCurrentSlicedBucket->size());
163 if (verbose) {
164 for (const auto& it : *mCurrentSlicedBucket) {
tsaichristine69000e62019-10-18 17:34:52 -0700165 fprintf(out, "\t(what)%s\t(states)%s %d atoms\n",
166 it.first.getDimensionKeyInWhat().toString().c_str(),
167 it.first.getStateValuesKey().toString().c_str(), (int)it.second.size());
Yangster-maca78d0082018-03-12 12:02:56 -0700168 }
169 }
170}
171
Yangster-maca802d732018-04-24 07:50:38 -0700172void GaugeMetricProducer::clearPastBucketsLocked(const int64_t dumpTimeNs) {
173 flushIfNeededLocked(dumpTimeNs);
174 mPastBuckets.clear();
175 mSkippedBuckets.clear();
176}
177
Yangster-macb142cc82018-03-30 15:22:08 -0700178void GaugeMetricProducer::onDumpReportLocked(const int64_t dumpTimeNs,
Yangster-mace68f3a52018-04-04 00:01:43 -0700179 const bool include_current_partial_bucket,
Bookatzff71cad2018-09-20 17:17:49 -0700180 const bool erase_data,
Olivier Gaillard6c75ecd2019-02-20 09:57:33 +0000181 const DumpLatency dumpLatency,
Yangster-mac9def8e32018-04-17 13:55:51 -0700182 std::set<string> *str_set,
Yao Chen288c6002017-12-12 13:43:18 -0800183 ProtoOutputStream* protoOutput) {
Yao Chen427d3722018-03-22 15:21:52 -0700184 VLOG("Gauge metric %lld report now...", (long long)mMetricId);
Yangster-mace68f3a52018-04-04 00:01:43 -0700185 if (include_current_partial_bucket) {
186 flushLocked(dumpTimeNs);
187 } else {
188 flushIfNeededLocked(dumpTimeNs);
189 }
Yao Chen6a8c7992017-11-29 20:02:07 +0000190
Yang Lub4722912018-11-15 11:02:03 -0800191 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_ID, (long long)mMetricId);
Howard Ro07e23ff2018-12-17 17:28:07 -0800192 protoOutput->write(FIELD_TYPE_BOOL | FIELD_ID_IS_ACTIVE, isActiveLocked());
Yang Lub4722912018-11-15 11:02:03 -0800193
tsaichristineb87ca152019-12-09 15:19:41 -0800194 if (mPastBuckets.empty() && mSkippedBuckets.empty()) {
Yangster-mac635b4b32018-01-23 20:17:35 -0800195 return;
196 }
Yao Chen288c6002017-12-12 13:43:18 -0800197
Yangster-mac9def8e32018-04-17 13:55:51 -0700198 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_TIME_BASE, (long long)mTimeBaseNs);
199 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_BUCKET_SIZE, (long long)mBucketSizeNs);
200
201 // Fills the dimension path if not slicing by ALL.
202 if (!mSliceByPositionALL) {
203 if (!mDimensionsInWhat.empty()) {
204 uint64_t dimenPathToken = protoOutput->start(
205 FIELD_TYPE_MESSAGE | FIELD_ID_DIMENSION_PATH_IN_WHAT);
206 writeDimensionPathToProto(mDimensionsInWhat, protoOutput);
207 protoOutput->end(dimenPathToken);
208 }
Yangster-mac9def8e32018-04-17 13:55:51 -0700209 }
210
Yi Jin5ee07872018-03-05 18:18:27 -0800211 uint64_t protoToken = protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_ID_GAUGE_METRICS);
Yao Chen6a8c7992017-11-29 20:02:07 +0000212
tsaichristineb87ca152019-12-09 15:19:41 -0800213 for (const auto& skippedBucket : mSkippedBuckets) {
David Chen81245fd2018-04-12 14:33:37 -0700214 uint64_t wrapperToken =
215 protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED | FIELD_ID_SKIPPED);
Yangster-mac9def8e32018-04-17 13:55:51 -0700216 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_SKIPPED_START_MILLIS,
tsaichristineb87ca152019-12-09 15:19:41 -0800217 (long long)(NanoToMillis(skippedBucket.bucketStartTimeNs)));
Yangster-mac9def8e32018-04-17 13:55:51 -0700218 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_SKIPPED_END_MILLIS,
tsaichristineb87ca152019-12-09 15:19:41 -0800219 (long long)(NanoToMillis(skippedBucket.bucketEndTimeNs)));
220
221 for (const auto& dropEvent : skippedBucket.dropEvents) {
222 uint64_t dropEventToken = protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED |
223 FIELD_ID_SKIPPED_DROP_EVENT);
224 protoOutput->write(FIELD_TYPE_INT32 | FIELD_ID_BUCKET_DROP_REASON, dropEvent.reason);
225 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_DROP_TIME, (long long) (NanoToMillis(dropEvent.dropTimeNs)));
226 protoOutput->end(dropEventToken);
227 }
David Chen81245fd2018-04-12 14:33:37 -0700228 protoOutput->end(wrapperToken);
229 }
David Chen81245fd2018-04-12 14:33:37 -0700230
Yangster1d4d6862017-10-31 12:58:51 -0700231 for (const auto& pair : mPastBuckets) {
Yangster-mac93694462018-01-22 20:49:31 -0800232 const MetricDimensionKey& dimensionKey = pair.first;
Yangster1d4d6862017-10-31 12:58:51 -0700233
Yao Chen427d3722018-03-22 15:21:52 -0700234 VLOG("Gauge dimension key %s", dimensionKey.toString().c_str());
Yi Jin5ee07872018-03-05 18:18:27 -0800235 uint64_t wrapperToken =
Yao Chen288c6002017-12-12 13:43:18 -0800236 protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED | FIELD_ID_DATA);
yro2b0f8862017-11-06 14:27:31 -0800237
Yangster-mac20877162017-12-22 17:19:39 -0800238 // First fill dimension.
Yangster-mac9def8e32018-04-17 13:55:51 -0700239 if (mSliceByPositionALL) {
240 uint64_t dimensionToken = protoOutput->start(
241 FIELD_TYPE_MESSAGE | FIELD_ID_DIMENSION_IN_WHAT);
242 writeDimensionToProto(dimensionKey.getDimensionKeyInWhat(), str_set, protoOutput);
243 protoOutput->end(dimensionToken);
Yangster-mac9def8e32018-04-17 13:55:51 -0700244 } else {
245 writeDimensionLeafNodesToProto(dimensionKey.getDimensionKeyInWhat(),
246 FIELD_ID_DIMENSION_LEAF_IN_WHAT, str_set, protoOutput);
Yangster-mac93694462018-01-22 20:49:31 -0800247 }
248
yro2b0f8862017-11-06 14:27:31 -0800249 // Then fill bucket_info (GaugeBucketInfo).
250 for (const auto& bucket : pair.second) {
Yi Jin5ee07872018-03-05 18:18:27 -0800251 uint64_t bucketInfoToken = protoOutput->start(
Yao Chen288c6002017-12-12 13:43:18 -0800252 FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED | FIELD_ID_BUCKET_INFO);
Yangster-mac9def8e32018-04-17 13:55:51 -0700253
254 if (bucket.mBucketEndNs - bucket.mBucketStartNs != mBucketSizeNs) {
255 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_START_BUCKET_ELAPSED_MILLIS,
256 (long long)NanoToMillis(bucket.mBucketStartNs));
257 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_END_BUCKET_ELAPSED_MILLIS,
258 (long long)NanoToMillis(bucket.mBucketEndNs));
259 } else {
260 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_BUCKET_NUM,
261 (long long)(getBucketNumFromEndTimeNs(bucket.mBucketEndNs)));
262 }
Yangster-mac34ea1102018-01-29 12:40:55 -0800263
264 if (!bucket.mGaugeAtoms.empty()) {
Yangster-mac34ea1102018-01-29 12:40:55 -0800265 for (const auto& atom : bucket.mGaugeAtoms) {
Yangster-mac3fa5d7f2018-03-10 21:50:27 -0800266 uint64_t atomsToken =
267 protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED |
268 FIELD_ID_ATOM);
Chenjie Yu88588972018-08-03 09:49:22 -0700269 writeFieldValueTreeToStream(mAtomId, *(atom.mFields), protoOutput);
Yangster-mac3fa5d7f2018-03-10 21:50:27 -0800270 protoOutput->end(atomsToken);
Yangster-mac34ea1102018-01-29 12:40:55 -0800271 }
Yangster-mac34ea1102018-01-29 12:40:55 -0800272 for (const auto& atom : bucket.mGaugeAtoms) {
Tej Singh29ac6012019-06-05 18:10:12 -0700273 const int64_t elapsedTimestampNs =
274 truncateTimestampIfNecessary(mAtomId, atom.mElapsedTimestamps);
Yangster-mac330af582018-02-08 15:24:38 -0800275 protoOutput->write(
276 FIELD_TYPE_INT64 | FIELD_COUNT_REPEATED | FIELD_ID_ELAPSED_ATOM_TIMESTAMP,
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700277 (long long)elapsedTimestampNs);
Yangster-mac34ea1102018-01-29 12:40:55 -0800278 }
279 }
Yao Chen288c6002017-12-12 13:43:18 -0800280 protoOutput->end(bucketInfoToken);
Yao Chen427d3722018-03-22 15:21:52 -0700281 VLOG("Gauge \t bucket [%lld - %lld] includes %d atoms.",
282 (long long)bucket.mBucketStartNs, (long long)bucket.mBucketEndNs,
283 (int)bucket.mGaugeAtoms.size());
yro2b0f8862017-11-06 14:27:31 -0800284 }
Yao Chen288c6002017-12-12 13:43:18 -0800285 protoOutput->end(wrapperToken);
Yangster1d4d6862017-10-31 12:58:51 -0700286 }
Yao Chen288c6002017-12-12 13:43:18 -0800287 protoOutput->end(protoToken);
yro2b0f8862017-11-06 14:27:31 -0800288
Bookatzff71cad2018-09-20 17:17:49 -0700289
290 if (erase_data) {
291 mPastBuckets.clear();
292 mSkippedBuckets.clear();
293 }
Yangster1d4d6862017-10-31 12:58:51 -0700294}
295
Tej Singh3be093b2020-03-04 20:08:38 -0800296void GaugeMetricProducer::prepareFirstBucketLocked() {
297 if (mIsActive && mIsPulled && mSamplingType == GaugeMetric::RANDOM_ONE_SAMPLE) {
298 pullAndMatchEventsLocked(mCurrentBucketStartTimeNs);
299 }
300}
Tej Singh597c7162019-04-17 16:41:45 -0700301
Yangster-mac32f07af2018-10-13 17:08:11 -0700302void GaugeMetricProducer::pullAndMatchEventsLocked(const int64_t timestampNs) {
Yangster-mac34ea1102018-01-29 12:40:55 -0800303 bool triggerPuller = false;
304 switch(mSamplingType) {
305 // When the metric wants to do random sampling and there is already one gauge atom for the
306 // current bucket, do not do it again.
307 case GaugeMetric::RANDOM_ONE_SAMPLE: {
Olivier Gaillarde63d9e02019-02-12 14:43:59 +0000308 triggerPuller = mCondition == ConditionState::kTrue && mCurrentSlicedBucket->empty();
Yangster-mac34ea1102018-01-29 12:40:55 -0800309 break;
310 }
Chenjie Yue077fd22018-11-19 13:29:40 -0800311 case GaugeMetric::CONDITION_CHANGE_TO_TRUE: {
Olivier Gaillarde63d9e02019-02-12 14:43:59 +0000312 triggerPuller = mCondition == ConditionState::kTrue;
Yangster-mac34ea1102018-01-29 12:40:55 -0800313 break;
314 }
Chenjie Yue077fd22018-11-19 13:29:40 -0800315 case GaugeMetric::FIRST_N_SAMPLES: {
Olivier Gaillarde63d9e02019-02-12 14:43:59 +0000316 triggerPuller = mCondition == ConditionState::kTrue;
Yangsterec3c7a32018-05-09 15:51:07 -0700317 break;
318 }
Yangster-mac34ea1102018-01-29 12:40:55 -0800319 default:
320 break;
321 }
322 if (!triggerPuller) {
Yao Chen6a8c7992017-11-29 20:02:07 +0000323 return;
324 }
Yao Chen6a8c7992017-11-29 20:02:07 +0000325 vector<std::shared_ptr<LogEvent>> allData;
Tej Singh3be093b2020-03-04 20:08:38 -0800326 if (!mPullerManager->Pull(mPullTagId, mConfigKey, &allData)) {
Chenjie Yue1361ed2018-07-23 17:33:09 -0700327 ALOGE("Gauge Stats puller failed for tag: %d at %lld", mPullTagId, (long long)timestampNs);
Yao Chen6a8c7992017-11-29 20:02:07 +0000328 return;
329 }
Chenjie Yu0bd73db2018-12-16 07:37:04 -0800330 const int64_t pullDelayNs = getElapsedRealtimeNs() - timestampNs;
331 if (pullDelayNs > mMaxPullDelayNs) {
332 ALOGE("Pull finish too late for atom %d", mPullTagId);
333 StatsdStats::getInstance().notePullExceedMaxDelay(mPullTagId);
334 StatsdStats::getInstance().notePullDelay(mPullTagId, pullDelayNs);
335 return;
336 }
337 StatsdStats::getInstance().notePullDelay(mPullTagId, pullDelayNs);
Yangster1d4d6862017-10-31 12:58:51 -0700338 for (const auto& data : allData) {
Chenjie Yu0bd73db2018-12-16 07:37:04 -0800339 LogEvent localCopy = data->makeCopy();
340 localCopy.setElapsedTimestampNs(timestampNs);
341 if (mEventMatcherWizard->matchLogEvent(localCopy, mWhatMatcherIndex) ==
342 MatchingState::kMatched) {
343 onMatchedLogEventLocked(mWhatMatcherIndex, localCopy);
Yangster-mac32f07af2018-10-13 17:08:11 -0700344 }
Yangster1d4d6862017-10-31 12:58:51 -0700345 }
Yangster1d4d6862017-10-31 12:58:51 -0700346}
347
Muhammad Qureshi18e46922019-05-24 16:38:49 -0700348void GaugeMetricProducer::onActiveStateChangedLocked(const int64_t& eventTimeNs) {
349 MetricProducer::onActiveStateChangedLocked(eventTimeNs);
350 if (ConditionState::kTrue != mCondition || !mIsPulled) {
351 return;
352 }
353 if (mTriggerAtomId == -1 || (mIsActive && mSamplingType == GaugeMetric::RANDOM_ONE_SAMPLE)) {
354 pullAndMatchEventsLocked(eventTimeNs);
355 }
356
357}
358
Yao Chen427d3722018-03-22 15:21:52 -0700359void GaugeMetricProducer::onConditionChangedLocked(const bool conditionMet,
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700360 const int64_t eventTimeNs) {
Yao Chen427d3722018-03-22 15:21:52 -0700361 VLOG("GaugeMetric %lld onConditionChanged", (long long)mMetricId);
Muhammad Qureshi18e46922019-05-24 16:38:49 -0700362
Olivier Gaillarde63d9e02019-02-12 14:43:59 +0000363 mCondition = conditionMet ? ConditionState::kTrue : ConditionState::kFalse;
Muhammad Qureshi18e46922019-05-24 16:38:49 -0700364 if (!mIsActive) {
365 return;
366 }
367
368 flushIfNeededLocked(eventTimeNs);
Chenjie Yue077fd22018-11-19 13:29:40 -0800369 if (mIsPulled && mTriggerAtomId == -1) {
Yangster-mac32f07af2018-10-13 17:08:11 -0700370 pullAndMatchEventsLocked(eventTimeNs);
Yao Chen427d3722018-03-22 15:21:52 -0700371 } // else: Push mode. No need to proactively pull the gauge data.
372}
373
374void GaugeMetricProducer::onSlicedConditionMayChangeLocked(bool overallCondition,
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700375 const int64_t eventTimeNs) {
Yao Chen427d3722018-03-22 15:21:52 -0700376 VLOG("GaugeMetric %lld onSlicedConditionMayChange overall condition %d", (long long)mMetricId,
377 overallCondition);
Muhammad Qureshi18e46922019-05-24 16:38:49 -0700378 mCondition = overallCondition ? ConditionState::kTrue : ConditionState::kFalse;
379 if (!mIsActive) {
380 return;
381 }
382
Yangster-mac15f6bbc2018-04-08 11:52:26 -0700383 flushIfNeededLocked(eventTimeNs);
Yao Chen427d3722018-03-22 15:21:52 -0700384 // If the condition is sliced, mCondition is true if any of the dimensions is true. And we will
385 // pull for every dimension.
Chenjie Yue077fd22018-11-19 13:29:40 -0800386 if (mIsPulled && mTriggerAtomId == -1) {
Yangster-mac32f07af2018-10-13 17:08:11 -0700387 pullAndMatchEventsLocked(eventTimeNs);
Yao Chen427d3722018-03-22 15:21:52 -0700388 } // else: Push mode. No need to proactively pull the gauge data.
Yangster1d4d6862017-10-31 12:58:51 -0700389}
390
Yao Chen8a8d16c2018-02-08 14:50:40 -0800391std::shared_ptr<vector<FieldValue>> GaugeMetricProducer::getGaugeFields(const LogEvent& event) {
Chenjie Yu4c31f672018-08-21 15:42:40 -0700392 std::shared_ptr<vector<FieldValue>> gaugeFields;
Yao Chen8a8d16c2018-02-08 14:50:40 -0800393 if (mFieldMatchers.size() > 0) {
Chenjie Yu4c31f672018-08-21 15:42:40 -0700394 gaugeFields = std::make_shared<vector<FieldValue>>();
Yao Chen8a8d16c2018-02-08 14:50:40 -0800395 filterGaugeValues(mFieldMatchers, event.getValues(), gaugeFields.get());
Yao Chen8a8d16c2018-02-08 14:50:40 -0800396 } else {
Chenjie Yu4c31f672018-08-21 15:42:40 -0700397 gaugeFields = std::make_shared<vector<FieldValue>>(event.getValues());
Yangster1d4d6862017-10-31 12:58:51 -0700398 }
Chenjie Yu4c31f672018-08-21 15:42:40 -0700399 // Trim all dimension fields from output. Dimensions will appear in output report and will
400 // benefit from dictionary encoding. For large pulled atoms, this can give the benefit of
401 // optional repeated field.
402 for (const auto& field : mDimensionsInWhat) {
403 for (auto it = gaugeFields->begin(); it != gaugeFields->end();) {
404 if (it->mField.matches(field)) {
405 it = gaugeFields->erase(it);
406 } else {
407 it++;
408 }
409 }
410 }
411 return gaugeFields;
Yangster1d4d6862017-10-31 12:58:51 -0700412}
413
Olivier Gaillardc5f11c42019-02-05 12:44:58 +0000414void GaugeMetricProducer::onDataPulled(const std::vector<std::shared_ptr<LogEvent>>& allData,
Olivier Gaillard11203df2019-02-06 13:18:09 +0000415 bool pullSuccess, int64_t originalPullTimeNs) {
Yangsterf2bee6f2017-11-29 12:01:05 -0800416 std::lock_guard<std::mutex> lock(mMutex);
Olivier Gaillardc5f11c42019-02-05 12:44:58 +0000417 if (!pullSuccess || allData.size() == 0) {
Chenjie Yud9dfda72017-12-11 17:41:20 -0800418 return;
419 }
Yangster1d4d6862017-10-31 12:58:51 -0700420 for (const auto& data : allData) {
Yangster-mac32f07af2018-10-13 17:08:11 -0700421 if (mEventMatcherWizard->matchLogEvent(
422 *data, mWhatMatcherIndex) == MatchingState::kMatched) {
423 onMatchedLogEventLocked(mWhatMatcherIndex, *data);
424 }
Yangster1d4d6862017-10-31 12:58:51 -0700425 }
Yangster1d4d6862017-10-31 12:58:51 -0700426}
427
Yangster-mac93694462018-01-22 20:49:31 -0800428bool GaugeMetricProducer::hitGuardRailLocked(const MetricDimensionKey& newKey) {
Yao Chenb3561512017-11-21 18:07:17 -0800429 if (mCurrentSlicedBucket->find(newKey) != mCurrentSlicedBucket->end()) {
430 return false;
431 }
432 // 1. Report the tuple count if the tuple count > soft limit
Chenjie Yuc5875052018-03-09 10:13:11 -0800433 if (mCurrentSlicedBucket->size() > mDimensionSoftLimit - 1) {
Yao Chenb3561512017-11-21 18:07:17 -0800434 size_t newTupleCount = mCurrentSlicedBucket->size() + 1;
Yangster-mac94e197c2018-01-02 16:03:03 -0800435 StatsdStats::getInstance().noteMetricDimensionSize(mConfigKey, mMetricId, newTupleCount);
Yao Chenb3561512017-11-21 18:07:17 -0800436 // 2. Don't add more tuples, we are above the allowed threshold. Drop the data.
Chenjie Yuc5875052018-03-09 10:13:11 -0800437 if (newTupleCount > mDimensionHardLimit) {
Yangster-mac94e197c2018-01-02 16:03:03 -0800438 ALOGE("GaugeMetric %lld dropping data for dimension key %s",
Yangster13fb7e42018-03-07 17:30:49 -0800439 (long long)mMetricId, newKey.toString().c_str());
Muhammad Qureshi87348a62019-02-14 16:17:52 -0800440 StatsdStats::getInstance().noteHardDimensionLimitReached(mMetricId);
Yao Chenb3561512017-11-21 18:07:17 -0800441 return true;
442 }
443 }
444
445 return false;
446}
447
Yangsterf2bee6f2017-11-29 12:01:05 -0800448void GaugeMetricProducer::onMatchedLogEventInternalLocked(
Yangster-mac93694462018-01-22 20:49:31 -0800449 const size_t matcherIndex, const MetricDimensionKey& eventKey,
tsaichristinec876b492019-12-10 13:47:05 -0800450 const ConditionKey& conditionKey, bool condition, const LogEvent& event,
451 const map<int, HashableDimensionKey>& statePrimaryKeys) {
Yangster1d4d6862017-10-31 12:58:51 -0700452 if (condition == false) {
453 return;
454 }
Yangster-macb142cc82018-03-30 15:22:08 -0700455 int64_t eventTimeNs = event.GetElapsedTimestampNs();
Yangster1d4d6862017-10-31 12:58:51 -0700456 if (eventTimeNs < mCurrentBucketStartTimeNs) {
Yao Chen427d3722018-03-22 15:21:52 -0700457 VLOG("Gauge Skip event due to late arrival: %lld vs %lld", (long long)eventTimeNs,
Yangster1d4d6862017-10-31 12:58:51 -0700458 (long long)mCurrentBucketStartTimeNs);
459 return;
460 }
Chenjie Yud9dfda72017-12-11 17:41:20 -0800461 flushIfNeededLocked(eventTimeNs);
Yao Chen6a8c7992017-11-29 20:02:07 +0000462
Chenjie Yu88588972018-08-03 09:49:22 -0700463 if (mTriggerAtomId == event.GetTagId()) {
Yangster-mac32f07af2018-10-13 17:08:11 -0700464 pullAndMatchEventsLocked(eventTimeNs);
Chenjie Yu88588972018-08-03 09:49:22 -0700465 return;
466 }
467
Yangster-mac34ea1102018-01-29 12:40:55 -0800468 // When gauge metric wants to randomly sample the output atom, we just simply use the first
469 // gauge in the given bucket.
470 if (mCurrentSlicedBucket->find(eventKey) != mCurrentSlicedBucket->end() &&
471 mSamplingType == GaugeMetric::RANDOM_ONE_SAMPLE) {
Yangster1d4d6862017-10-31 12:58:51 -0700472 return;
473 }
Chenjie Yud9dfda72017-12-11 17:41:20 -0800474 if (hitGuardRailLocked(eventKey)) {
475 return;
Yao Chen6a8c7992017-11-29 20:02:07 +0000476 }
Yangster-mac50b0c9a2018-05-10 17:13:12 -0700477 if ((*mCurrentSlicedBucket)[eventKey].size() >= mGaugeAtomsPerDimensionLimit) {
478 return;
479 }
Bookatzfe2dde82018-08-28 13:24:40 -0700480 GaugeAtom gaugeAtom(getGaugeFields(event), eventTimeNs);
Yangster-mac34ea1102018-01-29 12:40:55 -0800481 (*mCurrentSlicedBucket)[eventKey].push_back(gaugeAtom);
Chenjie Yud9dfda72017-12-11 17:41:20 -0800482 // Anomaly detection on gauge metric only works when there is one numeric
483 // field specified.
484 if (mAnomalyTrackers.size() > 0) {
Yangster-mac34ea1102018-01-29 12:40:55 -0800485 if (gaugeAtom.mFields->size() == 1) {
Yao Chen8a8d16c2018-02-08 14:50:40 -0800486 const Value& value = gaugeAtom.mFields->begin()->mValue;
Chenjie Yud9dfda72017-12-11 17:41:20 -0800487 long gaugeVal = 0;
Yao Chen8a8d16c2018-02-08 14:50:40 -0800488 if (value.getType() == INT) {
489 gaugeVal = (long)value.int_value;
490 } else if (value.getType() == LONG) {
491 gaugeVal = value.long_value;
Chenjie Yud9dfda72017-12-11 17:41:20 -0800492 }
493 for (auto& tracker : mAnomalyTrackers) {
Yao Chen4ce07292019-02-13 13:06:36 -0800494 tracker->detectAndDeclareAnomaly(eventTimeNs, mCurrentBucketNum, mMetricId,
495 eventKey, gaugeVal);
Chenjie Yud9dfda72017-12-11 17:41:20 -0800496 }
497 }
498 }
499}
500
501void GaugeMetricProducer::updateCurrentSlicedBucketForAnomaly() {
Chenjie Yud9dfda72017-12-11 17:41:20 -0800502 for (const auto& slice : *mCurrentSlicedBucket) {
Yao Chen8a8d16c2018-02-08 14:50:40 -0800503 if (slice.second.empty()) {
Yangster-mac34ea1102018-01-29 12:40:55 -0800504 continue;
505 }
Yao Chen8a8d16c2018-02-08 14:50:40 -0800506 const Value& value = slice.second.front().mFields->front().mValue;
Chenjie Yud9dfda72017-12-11 17:41:20 -0800507 long gaugeVal = 0;
Yao Chen8a8d16c2018-02-08 14:50:40 -0800508 if (value.getType() == INT) {
509 gaugeVal = (long)value.int_value;
510 } else if (value.getType() == LONG) {
511 gaugeVal = value.long_value;
Chenjie Yud9dfda72017-12-11 17:41:20 -0800512 }
513 (*mCurrentSlicedBucketForAnomaly)[slice.first] = gaugeVal;
Yangster1d4d6862017-10-31 12:58:51 -0700514 }
515}
516
Yangster-macb142cc82018-03-30 15:22:08 -0700517void GaugeMetricProducer::dropDataLocked(const int64_t dropTimeNs) {
Yao Chen06dba5d2018-01-26 13:38:16 -0800518 flushIfNeededLocked(dropTimeNs);
Olivier Gaillard320952b2019-02-06 13:57:24 +0000519 StatsdStats::getInstance().noteBucketDropped(mMetricId);
Yao Chen06dba5d2018-01-26 13:38:16 -0800520 mPastBuckets.clear();
521}
522
Yangster1d4d6862017-10-31 12:58:51 -0700523// When a new matched event comes in, we check if event falls into the current
524// bucket. If not, flush the old counter to past buckets and initialize the new
525// bucket.
526// if data is pushed, onMatchedLogEvent will only be called through onConditionChanged() inside
527// the GaugeMetricProducer while holding the lock.
Yangster-macb142cc82018-03-30 15:22:08 -0700528void GaugeMetricProducer::flushIfNeededLocked(const int64_t& eventTimeNs) {
529 int64_t currentBucketEndTimeNs = getCurrentBucketEndTimeNs();
David Chen27785a82018-01-19 17:06:45 -0800530
531 if (eventTimeNs < currentBucketEndTimeNs) {
Yao Chen427d3722018-03-22 15:21:52 -0700532 VLOG("Gauge eventTime is %lld, less than next bucket start time %lld",
533 (long long)eventTimeNs, (long long)(mCurrentBucketStartTimeNs + mBucketSizeNs));
Yangster1d4d6862017-10-31 12:58:51 -0700534 return;
535 }
536
David Chen27785a82018-01-19 17:06:45 -0800537 // Adjusts the bucket start and end times.
538 int64_t numBucketsForward = 1 + (eventTimeNs - currentBucketEndTimeNs) / mBucketSizeNs;
Muhammad Qureshi902529a2019-03-14 16:03:21 -0700539 int64_t nextBucketNs = currentBucketEndTimeNs + (numBucketsForward - 1) * mBucketSizeNs;
540 flushCurrentBucketLocked(eventTimeNs, nextBucketNs);
541
David Chen27785a82018-01-19 17:06:45 -0800542 mCurrentBucketNum += numBucketsForward;
Yao Chen427d3722018-03-22 15:21:52 -0700543 VLOG("Gauge metric %lld: new bucket start time: %lld", (long long)mMetricId,
David Chen27785a82018-01-19 17:06:45 -0800544 (long long)mCurrentBucketStartTimeNs);
545}
546
Olivier Gaillard6c75ecd2019-02-20 09:57:33 +0000547void GaugeMetricProducer::flushCurrentBucketLocked(const int64_t& eventTimeNs,
548 const int64_t& nextBucketStartTimeNs) {
Yangster-macb142cc82018-03-30 15:22:08 -0700549 int64_t fullBucketEndTimeNs = getCurrentBucketEndTimeNs();
tsaichristine45f703b2020-02-03 10:44:39 -0800550 int64_t bucketEndTime = eventTimeNs < fullBucketEndTimeNs ? eventTimeNs : fullBucketEndTimeNs;
David Chen27785a82018-01-19 17:06:45 -0800551
yro2b0f8862017-11-06 14:27:31 -0800552 GaugeBucket info;
553 info.mBucketStartNs = mCurrentBucketStartTimeNs;
tsaichristine45f703b2020-02-03 10:44:39 -0800554 info.mBucketEndNs = bucketEndTime;
Yangster1d4d6862017-10-31 12:58:51 -0700555
tsaichristineb87ca152019-12-09 15:19:41 -0800556 // Add bucket to mPastBuckets if bucket is large enough.
557 // Otherwise, drop the bucket data and add bucket metadata to mSkippedBuckets.
558 bool isBucketLargeEnough = info.mBucketEndNs - mCurrentBucketStartTimeNs >= mMinBucketSizeNs;
559 if (isBucketLargeEnough) {
David Chen81245fd2018-04-12 14:33:37 -0700560 for (const auto& slice : *mCurrentSlicedBucket) {
561 info.mGaugeAtoms = slice.second;
562 auto& bucketList = mPastBuckets[slice.first];
563 bucketList.push_back(info);
564 VLOG("Gauge gauge metric %lld, dump key value: %s", (long long)mMetricId,
565 slice.first.toString().c_str());
566 }
567 } else {
tsaichristineb87ca152019-12-09 15:19:41 -0800568 mCurrentSkippedBucket.bucketStartTimeNs = mCurrentBucketStartTimeNs;
tsaichristine45f703b2020-02-03 10:44:39 -0800569 mCurrentSkippedBucket.bucketEndTimeNs = bucketEndTime;
tsaichristineb87ca152019-12-09 15:19:41 -0800570 if (!maxDropEventsReached()) {
571 mCurrentSkippedBucket.dropEvents.emplace_back(
572 buildDropEvent(eventTimeNs, BucketDropReason::BUCKET_TOO_SMALL));
573 }
574 mSkippedBuckets.emplace_back(mCurrentSkippedBucket);
Yangster1d4d6862017-10-31 12:58:51 -0700575 }
Yangster1d4d6862017-10-31 12:58:51 -0700576
David Chen27785a82018-01-19 17:06:45 -0800577 // If we have anomaly trackers, we need to update the partial bucket values.
Chenjie Yud9dfda72017-12-11 17:41:20 -0800578 if (mAnomalyTrackers.size() > 0) {
579 updateCurrentSlicedBucketForAnomaly();
David Chen27785a82018-01-19 17:06:45 -0800580
581 if (eventTimeNs > fullBucketEndTimeNs) {
582 // This is known to be a full bucket, so send this data to the anomaly tracker.
583 for (auto& tracker : mAnomalyTrackers) {
584 tracker->addPastBucket(mCurrentSlicedBucketForAnomaly, mCurrentBucketNum);
585 }
586 mCurrentSlicedBucketForAnomaly = std::make_shared<DimToValMap>();
Chenjie Yud9dfda72017-12-11 17:41:20 -0800587 }
Yangster-mace2cd6d52017-11-09 20:38:30 -0800588 }
589
Olivier Gaillardf248c0d2019-02-21 15:56:58 +0000590 StatsdStats::getInstance().noteBucketCount(mMetricId);
Yangster-mac34ea1102018-01-29 12:40:55 -0800591 mCurrentSlicedBucket = std::make_shared<DimToGaugeAtomsMap>();
Muhammad Qureshi902529a2019-03-14 16:03:21 -0700592 mCurrentBucketStartTimeNs = nextBucketStartTimeNs;
tsaichristineb87ca152019-12-09 15:19:41 -0800593 mCurrentSkippedBucket.reset();
Yangster1d4d6862017-10-31 12:58:51 -0700594}
595
Yangsterf2bee6f2017-11-29 12:01:05 -0800596size_t GaugeMetricProducer::byteSizeLocked() const {
Yangster-mace2cd6d52017-11-09 20:38:30 -0800597 size_t totalSize = 0;
598 for (const auto& pair : mPastBuckets) {
Yangster-macb2532da2018-04-11 13:55:04 -0700599 for (const auto& bucket : pair.second) {
600 totalSize += bucket.mGaugeAtoms.size() * sizeof(GaugeAtom);
601 for (const auto& atom : bucket.mGaugeAtoms) {
602 if (atom.mFields != nullptr) {
603 totalSize += atom.mFields->size() * sizeof(FieldValue);
604 }
605 }
606 }
Yangster-mace2cd6d52017-11-09 20:38:30 -0800607 }
608 return totalSize;
yro2b0f8862017-11-06 14:27:31 -0800609}
610
Yangster1d4d6862017-10-31 12:58:51 -0700611} // namespace statsd
612} // namespace os
613} // namespace android