org.apache.beam.runners.dataflow.worker.StreamingStepMetricsContainer.java Source code

Introduction

Here is the source code for org.apache.beam.runners.dataflow.worker.StreamingStepMetricsContainer.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.beam.runners.dataflow.worker;

import com.google.api.services.dataflow.model.CounterUpdate;
import com.google.common.base.Function;
import com.google.common.base.Predicates;
import com.google.common.collect.FluentIterable;
import java.util.Map;
import java.util.Map.Entry;
import javax.annotation.Nullable;
import org.apache.beam.runners.core.construction.metrics.MetricKey;
import org.apache.beam.runners.core.metrics.DistributionData;
import org.apache.beam.runners.core.metrics.GaugeCell;
import org.apache.beam.runners.core.metrics.MetricsMap;
import org.apache.beam.sdk.metrics.Counter;
import org.apache.beam.sdk.metrics.Distribution;
import org.apache.beam.sdk.metrics.Gauge;
import org.apache.beam.sdk.metrics.MetricName;
import org.apache.beam.sdk.metrics.MetricsContainer;

/**
 * For Dataflow Streaming, we want to efficiently support many threads report metric updates, and a
 * single total delta being reported periodically as physical counters.
 */
public class StreamingStepMetricsContainer implements MetricsContainer {

    private final String stepName;

    private MetricsMap<MetricName, DeltaCounterCell> counters = new MetricsMap<>(DeltaCounterCell::new);

    private MetricsMap<MetricName, GaugeCell> gauges = new MetricsMap<>(GaugeCell::new);

    private MetricsMap<MetricName, DeltaDistributionCell> distributions = new MetricsMap<>(
            DeltaDistributionCell::new);

    private StreamingStepMetricsContainer(String stepName) {
        this.stepName = stepName;
    }

    public static MetricsContainerRegistry<StreamingStepMetricsContainer> createRegistry() {
        return new MetricsContainerRegistry<StreamingStepMetricsContainer>() {
            @Override
            protected StreamingStepMetricsContainer createContainer(String stepName) {
                return new StreamingStepMetricsContainer(stepName);
            }
        };
    }

    @Override
    public Counter getCounter(MetricName metricName) {
        return counters.get(metricName);
    }

    @Override
    public Distribution getDistribution(MetricName metricName) {
        return distributions.get(metricName);
    }

    @Override
    public Gauge getGauge(MetricName metricName) {
        return gauges.get(metricName);
    }

    public Iterable<CounterUpdate> extractUpdates() {
        return counterUpdates().append(distributionUpdates());
    }

    private FluentIterable<CounterUpdate> counterUpdates() {
        return FluentIterable.from(counters.entries())
                .transform(new Function<Entry<MetricName, DeltaCounterCell>, CounterUpdate>() {
                    @Override
                    @Nullable
                    public CounterUpdate apply(Map.Entry<MetricName, DeltaCounterCell> entry) {
                        long value = entry.getValue().getSumAndReset();
                        if (value == 0) {
                            return null;
                        }

                        return MetricsToCounterUpdateConverter
                                .fromCounter(MetricKey.create(stepName, entry.getKey()), false, value);
                    }
                }).filter(Predicates.notNull());
    }

    private FluentIterable<CounterUpdate> distributionUpdates() {
        return FluentIterable.from(distributions.entries())
                .transform(new Function<Entry<MetricName, DeltaDistributionCell>, CounterUpdate>() {
                    @Override
                    @Nullable
                    public CounterUpdate apply(Map.Entry<MetricName, DeltaDistributionCell> entry) {
                        DistributionData value = entry.getValue().getAndReset();
                        if (value.count() == 0) {
                            return null;
                        }

                        return MetricsToCounterUpdateConverter
                                .fromDistribution(MetricKey.create(stepName, entry.getKey()), false, value);
                    }
                }).filter(Predicates.notNull());
    }

    /**
     * Returns {@link CounterUpdate} protos representing the changes to all metrics that have changed
     * since the last time it was invoked.
     */
    public static Iterable<CounterUpdate> extractMetricUpdates(
            MetricsContainerRegistry<StreamingStepMetricsContainer> metricsContainerRegistry) {
        return metricsContainerRegistry.getContainers()
                .transformAndConcat(StreamingStepMetricsContainer::extractUpdates);
    }
}