org.apache.gobblin.metrics.kafka.KafkaReporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gobblin-kafka-common Show documentation
A distributed data integration framework for streaming and batch data ecosystems.
There is a newer version: 0.16.0
/*
 * 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.kafka;

import java.io.IOException;
import java.util.Properties;

import com.google.common.base.Optional;
import com.google.common.collect.Lists;
import com.typesafe.config.Config;

import org.apache.gobblin.configuration.ConfigurationKeys;
import org.apache.gobblin.metrics.MetricReport;
import org.apache.gobblin.metrics.reporter.MetricReportReporter;
import org.apache.gobblin.metrics.reporter.util.AvroJsonSerializer;
import org.apache.gobblin.metrics.reporter.util.AvroSerializer;
import org.apache.gobblin.metrics.reporter.util.FixedSchemaVersionWriter;
import org.apache.gobblin.metrics.reporter.util.SchemaVersionWriter;
import org.apache.gobblin.util.ClassAliasResolver;
import org.apache.gobblin.util.ConfigUtils;

import lombok.extern.slf4j.Slf4j;


/**
 * Kafka reporter for metrics.
 *
 * @author ibuenros
 */
@Slf4j
public class KafkaReporter extends MetricReportReporter {
  public static final String SCHEMA_VERSION_WRITER_TYPE = "metrics.kafka.schemaVersionWriterType";
  private static final String METRICS_KAFKA_PREFIX = "metrics.kafka";

  protected final AvroSerializer serializer;
  protected final Pusher kafkaPusher;

  protected KafkaReporter(Builder builder, Config config) throws IOException {
    super(builder, config);

    SchemaVersionWriter versionWriter;
    if (config.hasPath(SCHEMA_VERSION_WRITER_TYPE)) {
      try {
        ClassAliasResolver resolver = new ClassAliasResolver<>(SchemaVersionWriter.class);
        Class klazz = resolver.resolveClass(config.getString(SCHEMA_VERSION_WRITER_TYPE));
        versionWriter = klazz.newInstance();
      } catch (ReflectiveOperationException roe) {
        throw new IOException("Could not instantiate version writer.", roe);
      }
    } else {
      versionWriter = new FixedSchemaVersionWriter();
    }

    log.info("Schema version writer: " + versionWriter.getClass().getName());
    this.serializer = this.closer.register(createSerializer(versionWriter));

    if (builder.kafkaPusher.isPresent()) {
      this.kafkaPusher = builder.kafkaPusher.get();
    } else {
      Config kafkaConfig = ConfigUtils.getConfigOrEmpty(config, PusherUtils.METRICS_REPORTING_KAFKA_CONFIG_PREFIX)
          .withFallback(ConfigUtils.getConfigOrEmpty(config, ConfigurationKeys.SHARED_KAFKA_CONFIG_PREFIX));

      String pusherClassName = ConfigUtils.getString(config, PusherUtils.KAFKA_PUSHER_CLASS_NAME_KEY,
          PusherUtils.DEFAULT_KAFKA_PUSHER_CLASS_NAME);

      this.kafkaPusher = PusherUtils.getPusher(pusherClassName, builder.brokers, builder.topic, Optional.of(kafkaConfig));
    }
    this.closer.register(this.kafkaPusher);
  }

  protected AvroSerializer createSerializer(SchemaVersionWriter schemaVersionWriter) throws IOException {
    return new AvroJsonSerializer<>(MetricReport.SCHEMA$, schemaVersionWriter);
  }

  /**
   * Get config with metrics configuration and shared kafka configuration
   */
  public static Config getKafkaAndMetricsConfigFromProperties(Properties props) {
    return ConfigUtils.propertiesToConfig(props, Optional.of(ConfigurationKeys.METRICS_CONFIGURATIONS_PREFIX))
        .withFallback(ConfigUtils.propertiesToConfig(props,
            Optional.of(ConfigurationKeys.SHARED_KAFKA_CONFIG_PREFIX)));
  }

  /**
   * A static factory class for obtaining new {@link Builder}s
   *
   * @see Builder
   */
  public static class BuilderFactory {

    public static BuilderImpl newBuilder() {
      return new BuilderImpl();
    }
  }

  public static class BuilderImpl extends Builder {

    @Override
    protected BuilderImpl self() {
      return this;
    }
  }

  /**
   * Builder for {@link KafkaReporter}. Defaults to no filter, reporting rates in seconds and times in milliseconds.
   */
  public static abstract class Builder>
      extends MetricReportReporter.Builder {

    protected String brokers;
    protected String topic;
    protected Optional kafkaPusher;

    protected Builder() {
      super();
      this.name = "KafkaReporter";
      this.kafkaPusher = Optional.absent();
    }

    /**
     * Set {@link Pusher} to use.
     */
    public T withKafkaPusher(Pusher pusher) {
      this.kafkaPusher = Optional.of(pusher);
      return self();
    }

    /**
     * Builds and returns {@link KafkaReporter}.
     *
     * @param brokers string of Kafka brokers
     * @param topic topic to send metrics to
     * @return KafkaReporter
     */
    public KafkaReporter build(String brokers, String topic, Properties props) throws IOException {
      this.brokers = brokers;
      this.topic = topic;

      // create a KafkaReporter with metrics.* and gobblin.kafka.sharedConfig.* keys
      return new KafkaReporter(this, KafkaReporter.getKafkaAndMetricsConfigFromProperties(props));
    }
  }

  @Override
  protected void emitReport(MetricReport report) {
    this.kafkaPusher.pushMessages(Lists.newArrayList(this.serializer.serializeRecord(report)));
  }
}