com.newrelic.telemetry.micrometer.NewRelicRegistryConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micrometer-registry-new-relic Show documentation

Micrometer registry implementation that sends data to New Relic as dimensional metrics

The newest version!

/*
 * Copyright 2020 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package com.newrelic.telemetry.micrometer;

import io.micrometer.core.instrument.config.MissingRequiredConfigurationException;
import io.micrometer.core.instrument.step.StepRegistryConfig;

public interface NewRelicRegistryConfig extends StepRegistryConfig {

  @Override
  default String prefix() {
    return "newrelic";
  }

  default String apiKey() {
    String apiKey = get(prefix() + ".apiKey");
    if (apiKey == null) {
      throw new MissingRequiredConfigurationException(
          "apiKey must be set to report metrics to New Relic");
    }
    return apiKey;
  }

  /**
   * @return The URI for the New Relic metric API. Only necessary if you need to override the
   *     default URI.
   */
  default String uri() {
    return get(prefix() + ".uri");
  }

  /**
   * Return the service name which this registry will report as. Maps to the "service.name"
   * attribute on the metrics.
   *
   * @return The Service Name.
   */
  default String serviceName() {
    return null;
  }

  /**
   * Turn on "audit mode" in the underlying New Relic Telemetry SDK. This will log all data sent to
   * the New Relic APIs. Be aware that if there is sensitive information in the data being sent that
   * it will be sent to wherever the Telemetry SDK logs are configured to go.
   *
   * @return true if audit mode should be enabled.
   */
  default boolean enableAuditMode() {
    return false;
  }

  /**
   * Configure the underlying New Relic Telemetry SDK to consider the apiKey to be a license key,
   * not an insights api key.
   *
   * @see com.newrelic.telemetry.transport.BatchDataSender
   * @return true if configured apiKey is a license key, not an insights api key.
   */
  default boolean useLicenseKey() {
    return false;
  }
}