com.newrelic.telemetry.metrics.MetricBatch Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of telemetry-core Show documentation
Used to send telemetry data to New Relic
There is a newer version: 0.16.0
/*
 * Copyright 2019 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package com.newrelic.telemetry.metrics;

import com.newrelic.telemetry.Attributes;
import com.newrelic.telemetry.TelemetryBatch;
import java.util.Collection;
import java.util.Collections;

/** Represents a set of {@link Metric} instances, to be sent up to the New Relic Metrics API. */
public class MetricBatch extends TelemetryBatch {

  public MetricBatch(Collection metrics, Attributes commonAttributes) {
    super(metrics, commonAttributes);
  }

  @Override
  public TelemetryBatch createSubBatch(Collection telemetry) {
    return new MetricBatch(telemetry, getCommonAttributes());
  }

  public static Builder builder() {
    return new Builder();
  }

  public static class Builder {

    private Collection metrics = Collections.emptyList();
    private CommonAttributesBuilder commonAttributesBuilder = new CommonAttributesBuilder();

    /**
     * Optional. Specify the name of the service that is creating the metrics. The service name will
     * be included in all common attributes.
     *
     * @param serviceName - The name of the service
     * @return this builder
     */
    public Builder serviceName(String serviceName) {
      commonAttributesBuilder.serviceName(serviceName);
      return this;
    }

    /**
     * Optional. Specify the name of the instrumentation library that provides the metrics (such as
     * "micrometer" or "dropwizard-metrics" or "kamon"). The instrumentation provider will be
     * included in all common attributes as "instrumentation.provider".
     *
     * @param instrumentationProvider - The instrumentation provider name
     * @return this builder
     */
    public Builder instrumentationProvider(String instrumentationProvider) {
      commonAttributesBuilder.instrumentationProvider(instrumentationProvider);
      return this;
    }

    /**
     * Provides the core set of common attributes to be used with all metrics in the batch.
     *
     * @param attributes - the set of common attributes to use for all metrics.
     * @return this builder
     */
    public Builder attributes(Attributes attributes) {
      commonAttributesBuilder.attributes(attributes);
      return this;
    }

    /**
     * Provides the collection of metrics contained within the metric batch.
     *
     * @param metrics - the collection of new relic metrics
     * @return this builder
     */
    public Builder metrics(Collection metrics) {
      this.metrics = metrics;
      return this;
    }

    /**
     * Builds the metric batch
     *
     * @return A new MetricBatch instance configured with data from this builder
     */
    public MetricBatch build() {
      Attributes attributes = commonAttributesBuilder.build();
      return new MetricBatch(metrics, attributes);
    }
  }
}