Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. #276

yamnihcg · 2021-06-11T22:09:28Z

The following PR adds the .setRegion() method to the SenderConfigurationBuilder API. This method allows you to define a region (US or EU) so that the appropriate production endpoint (corresponding to that region) is used. The default endpoint is the US production endpoint.

If you want to use an endpoint other than the US / EU production endpoints, use the existing .endpoint() method in the SenderConfigurationBuilder API.

Below are some examples on how to use the new API. In these examples, we use the MetricBatchSender / MetricBatchSenderFactory.

US Production

String licenseKey = args[0];
MetricBatchSenderFactory factory = MetricBatchSenderFactory.fromHttpImplementation(OkHttpPoster::new);
MetricBatchSender sender = MetricBatchSender.create(factory.configureWith(licenseKey).useLicenseKey(true).build());

Note: Since the default endpoint is the US production endpoint, we did not use .setRegion() in this example. Also, a US license key is needed to send data to this endpoint.

EU Production

String licenseKey = args[0];
MetricBatchSenderFactory factory = MetricBatchSenderFactory.fromHttpImplementation(OkHttpPoster::new);
MetricBatchSender sender = MetricBatchSender.create(factory.configureWith(licenseKey).useLicenseKey(true).setRegion("EU").build());

Note: An EU license key is needed to send data to this endpoint.

Staging / Setting Your Own URL

URL endpointURL = new URL("http://localhost:1439/v1/accounts/events");
String licenseKey = args[0];
MetricBatchSenderFactory factory = MetricBatchSenderFactory.fromHttpImplementation(OkHttpPoster::new);
MetricBatchSender sender =
    MetricBatchSender.create(factory.configureWith(licenseKey).useLicenseKey(true).endpoint(endpointURL).build());

… for each data type

…nders

…f set.

…if set.

XiXiaPdx

Looking great! A few more tests, now that user can override region with endpoint

XiXiaPdx · 2021-06-21T17:38:35Z

telemetry-core/src/main/java/com/newrelic/telemetry/SenderConfiguration.java

