statsd/loadtest/ConfigFactory.java

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.statsd.loadtest;

import android.content.Context;
import android.content.res.Resources;
import android.util.Log;
import android.util.StatsLog;

import com.android.internal.os.StatsdConfigProto.Bucket;
import com.android.internal.os.StatsdConfigProto.Condition;
import com.android.internal.os.StatsdConfigProto.CountMetric;
import com.android.internal.os.StatsdConfigProto.DurationMetric;
import com.android.internal.os.StatsdConfigProto.EventConditionLink;
import com.android.internal.os.StatsdConfigProto.EventMetric;
import com.android.internal.os.StatsdConfigProto.GaugeMetric;
import com.android.internal.os.StatsdConfigProto.ValueMetric;
import com.android.internal.os.StatsdConfigProto.KeyMatcher;
import com.android.internal.os.StatsdConfigProto.KeyValueMatcher;
import com.android.internal.os.StatsdConfigProto.AtomMatcher;
import com.android.internal.os.StatsdConfigProto.SimpleCondition;
import com.android.internal.os.StatsdConfigProto.StatsdConfig;

import java.io.InputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Creates StatsdConfig protos for loadtesting.
 */
public class ConfigFactory {
    public static final String CONFIG_NAME = "LOADTEST";

    private static final String TAG = "ConfigFactory";

    private final StatsdConfig mTemplate;

    public ConfigFactory(Context context) {
        // Read the config template from the resoures.
        Resources res = context.getResources();
        byte[] template = null;
        StatsdConfig templateProto = null;
        try {
            InputStream inputStream = res.openRawResource(R.raw.loadtest_config);
            template = new byte[inputStream.available()];
            inputStream.read(template);
            templateProto = StatsdConfig.parseFrom(template);
        } catch (IOException e) {
            Log.e(TAG, "Unable to read or parse loadtest config template. Using an empty config.");
        }
        mTemplate = templateProto == null ? StatsdConfig.newBuilder().build() : templateProto;

        Log.d(TAG, "Loadtest template config: " + mTemplate);
    }

    /**
     * Generates a config.
     *
     * All configs are based on the same template.
     * That template is designed to make the most use of the set of atoms that {@code SequencePusher}
     * pushes, and to exercise as many of the metrics features as possible.
     * Furthermore, by passing a replication factor to this method, one can artificially inflate
     * the number of metrics in the config. One can also adjust the bucket size for aggregate
     * metrics.
     *
     * @param replication The number of times each metric is replicated in the config.
     *        If the config template has n metrics, the generated config will have n * replication
     *        ones
     * @param bucketMillis The bucket size, in milliseconds, for aggregate metrics
     * @param placebo If true, only return an empty config
     * @return The serialized config
     */
  public byte[] getConfig(int replication, long bucketMillis, boolean placebo) {
        StatsdConfig.Builder config = StatsdConfig.newBuilder()
            .setName(CONFIG_NAME);
        if (placebo) {
          replication = 0;  // Config will be empty, aside from a name.
        }
        int numMetrics = 0;
        for (int i = 0; i < replication; i++) {
            // metrics
            for (EventMetric metric : mTemplate.getEventMetricList()) {
                addEventMetric(metric, i, config);
                numMetrics++;
            }
            for (CountMetric metric : mTemplate.getCountMetricList()) {
                addCountMetric(metric, i, bucketMillis, config);
                numMetrics++;
            }
            for (DurationMetric metric : mTemplate.getDurationMetricList()) {
                addDurationMetric(metric, i, bucketMillis, config);
                numMetrics++;
            }
            for (GaugeMetric metric : mTemplate.getGaugeMetricList()) {
                addGaugeMetric(metric, i, bucketMillis, config);
                numMetrics++;
            }
            for (ValueMetric metric : mTemplate.getValueMetricList()) {
                addValueMetric(metric, i, bucketMillis, config);
                numMetrics++;
            }
            // conditions
            for (Condition condition : mTemplate.getConditionList()) {
              addCondition(condition, i, config);
            }
            // matchers
            for (AtomMatcher matcher : mTemplate.getAtomMatcherList()) {
              addMatcher(matcher, i, config);
            }
        }

        Log.d(TAG, "Loadtest config is : " + config.build());
        Log.d(TAG, "Generated config has " + numMetrics + " metrics");

        return config.build().toByteArray();
    }

    /**
     * Creates {@link EventConditionLink}s that are identical to the one passed to this method,
     * except that the names are appended with the provided suffix.
     */
    private List<EventConditionLink> getLinks(
        List<EventConditionLink> links, int suffix) {
        List<EventConditionLink> newLinks = new ArrayList();
        for (EventConditionLink link : links) {
            newLinks.add(link.toBuilder()
                .setCondition(link.getCondition() + suffix)
                .build());
        }
        return newLinks;
    }

    /**
     * Creates an {@link EventMetric} based on the template. Makes sure that all names are appended
     * with the provided suffix. Then adds that metric to the config.
     */
    private void addEventMetric(EventMetric template, int suffix, StatsdConfig.Builder config) {
        EventMetric.Builder metric = template.toBuilder()
            .setName(template.getName() + suffix)
            .setWhat(template.getWhat() + suffix);
        if (template.hasCondition()) {
            metric.setCondition(template.getCondition() + suffix);
        }
        if (template.getLinksCount() > 0) {
            List<EventConditionLink> links = getLinks(template.getLinksList(), suffix);
            metric.clearLinks();
            metric.addAllLinks(links);
        }
        config.addEventMetric(metric);
    }

