Skip to content

Commit

Permalink
Implement a few more attributes, fix ARNs
Browse files Browse the repository at this point in the history
This commit adds implementations for the `aws.ecs.launchtype`
and `aws.logs.stream.arns` attributes, as well as fixing
the generation of log group ARNs.
  • Loading branch information
Michele Mancioppi authored and felixscheinost committed Aug 30, 2022
1 parent 9b0b6b4 commit 57cd334
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 17 deletions.
Expand Up @@ -15,6 +15,7 @@
import java.io.IOException;
import java.util.Collections;
import java.util.Map;
import java.util.Optional;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Matcher;
Expand Down Expand Up @@ -73,21 +74,38 @@ static void fetchMetadata(
ResourceAttributes.CLOUD_PLATFORM, ResourceAttributes.CloudPlatformValues.AWS_ECS);
try (JsonParser parser = JSON_FACTORY.createParser(json)) {
parser.nextToken();
LogGroupArnBuilder logGroupArnBuilder = new LogGroupArnBuilder();
parseResponse(parser, attrBuilders, logGroupArnBuilder);
logGroupArnBuilder.putLogGroupArnInAttributesBuilder(attrBuilders);
LogArnBuilder logArnBuilder = new LogArnBuilder();
parseResponse(parser, attrBuilders, logArnBuilder);

logArnBuilder
.getLogGroupArn()
.ifPresent(
logGroupArn -> {
attrBuilders.put(
ResourceAttributes.AWS_LOG_GROUP_ARNS, Collections.singletonList(logGroupArn));
});

logArnBuilder
.getLogStreamArn()
.ifPresent(
logStreamArn -> {
attrBuilders.put(
ResourceAttributes.AWS_LOG_STREAM_ARNS,
Collections.singletonList(logStreamArn));
});
} catch (IOException e) {
logger.log(Level.WARNING, "Can't get ECS metadata", e);
}
}

static void parseResponse(
JsonParser parser, AttributesBuilder attrBuilders, LogGroupArnBuilder logGroupArnBuilder)
JsonParser parser, AttributesBuilder attrBuilders, LogArnBuilder logArnBuilder)
throws IOException {
if (!parser.isExpectedStartObjectToken()) {
logger.log(Level.WARNING, "Couldn't parse ECS metadata, invalid JSON");
return;
}

while (parser.nextToken() != JsonToken.END_OBJECT) {
String value = parser.nextTextValue();
switch (parser.getCurrentName()) {
Expand All @@ -99,7 +117,7 @@ static void parseResponse(
break;
case "ContainerARN":
attrBuilders.put(ResourceAttributes.AWS_ECS_CONTAINER_ARN, value);
logGroupArnBuilder.setContainerArn(value);
logArnBuilder.setContainerArn(value);
break;
case "Image":
DockerImage parsedImage = DockerImage.parse(value);
Expand All @@ -113,21 +131,25 @@ static void parseResponse(
break;
case "LogOptions":
// Recursively parse LogOptions
parseResponse(parser, attrBuilders, logGroupArnBuilder);
parseResponse(parser, attrBuilders, logArnBuilder);
break;
case "awslogs-group":
attrBuilders.put(ResourceAttributes.AWS_LOG_GROUP_NAMES, value);
logGroupArnBuilder.setLogGroupName(value);
logArnBuilder.setLogGroupName(value);
break;
case "awslogs-stream":
attrBuilders.put(ResourceAttributes.AWS_LOG_STREAM_NAMES, value);
logArnBuilder.setLogStreamName(value);
break;
case "awslogs-region":
logGroupArnBuilder.setRegion(value);
logArnBuilder.setRegion(value);
break;
case "TaskARN":
attrBuilders.put(ResourceAttributes.AWS_ECS_TASK_ARN, value);
break;
case "LaunchType":
attrBuilders.put(ResourceAttributes.AWS_ECS_LAUNCHTYPE, value.toLowerCase());
break;
case "Family":
attrBuilders.put(ResourceAttributes.AWS_ECS_TASK_FAMILY, value);
break;
Expand All @@ -144,17 +166,18 @@ static void parseResponse(
private EcsResource() {}

/**
* This builder can piece together a log group ARN from region, account and group name as the ARN
* isn't part of the ECS metadata.
* This builder can piece together the ARN of a log group or a log stream from region, account,
* group name and stream name as the ARN isn't part of the ECS metadata.
*
* <p>If we just set AWS_LOG_GROUP_NAMES then the CloudWatch X-Ray traces view displays "An error
* occurred fetching your data". That's why it's important we set the ARN.
*/
private static class LogGroupArnBuilder {
private static class LogArnBuilder {

@Nullable String region;
@Nullable String account;
@Nullable String logGroupName;
@Nullable String logStreamName;

void setRegion(@Nullable String region) {
this.region = region;
Expand All @@ -164,19 +187,39 @@ void setLogGroupName(@Nullable String logGroupName) {
this.logGroupName = logGroupName;
}

void setLogStreamName(@Nullable String logStreamName) {
this.logStreamName = logStreamName;
}

void setContainerArn(@Nullable String containerArn) {
if (containerArn != null) {
account = containerArn.split(":")[4];
}
}

void putLogGroupArnInAttributesBuilder(AttributesBuilder attributesBuilder) {
Optional<String> getLogGroupArn() {
if (region == null || account == null || logGroupName == null) {
return;
return Optional.empty();
}
attributesBuilder.put(
ResourceAttributes.AWS_LOG_GROUP_ARNS,
"arn:aws:logs:" + region + ":" + account + ":log-group:" + logGroupName);

return Optional.of(
"arn:aws:logs:" + region + ":" + account + ":log-group:" + logGroupName + ":*");
}

Optional<String> getLogStreamArn() {
if (region == null || account == null || logGroupName == null || logStreamName == null) {
return Optional.empty();
}

return Optional.of(
"arn:aws:logs:"
+ region
+ ":"
+ account
+ ":log-group:"
+ logGroupName
+ ":log-stream:"
+ logStreamName);
}
}

Expand Down
Expand Up @@ -104,13 +104,18 @@ void testCreateAttributesV4() throws IOException {
entry(
ResourceAttributes.AWS_LOG_GROUP_ARNS,
Collections.singletonList(
"arn:aws:logs:us-west-2:111122223333:log-group:/ecs/metadata")),
"arn:aws:logs:us-west-2:111122223333:log-group:/ecs/metadata:*")),
entry(
ResourceAttributes.AWS_LOG_STREAM_NAMES,
Collections.singletonList("ecs/curl/8f03e41243824aea923aca126495f665")),
entry(
ResourceAttributes.AWS_LOG_STREAM_ARNS,
Collections.singletonList(
"arn:aws:logs:us-west-2:111122223333:log-group:/ecs/metadata:log-stream:ecs/curl/8f03e41243824aea923aca126495f665")),
entry(
ResourceAttributes.AWS_ECS_TASK_ARN,
"arn:aws:ecs:us-west-2:111122223333:task/default/158d1c8083dd49d6b527399fd6414f5c"),
entry(ResourceAttributes.AWS_ECS_LAUNCHTYPE, "ec2"),
entry(ResourceAttributes.AWS_ECS_TASK_FAMILY, "curltest"),
entry(ResourceAttributes.AWS_ECS_TASK_REVISION, "26"));
}
Expand Down

0 comments on commit 57cd334

Please sign in to comment.