com.newrelic.telemetry.SpanBatchSenderFactory Maven / Gradle / Ivy
Show all versions of telemetry-core Show documentation
/*
* Copyright 2020 New Relic Corporation. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*/
package com.newrelic.telemetry;
import com.newrelic.telemetry.SenderConfiguration.SenderConfigurationBuilder;
import com.newrelic.telemetry.http.HttpPoster;
import com.newrelic.telemetry.spans.SpanBatchSender;
import java.util.function.Supplier;
/**
* A factory interface for creating a SpanBatchSender.
*
* Concrete implementations use different HTTP providers.
*/
public interface SpanBatchSenderFactory {
/**
* Create a new SpanBatchSender with your New Relic Insights Insert API key, and otherwise default
* settings. (2 second timeout, audit logging off, with the default endpoint URL)
*
* @see New
* Relic API Keys
* @param apiKey new relic api key
* @return a new instance of a span batch sender
*/
default SpanBatchSender createBatchSender(String apiKey) {
SenderConfigurationBuilder configuration =
SpanBatchSender.configurationBuilder().apiKey(apiKey).httpPoster(getPoster());
return SpanBatchSender.create(configuration.build());
}
/**
* Creates a new SenderConfigurationBuilder to help with constructing a SpanBatchSender. This
* builder is configured with data from the BaseConfig, including the apiKey, audit logging
* dis/enabled, and secondary user agent (which may be null).
*
* @param baseConfig a BaseConfig with settings to apply to the new builder
* @return a new SenderConfigurationBuilder with the config applied
*/
default SenderConfigurationBuilder configureWith(BaseConfig baseConfig) {
return configureWith(baseConfig.getApiKey())
.auditLoggingEnabled(baseConfig.isAuditLoggingEnabled())
.secondaryUserAgent(baseConfig.getSecondaryUserAgent());
}
/**
* Create a new SpanBatchSenderBuilder with your New Relic Insights Insert API key.
*
* @see New
* Relic API Keys
* @param apiKey new relic api key
* @return a new instance of a span configuration builder
*/
default SenderConfigurationBuilder configureWith(String apiKey) {
return SpanBatchSender.configurationBuilder().apiKey(apiKey).httpPoster(getPoster());
}
HttpPoster getPoster();
/**
* Create an {@link SpanBatchSenderFactory} with an HTTP implementation.
*
* @param creator A {@link Supplier} that returns an {@link HttpPoster} implementation.
* @return A Factory configured for use.
*/
static SpanBatchSenderFactory fromHttpImplementation(Supplier creator) {
return creator::get;
}
}