    private Bucket getBucket(long bucketMillis) {
        return Bucket.newBuilder()
            .setBucketSizeMillis(bucketMillis)
            .build();
    }

    /**
     * Creates a {@link CountMetric} based on the template. Makes sure that all names are appended
     * with the provided suffix, and overrides the bucket size. Then adds that metric to the config.
     */
    private void addCountMetric(CountMetric template, int suffix, long bucketMillis,
        StatsdConfig.Builder config) {
        CountMetric.Builder metric = template.toBuilder()
            .setName(template.getName() + suffix)
            .setWhat(template.getWhat() + suffix);
        if (template.hasCondition()) {
            metric.setCondition(template.getCondition() + suffix);
        }
        if (template.getLinksCount() > 0) {
            List<EventConditionLink> links = getLinks(template.getLinksList(), suffix);
            metric.clearLinks();
            metric.addAllLinks(links);
        }
        metric.setBucket(getBucket(bucketMillis));
        config.addCountMetric(metric);
    }

    /**
     * Creates a {@link DurationMetric} based on the template. Makes sure that all names are appended
     * with the provided suffix, and overrides the bucket size. Then adds that metric to the config.
     */
    private void addDurationMetric(DurationMetric template, int suffix, long bucketMillis,
        StatsdConfig.Builder config) {
        DurationMetric.Builder metric = template.toBuilder()
            .setName(template.getName() + suffix)
            .setWhat(template.getWhat() + suffix);
        if (template.hasCondition()) {
            metric.setCondition(template.getCondition() + suffix);
        }
        if (template.getLinksCount() > 0) {
            List<EventConditionLink> links = getLinks(template.getLinksList(), suffix);
            metric.clearLinks();
            metric.addAllLinks(links);
        }
        metric.setBucket(getBucket(bucketMillis));
        config.addDurationMetric(metric);
    }

    /**
     * Creates a {@link GaugeMetric} based on the template. Makes sure that all names are appended
     * with the provided suffix, and overrides the bucket size. Then adds that metric to the config.
     */
    private void addGaugeMetric(GaugeMetric template, int suffix, long bucketMillis,
        StatsdConfig.Builder config) {
        GaugeMetric.Builder metric = template.toBuilder()
            .setName(template.getName() + suffix)
            .setWhat(template.getWhat() + suffix);
        if (template.hasCondition()) {
            metric.setCondition(template.getCondition() + suffix);
        }
        if (template.getLinksCount() > 0) {
            List<EventConditionLink> links = getLinks(template.getLinksList(), suffix);
            metric.clearLinks();
            metric.addAllLinks(links);
        }
        metric.setBucket(getBucket(bucketMillis));
        config.addGaugeMetric(metric);
    }

    /**
     * Creates a {@link ValueMetric} based on the template. Makes sure that all names are appended
     * with the provided suffix, and overrides the bucket size. Then adds that metric to the config.
     */
    private void addValueMetric(ValueMetric template, int suffix, long bucketMillis,
        StatsdConfig.Builder config) {
        ValueMetric.Builder metric = template.toBuilder()
            .setName(template.getName() + suffix)
            .setWhat(template.getWhat() + suffix);
        if (template.hasCondition()) {
            metric.setCondition(template.getCondition() + suffix);
        }
        if (template.getLinksCount() > 0) {
            List<EventConditionLink> links = getLinks(template.getLinksList(), suffix);
            metric.clearLinks();
            metric.addAllLinks(links);
        }
        metric.setBucket(getBucket(bucketMillis));
        config.addValueMetric(metric);
    }

    /**
     * Creates a {@link Condition} based on the template. Makes sure that all names
     * are appended with the provided suffix. Then adds that condition to the config.
     */
    private void addCondition(Condition template, int suffix, StatsdConfig.Builder config) {
        Condition.Builder condition = template.toBuilder()
            .setName(template.getName() + suffix);
        if (template.hasCombination()) {
            Condition.Combination.Builder cb = template.getCombination().toBuilder()
                .clearCondition();
            for (String child : template.getCombination().getConditionList()) {
                cb.addCondition(child + suffix);
            }
            condition.setCombination(cb.build());
        }
        if (template.hasSimpleCondition()) {
            SimpleCondition.Builder sc = template.getSimpleCondition().toBuilder()
                .setStart(template.getSimpleCondition().getStart() + suffix)
                .setStop(template.getSimpleCondition().getStop() + suffix);
            if (template.getSimpleCondition().hasStopAll()) {
                sc.setStopAll(template.getSimpleCondition().getStopAll() + suffix);
            }
            condition.setSimpleCondition(sc.build());
        }
        config.addCondition(condition);
    }

    /**
     * Creates a {@link AtomMatcher} based on the template. Makes sure that all names
     * are appended with the provided suffix. Then adds that matcher to the config.
     */
    private void addMatcher(AtomMatcher template, int suffix, StatsdConfig.Builder config) {
        AtomMatcher.Builder matcher = template.toBuilder()
            .setName(template.getName() + suffix);
        if (template.hasCombination()) {
            AtomMatcher.Combination.Builder cb = template.getCombination().toBuilder()
                .clearMatcher();
            for (String child : template.getCombination().getMatcherList()) {
                cb.addMatcher(child + suffix);
            }
            matcher.setCombination(cb);
        }
        config.addAtomMatcher(matcher);
    }
}