org.apache.gobblin.metrics.event.EventSubmitter.java Source code

Introduction

Here is the source code for org.apache.gobblin.metrics.event.EventSubmitter.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.gobblin.metrics.event;

import java.util.Map;

import com.google.common.base.Optional;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;

import org.apache.gobblin.metrics.GobblinTrackingEvent;
import org.apache.gobblin.metrics.MetricContext;

import lombok.Getter;

/**
 * Wrapper around Avro {@link org.apache.gobblin.metrics.GobblinTrackingEvent.Builder} simplifying handling {@link org.apache.gobblin.metrics.GobblinTrackingEvent}s.
 *
 * <p>
 *   Instances of this class are immutable. Calling set* methods returns a copy of the calling instance.
 * </p>
 *
 * @deprecated Use {@link GobblinEventBuilder}
 */
@Deprecated
public class EventSubmitter {

    public static final String EVENT_TYPE = "eventType";

    private final Map<String, String> metadata;
    @Getter
    private final String namespace;
    @Getter
    private final Optional<MetricContext> metricContext;

    public static class Builder {
        private final Optional<MetricContext> metricContext;
        private final Map<String, String> metadata;
        private final String namespace;

        public Builder(MetricContext metricContext, String namespace) {
            this(Optional.fromNullable(metricContext), namespace);
        }

        public Builder(Optional<MetricContext> metricContext, String namespace) {
            this.metricContext = metricContext;
            this.namespace = namespace;
            this.metadata = Maps.newHashMap();
        }

        public Builder addMetadata(String key, String value) {
            this.metadata.put(key, value);
            return this;
        }

        public Builder addMetadata(Map<? extends String, ? extends String> additionalMetadata) {
            this.metadata.putAll(additionalMetadata);
            return this;
        }

        public EventSubmitter build() {
            return new EventSubmitter(this);
        }
    }

    private EventSubmitter(Builder builder) {
        this.metadata = builder.metadata;
        this.namespace = builder.namespace;
        this.metricContext = builder.metricContext;
    }

    /**
     * Submits the {@link org.apache.gobblin.metrics.GobblinTrackingEvent} to the {@link org.apache.gobblin.metrics.MetricContext}.
     * @param name Name of the event.
     */
    public void submit(String name) {
        submit(name, ImmutableMap.<String, String>of());
    }

    /**
     * Calls submit on submitter if present.
     */
    public static void submit(Optional<EventSubmitter> submitter, String name) {
        if (submitter.isPresent()) {
            submitter.get().submit(name);
        }
    }

    /**
     * Submits the {@link org.apache.gobblin.metrics.GobblinTrackingEvent} to the {@link org.apache.gobblin.metrics.MetricContext}.
     * @param name Name of the event.
     * @param metadataEls List of keys and values for metadata of the form key1, value2, key2, value2, ...
     */
    public void submit(String name, String... metadataEls) {
        if (metadataEls.length % 2 != 0) {
            throw new IllegalArgumentException("Unmatched keys in metadata elements.");
        }

        Map<String, String> metadata = Maps.newHashMap();
        for (int i = 0; i < metadataEls.length / 2; i++) {
            metadata.put(metadataEls[2 * i], metadataEls[2 * i + 1]);
        }
        submit(name, metadata);
    }

    /**
     * Calls submit on submitter if present.
     */
    public static void submit(Optional<EventSubmitter> submitter, String name, String... metadataEls) {
        if (submitter.isPresent()) {
            submitter.get().submit(name, metadataEls);
        }
    }

    /**
     * Submits the {@link org.apache.gobblin.metrics.GobblinTrackingEvent} to the {@link org.apache.gobblin.metrics.MetricContext}.
     * @param name Name of the event.
     * @param additionalMetadata Additional metadata to be added to the event.
     */
    public void submit(String name, Map<String, String> additionalMetadata) {
        if (this.metricContext.isPresent()) {
            Map<String, String> finalMetadata = Maps.newHashMap(this.metadata);
            if (!additionalMetadata.isEmpty()) {
                finalMetadata.putAll(additionalMetadata);
            }

            // Timestamp is set by metric context.
            this.metricContext.get().submitEvent(new GobblinTrackingEvent(0l, this.namespace, name, finalMetadata));
        }
    }

    /**
     * Calls submit on submitter if present.
     */
    public static void submit(Optional<EventSubmitter> submitter, String name,
            Map<String, String> additionalMetadata) {
        if (submitter.isPresent()) {
            submitter.get().submit(name, additionalMetadata);
        }
    }

    /**
     * Get a {@link org.apache.gobblin.metrics.event.TimingEvent} attached to this {@link org.apache.gobblin.metrics.event.EventSubmitter}.
     * @param name Name of the {@link org.apache.gobblin.metrics.GobblinTrackingEvent} that will be generated.
     * @return a {@link org.apache.gobblin.metrics.event.TimingEvent}.
     */
    public TimingEvent getTimingEvent(String name) {
        return new TimingEvent(this, name);
    }
}