Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add response body for partial 207 errors for aggregated payload #751

Merged
merged 2 commits into from
Nov 10, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ private static void validate(AggregatedPayload payload) {
metricName = ((BluefloodSet) leafBean).getName();
}

if ((metricName.isEmpty()) && (payload.getAllMetricNames().size() > 0)) {
metricName = payload.getAllMetricNames().get(0);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does the first metricName in the list always relate to the current violation? If there isn't a metricName, does that mean that it couldn't be processed, and should be empty?

Copy link
Contributor Author

@VinnyQ VinnyQ Nov 9, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I tested this. Each "single" aggregatedPayload will have the metricName of the offending metric as the first element. And actually, it'll always be the case that each instance of AggregatedPayload will only contain one leaf "metric". Here's an example of the part of a payload this class represent:

{
      "tenantId":"333333",
      "timestamp":1478711535000,
      "flushInterval": 15000,
      "counters":[
          {
              "name":"agg.count.ten",
              "value":1,
              "rate":1
          }
      ]
    }

Even if the metric above is part of a multi-metrics payload like this:

curl -i -H "content-type: application/json" -X POST 'http://localhost:2440/v2.0/836986/ingest/aggregated/multi' -d \
  '[
    {
      "tenantId":"333333",
      "timestamp":1478711535000,
      "flushInterval": 15000,
      "counters":[
          {
              "name":"agg.count.nine",
              "value":1,
              "rate":1
          }
      ]
    },
    {
      "tenantId":"333333",
      "timestamp":1478711535000,
      "flushInterval": 15000,
      "counters":[
          {
              "name":"agg.count.ten",
              "value":2,
              "rate":1
          }
      ]
    },
    {
      "tenantId":"333333",
      "timestamp":1478711535000,
      "flushInterval": 15000,
      "counters":[
          {
              "name":"agg.count.eleven",
              "value":1,
              "rate":1
          },
          {
              "name":"agg.count.twelve",
              "value":1,
              "rate":1
          }
      ]
    }
  ]'