+    return endpointRegion;
+  }
+
+  public boolean isUserProvideEndpoint() {


nitpick spelling - isUserProvidedEnpoint()

XiXiaPdx · 2021-06-21T17:48:45Z

telemetry-core/src/main/java/com/newrelic/telemetry/metrics/MetricBatchSender.java

+      }
+    } else if (userRegion.equals("EU")) {
+      try {
+        url = new URL(EUROPEAN_URL + METRICS_PATH);


Can we make the creation of the Default URL be simple and consistent with the creation of the European Url?

XiXiaPdx · 2021-06-21T17:56:44Z

telemetry-core/src/main/java/com/newrelic/telemetry/SenderConfiguration.java

     *
     * @param endpoint A full {@link URL}, including the path.
     * @return this builder.
     */
    public SenderConfigurationBuilder endpoint(URL endpoint) {
+      SenderConfiguration.userProvidedEndpoint = true;


please provide a test that userProvidedEndpoint will be set to true

XiXiaPdx · 2021-06-21T17:57:57Z

telemetry-core/src/main/java/com/newrelic/telemetry/events/EventBatchSender.java

+    boolean isCustomEndpoint = configuration.isUserProvideEndpoint();
+
+    URL url = null;
+    if (isCustomEndpoint == true) {


please add a test in each BatchSender to confirm custom endpoint will override region

…tion methods.

XiXiaPdx

just a few items left. Thank you!

XiXiaPdx · 2021-06-25T19:24:31Z

telemetry-core/src/main/java/com/newrelic/telemetry/SenderConfiguration.java

+     * @return this builder
+     */
+    public SenderConfigurationBuilder setRegion(String region) throws IllegalArgumentException {
+      // Add IllegalArgumentException if region isn't US or EU


remove this comment plz

XiXiaPdx · 2021-06-25T19:27:49Z

telemetry-core/src/test/java/com/newrelic/telemetry/SenderConfigurationTest.java

+  }
+
+  @Test
+  void defaultEndpointAsStringTest() throws Exception {


I think this test just confirms toString() works? If. so, this test can be removed.

XiXiaPdx · 2021-06-25T19:29:10Z

telemetry-core/src/test/java/com/newrelic/telemetry/SenderConfigurationTest.java

+  }
+
+  @Test
+  void userEndpointAsStringTest() throws Exception {


same for this test, I think it can be removed

yamnihcg · 2021-06-25T23:04:11Z

EventBatchSender:

Default (to US Prod, US License Key): Successful
Set Region (to US Prod, US License Key): Successful
Set Region (to EU Prod, EU License Key): Successful
User Provided Endpoint: Successful

MetricBatchSender:

Default (to US Prod, US License Key): Successful
Set Region (to US Prod, US License Key): Successful
Set Region (to EU Prod, EU License Key): Successful
User Provided Endpoint: Successful

LogBatchSender:

Default (to US Prod, US License Key): Successful
Set Region (to US Prod, US License Key): Successful
Set Region (to EU Prod, EU License Key): Successful
User Provided Endpoint: Successful

SpanBatchSender:

Default (to US Prod, US License Key): Successful
Set Region (to US Prod, US License Key): Successful
Set Region (to EU Prod, EU License Key): Successful
User Provided Endpoint: Successful

XiXiaPdx · 2021-06-28T16:51:44Z

This looks great @yamnihcg and thank you for persistently chipping away at this! 🚀 🚀

Added EU endpoint support in SenderConfiguration and the BatchSenders…

97425f3

… for each data type

yamnihcg requested a review from XiXiaPdx June 11, 2021 22:09

yamnihcg added 6 commits June 11, 2021 15:13

Updated files with Google Java Formatter

1f2e45e

Updated EventBatchSender with EU endpoint support

00943f7

Updated BatchSenders, added tests for SenderConfiguration and BatchSe…

58e4813

…nders

Added functionality in BatchSenders to "prioritize" manual endpoins i…

521d8e5

…f set.

Added functionality in BatchSenders to "prioritize" manual endpoints …

5eb083b

…if set.

Fixed Javadoc formatting issue

ef384b7

yamnihcg changed the title ~~Added EU endpoint support in SenderConfiguration and the BatchSenders for Metric, Log, and Trace data types.~~ Added EU endpoint support in SenderConfiguration and the BatchSenders for all data types. Jun 21, 2021

yamnihcg changed the title ~~Added EU endpoint support in SenderConfiguration and the BatchSenders for all data types.~~ Added EU endpoint support and Tests in SenderConfiguration and the BatchSenders for all data types. Jun 21, 2021

yamnihcg changed the title ~~Added EU endpoint support and Tests in SenderConfiguration and the BatchSenders for all data types.~~ Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. Jun 21, 2021

XiXiaPdx suggested changes Jun 21, 2021

View reviewed changes

Fixed DEFAULT_URL in BatchSenders and added tests for SenderConfigura…

f7280d2

…tion methods.

XiXiaPdx suggested changes Jun 25, 2021

View reviewed changes

Removed .toString() tests in SenderConfigurationTest, fixed formatting

2f265b9

XiXiaPdx approved these changes Jun 28, 2021

View reviewed changes

yamnihcg merged commit e848562 into main Jun 28, 2021

yamnihcg deleted the eu-endpoint-feature-branch branch June 28, 2021 17:10

yamnihcg mentioned this pull request Jun 28, 2021

Make it easy to select the EU region endpoints #188

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. #276

Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. #276

yamnihcg commented Jun 11, 2021 •

edited

Loading

XiXiaPdx left a comment

XiXiaPdx Jun 21, 2021

XiXiaPdx Jun 21, 2021

XiXiaPdx Jun 21, 2021

XiXiaPdx Jun 21, 2021

XiXiaPdx left a comment

XiXiaPdx Jun 25, 2021

XiXiaPdx Jun 25, 2021

XiXiaPdx Jun 25, 2021

yamnihcg commented Jun 25, 2021

XiXiaPdx commented Jun 28, 2021

Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. #276

Added EU endpoint support and Unit tests in SenderConfiguration and the BatchSenders for all data types. #276

Conversation

yamnihcg commented Jun 11, 2021 • edited Loading

XiXiaPdx left a comment

Choose a reason for hiding this comment

XiXiaPdx Jun 21, 2021

Choose a reason for hiding this comment

XiXiaPdx Jun 21, 2021

Choose a reason for hiding this comment

XiXiaPdx Jun 21, 2021

Choose a reason for hiding this comment

XiXiaPdx Jun 21, 2021

Choose a reason for hiding this comment

XiXiaPdx left a comment

Choose a reason for hiding this comment

XiXiaPdx Jun 25, 2021

Choose a reason for hiding this comment

XiXiaPdx Jun 25, 2021

Choose a reason for hiding this comment

XiXiaPdx Jun 25, 2021

Choose a reason for hiding this comment

yamnihcg commented Jun 25, 2021

XiXiaPdx commented Jun 28, 2021

yamnihcg commented Jun 11, 2021 •

edited

Loading