This is because if you look in the HttpAggregatedMultiIngestionHandler class, it first parse the entire json payload to each individual element (stored in bundleList:
https://github.com/rackerlabs/blueflood/blob/master/blueflood-http/src/main/java/com/rackspacecloud/blueflood/inputs/handlers/HttpAggregatedMultiIngestionHandler.java#L76
and
https://github.com/rackerlabs/blueflood/blob/master/blueflood-http/src/main/java/com/rackspacecloud/blueflood/inputs/handlers/HttpAggregatedMultiIngestionHandler.java#L176)

Then for each of the element in bundleList (an AggregatedPayload), it does the validation and create the error payload if there's violation: https://github.com/rackerlabs/blueflood/blob/master/blueflood-http/src/main/java/com/rackspacecloud/blueflood/inputs/handlers/HttpAggregatedMultiIngestionHandler.java#L85

In the majority of the cases, the metricName is set from the previous block in the AggregatedPayload.validate() here: https://github.com/rackerlabs/blueflood/blob/master/blueflood-core/src/main/java/com/rackspacecloud/blueflood/inputs/formats/AggregatedPayload.java#L105-L114

with the assumption that leafBean was created correctly from the json parser.

However, there were cases where the parser itself didn't create the AggregatedPayload element correctly (e.g. a missing "value" field that is required), resulting in the type of the element not being set and an empty metricName. In this case, the only way to retrieve the metricName is through the single json element payload itself.

Hope that make sense. But do know that I tried different cases during testing, including one with multiple aggregated payloads, with the first few being valid and the last one being invalid, and the error response has the correct metricName for the one failing the validation (and not ingested), not the first metricName in the request payload. You'll see a few of this cases in the system integration tests itself.


payload.validationErrors.add(new ErrorResponse.ErrorData(payload.getTenantId(), metricName,
source, constraintViolation.getMessage()));
}
Expand Down Expand Up @@ -158,7 +162,7 @@ public List<ErrorResponse.ErrorData> getValidationErrors() {
/**
* This method is invoked by the validator automatically
*/
@AssertTrue(message="Atleast one of the aggregated metrics(gauges, counters, timers, sets) are expected")
@AssertTrue(message="At least one of the aggregated metrics(gauges, counters, timers, sets) are expected")
private boolean isValid() {
boolean isGaugePresent = gauges != null && gauges.length > 0;
boolean isCounterPresent = counters != null && counters.length > 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@
import java.io.*;
import java.net.URISyntaxException;
import java.util.*;
import java.util.regex.Pattern;
import java.util.zip.GZIPOutputStream;

import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.assertTrue;
import static org.mockito.Mockito.*;
import static org.junit.Assert.*;
import static com.rackspacecloud.blueflood.TestUtils.*;

public class HttpHandlerIntegrationTest extends HttpIntegrationTestBase {

static private final String TENANT_ID = "acTEST";
static private long BEFORE_CURRENT_COLLECTIONTIME_MS = Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
static private long AFTER_CURRENT_COLLECTIONTIME_MS = Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );

//A time stamp 2 days ago
private final long baseMillis = Calendar.getInstance().getTimeInMillis() - 172800000;
Expand Down Expand Up @@ -85,7 +85,7 @@ public void testHttpIngestionInvalidPastCollectionTime() throws Exception {

String postfix = getPostfix();

long time = System.currentTimeMillis() - TIME_DIFF_MS - Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
long time = System.currentTimeMillis() - TIME_DIFF_MS - BEFORE_CURRENT_COLLECTIONTIME_MS;

HttpResponse response = postGenMetric(TENANT_ID, postfix, postPath, time );

Expand All @@ -95,8 +95,8 @@ public void testHttpIngestionInvalidPastCollectionTime() throws Exception {
assertEquals("Number of errors invalid", 3, errorResponse.getErrors().size());
for (int i = 0; i < 3; i++) {
assertEquals("Invalid error source", "collectionTime", errorResponse.getErrors().get(i).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(i).getMessage());
}

}
Expand All @@ -106,7 +106,7 @@ public void testHttpIngestionInvalidFutureCollectionTime() throws Exception {

String postfix = getPostfix();

long time = System.currentTimeMillis() + TIME_DIFF_MS + Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );
long time = System.currentTimeMillis() + TIME_DIFF_MS + AFTER_CURRENT_COLLECTIONTIME_MS;

HttpResponse response = postGenMetric(TENANT_ID, postfix, postPath, time );

Expand All @@ -116,17 +116,17 @@ public void testHttpIngestionInvalidFutureCollectionTime() throws Exception {
assertEquals("Number of errors invalid", 3, errorResponse.getErrors().size());
for (int i = 0; i < 3; i++) {
assertEquals("Invalid error source", "collectionTime", errorResponse.getErrors().get(i).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(i).getMessage());
}
}

@Test
public void testHttpIngestionPartialInvalidCollectionTime() throws Exception {
String postfix = getPostfix();
long validTime = System.currentTimeMillis();
long pastTime = System.currentTimeMillis() - TIME_DIFF_MS - Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
long futureTime = System.currentTimeMillis() + TIME_DIFF_MS + Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );
long pastTime = System.currentTimeMillis() - TIME_DIFF_MS - BEFORE_CURRENT_COLLECTIONTIME_MS;
long futureTime = System.currentTimeMillis() + TIME_DIFF_MS + AFTER_CURRENT_COLLECTIONTIME_MS;

String jsonBody = getJsonFromFile("sample_multi_payload_with_different_time.json", postfix);
jsonBody = updateTimeStampJson(jsonBody, "\"%TIMESTAMP_1%\"", validTime);
Expand All @@ -139,7 +139,11 @@ public void testHttpIngestionPartialInvalidCollectionTime() throws Exception {

try {
assertEquals("Should get status 207 from " + String.format(postMultiPath, TENANT_ID), 207, response.getStatusLine().getStatusCode() );
assertTrue("", errorResponse.getErrors().size() > 0);
for (int i = 0; i < 4; i++) {
assertEquals("Invalid error source", "collectionTime", errorResponse.getErrors().get(i).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(i).getMessage());
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}
finally {
EntityUtils.consume( response.getEntity() ); // Releases connection apparently
Expand All @@ -149,33 +153,31 @@ public void testHttpIngestionPartialInvalidCollectionTime() throws Exception {
@Test
public void testHttpAggregatedIngestionInvalidPastCollectionTime() throws IOException, URISyntaxException {

long timestamp = System.currentTimeMillis() - TIME_DIFF_MS
- Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
long timestamp = System.currentTimeMillis() - TIME_DIFF_MS - BEFORE_CURRENT_COLLECTIONTIME_MS;

HttpResponse response = postMetric("333333", postAggregatedPath, "sample_payload.json", timestamp, getPostfix());
ErrorResponse errorResponse = getErrorResponse(response);

assertEquals(400, response.getStatusLine().getStatusCode());
assertEquals("Number of errors invalid", 1, errorResponse.getErrors().size());
assertEquals("Invalid error source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
}

@Test
public void testHttpAggregatedIngestionInvalidFutureCollectionTime() throws IOException, URISyntaxException {

long timestamp = System.currentTimeMillis() + TIME_DIFF_MS
+ Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );
long timestamp = System.currentTimeMillis() + TIME_DIFF_MS + AFTER_CURRENT_COLLECTIONTIME_MS;

HttpResponse response = postMetric("333333", postAggregatedPath, "sample_payload.json", timestamp, getPostfix());
ErrorResponse errorResponse = getErrorResponse(response);

assertEquals(400, response.getStatusLine().getStatusCode());
assertEquals("Number of errors invalid", 1, errorResponse.getErrors().size());
assertEquals("Invalid error source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
}

@Test
Expand Down Expand Up @@ -207,8 +209,7 @@ locator, RollupType.COUNTER, new Range( start, end ),
@Test
public void testHttpAggregatedMultiIngestionInvalidPastCollectionTime() throws IOException, URISyntaxException {

long timestamp = System.currentTimeMillis() - TIME_DIFF_MS
- Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
long timestamp = System.currentTimeMillis() - TIME_DIFF_MS - BEFORE_CURRENT_COLLECTIONTIME_MS;

String postfix = getPostfix();

Expand All @@ -222,16 +223,15 @@ public void testHttpAggregatedMultiIngestionInvalidPastCollectionTime() throws I

assertEquals("Number of errors invalid", 3, errorResponse.getErrors().size());
assertEquals("Invalid error source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
}


@Test
public void testHttpAggregatedMultiIngestionInvalidFutureCollectionTime() throws IOException, URISyntaxException {

long timestamp = System.currentTimeMillis() + TIME_DIFF_MS
+ Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );
long timestamp = System.currentTimeMillis() + TIME_DIFF_MS + AFTER_CURRENT_COLLECTIONTIME_MS;

String postfix = getPostfix();

Expand All @@ -245,8 +245,8 @@ public void testHttpAggregatedMultiIngestionInvalidFutureCollectionTime() throws

assertEquals("Number of errors invalid", 3, errorResponse.getErrors().size());
assertEquals("Invalid error source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than 259200000 milliseconds into the past." +
" Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
}

@Test
Expand Down Expand Up @@ -292,8 +292,8 @@ locator2, RollupType.ENUM, new Range(start, end),
public void testHttpAggregatedMultiPartialInvalidCollectionTime() throws Exception {
String postfix = getPostfix();
long validTime = System.currentTimeMillis();
long pastTime = System.currentTimeMillis() - TIME_DIFF_MS - Configuration.getInstance().getLongProperty( CoreConfig.BEFORE_CURRENT_COLLECTIONTIME_MS );
long futureTime = System.currentTimeMillis() + TIME_DIFF_MS + Configuration.getInstance().getLongProperty( CoreConfig.AFTER_CURRENT_COLLECTIONTIME_MS );
long pastTime = System.currentTimeMillis() - TIME_DIFF_MS - BEFORE_CURRENT_COLLECTIONTIME_MS;
long futureTime = System.currentTimeMillis() + TIME_DIFF_MS + AFTER_CURRENT_COLLECTIONTIME_MS;

String jsonBody = getJsonFromFile("sample_multi_aggregated_payload_with_different_time.json", postfix);
jsonBody = updateTimeStampJson(jsonBody, "\"%TIMESTAMP_1%\"", validTime);
Expand All @@ -302,11 +302,15 @@ public void testHttpAggregatedMultiPartialInvalidCollectionTime() throws Excepti
jsonBody = jsonBody.replaceAll("%TENANT_ID_.%", TENANT_ID);

HttpResponse response = httpPost(TENANT_ID, postAggregatedMultiPath, jsonBody );
String[] output = getBodyArray(response);
ErrorResponse errorResponse = getErrorResponse(response);

try {
assertEquals("Should get status 207 from " + String.format(postAggregatedMultiPath, TENANT_ID), 207, response.getStatusLine().getStatusCode() );
assertEquals("", output[0]);
for (int i = 0; i < 2; i++) {
assertEquals("Invalid error source", "timestamp", errorResponse.getErrors().get(i).getSource());
assertEquals("Invalid error message", "Out of bounds. Cannot be more than " + BEFORE_CURRENT_COLLECTIONTIME_MS + " milliseconds into the past." +
" Cannot be more than " + AFTER_CURRENT_COLLECTIONTIME_MS + " milliseconds into the future", errorResponse.getErrors().get(i).getMessage());
}
}
finally {
EntityUtils.consume( response.getEntity() ); // Releases connection apparently
Expand Down Expand Up @@ -472,7 +476,10 @@ public void testMultiTenantPartialFailureWithoutTenant() throws Exception {

try {
assertEquals("Should get status 207 from " + String.format(postMultiPath, TENANT_ID), 207, response.getStatusLine().getStatusCode());
assertTrue("No errors found", errorResponse.getErrors().size() > 0);
for (int i = 0; i < 2; i++) {
assertEquals("Invalid error source", "tenantId", errorResponse.getErrors().get(i).getSource());
assertEquals("Invalid error message", "may not be empty", errorResponse.getErrors().get(i).getMessage());
}
}
finally {
EntityUtils.consume( response.getEntity() ); // Releases connection apparently
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public void handle(ChannelHandlerContext ctx, FullHttpRequest request) {
return;
} else {
// has some validation errors, response MULTI_STATUS
DefaultHandler.sendResponse(ctx, request, null, HttpResponseStatus.MULTI_STATUS);
DefaultHandler.sendErrorResponse(ctx, request, errors, HttpResponseStatus.MULTI_STATUS);
return;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ public void testEmptyTenantId() throws IOException {
assertEquals("Invalid error message", "may not be empty", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid source", "tenantId", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid tenant", "", errorResponse.getErrors().get(0).getTenantId());
assertEquals("Invalid metric name", "", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid metric name", "gauge.a.b", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid status", HttpResponseStatus.BAD_REQUEST, argument.getValue().getStatus());
}

Expand All @@ -226,7 +226,7 @@ public void testInvalidFlushInterval() throws IOException {
assertEquals("Invalid error message", "must be between 0 and 9223372036854775807", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid source", "flushInterval", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid tenant", TENANT, errorResponse.getErrors().get(0).getTenantId());
assertEquals("Invalid metric name", "", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid metric name", "gauge.a.b", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid status", HttpResponseStatus.BAD_REQUEST, argument.getValue().getStatus());
}

Expand All @@ -252,7 +252,7 @@ public void testCollectionTimeInPast() throws IOException {
"Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid tenant", TENANT, errorResponse.getErrors().get(0).getTenantId());
assertEquals("Invalid metric name", "", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid metric name", "gauge.a.b", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid status", HttpResponseStatus.BAD_REQUEST, argument.getValue().getStatus());
}

Expand All @@ -278,7 +278,7 @@ public void testCollectionTimeInFuture() throws IOException {
"Cannot be more than 600000 milliseconds into the future", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid source", "timestamp", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid tenant", TENANT, errorResponse.getErrors().get(0).getTenantId());
assertEquals("Invalid metric name", "", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid metric name", "gauge.a.b", errorResponse.getErrors().get(0).getMetricName());
assertEquals("Invalid status", HttpResponseStatus.BAD_REQUEST, argument.getValue().getStatus());
}

Expand All @@ -296,7 +296,7 @@ public void testAggregatedMetricsNotSet() throws IOException {
ErrorResponse errorResponse = getErrorResponse(errorResponseBody);

assertEquals("Number of errors invalid", 1, errorResponse.getErrors().size());
assertEquals("Invalid error message", "Atleast one of the aggregated metrics(gauges, counters, timers, sets) " +
assertEquals("Invalid error message", "At least one of the aggregated metrics(gauges, counters, timers, sets) " +
"are expected", errorResponse.getErrors().get(0).getMessage());
assertEquals("Invalid source", "", errorResponse.getErrors().get(0).getSource());
assertEquals("Invalid tenant", TENANT, errorResponse.getErrors().get(0).getTenantId());
Expand Down