Skip to content
This repository was archived by the owner on Dec 23, 2023. It is now read-only.

Stackdriver Trace Exporter: add resource labels to Spans. #1243

Merged
songy23 merged 7 commits into from
Jun 12, 2018
Merged

Stackdriver Trace Exporter: add resource labels to Spans. #1243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0696e3b
Stackdriver Trace Exporter: add resource labels to Spans.
songy23 Jun 7, 2018
57765e8
Fix review comments.
songy23 Jun 8, 2018
73c9f5e
Make resource labels static and only initialize once.
songy23 Jun 8, 2018
d62d5ba
Remove SuppressWarnings("unchecked")
songy23 Jun 12, 2018
64abe59
Passing resource_label map to generateSpan().
songy23 Jun 12, 2018
55c13af
Fix a checkstyle error.
songy23 Jun 12, 2018
f1e2bdb
Add more unit tests on resource labels.
songy23 Jun 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions buildscripts/import-control.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ General guidelines on imports:
<subpackage name="stackdriver">
<allow pkg="com.google"/>
<allow pkg="io.opencensus.exporter.trace.stackdriver"/>
<allow pkg="io.opencensus.contrib.monitoredresource.util"/>
</subpackage>
<subpackage name="zipkin">
<allow pkg="io.opencensus.exporter.trace.zipkin"/>
Expand Down
1 change: 1 addition & 0 deletions exporters/trace/stackdriver/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies {
compileOnly libraries.auto_value

compile project(':opencensus-api'),
project(':opencensus-contrib-monitored-resource-util'),
Copy link
Copy Markdown
Contributor

@sebright2 sebright2 Jun 8, 2018

Choose a reason for hiding this comment

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

Is there any issue with adding a dependency from an exporter to a package under contrib/ (for example, if the contrib packages are less stable)?

/cc @bogdandrutu

Copy link
Copy Markdown
Contributor Author

@songy23 songy23 Jun 8, 2018

Choose a reason for hiding this comment

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

I cannot think of any particular issue. Stackdriver Stats exporter also depends on this artifact, and I think we need to maintain the same backwards compatibility for contrib/ artifacts to apis.

libraries.google_auth

compile (libraries.google_cloud_trace) {
Expand Down
139 changes: 135 additions & 4 deletions .../src/main/java/io/opencensus/exporter/trace/stackdriver/StackdriverV2ExporterHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@
import io.opencensus.common.OpenCensusLibraryInformation;
import io.opencensus.common.Scope;
import io.opencensus.common.Timestamp;
import io.opencensus.contrib.monitoredresource.util.MonitoredResource;
import io.opencensus.contrib.monitoredresource.util.MonitoredResource.AwsEc2InstanceMonitoredResource;
import io.opencensus.contrib.monitoredresource.util.MonitoredResource.GcpGceInstanceMonitoredResource;
import io.opencensus.contrib.monitoredresource.util.MonitoredResource.GcpGkeContainerMonitoredResource;
import io.opencensus.contrib.monitoredresource.util.MonitoredResourceUtils;
import io.opencensus.contrib.monitoredresource.util.ResourceType;
import io.opencensus.trace.Annotation;
import io.opencensus.trace.MessageEvent.Type;
import io.opencensus.trace.Sampler;
Expand All @@ -60,8 +66,10 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

/*>>>
import org.checkerframework.checker.nullness.qual.Nullable;
Expand Down Expand Up @@ -91,6 +99,12 @@ final class StackdriverV2ExporterHandler extends SpanExporter.Handler {
.put("http.status_code", "/http/status_code")
.build();

@javax.annotation.Nullable
private static final MonitoredResource RESOURCE = MonitoredResourceUtils.getDefaultResource();

// Only initialize once.
private static final Map<String, AttributeValue> RESOURCE_LABELS = getResourceLabels(RESOURCE);

private final String projectId;
private final TraceServiceClient traceServiceClient;
private final ProjectName projectName;
Expand Down Expand Up @@ -122,7 +136,7 @@ static StackdriverV2ExporterHandler create(String projectId) throws IOException
}

@VisibleForTesting
Span generateSpan(SpanData spanData) {
Span generateSpan(SpanData spanData, Map<String, AttributeValue> resourceLabels) {
SpanContext context = spanData.getContext();
final String traceIdHex = encodeTraceId(context.getTraceId());
final String spanIdHex = encodeSpanId(context.getSpanId());
Expand All @@ -135,7 +149,7 @@ Span generateSpan(SpanData spanData) {
.setDisplayName(
toTruncatableStringProto(toDisplayName(spanData.getName(), spanData.getKind())))
.setStartTime(toTimestampProto(spanData.getStartTimestamp()))
.setAttributes(toAttributesProto(spanData.getAttributes()))
.setAttributes(toAttributesProto(spanData.getAttributes(), resourceLabels))
.setTimeEvents(
toTimeEventsProto(spanData.getAnnotations(), spanData.getMessageEvents()));
io.opencensus.trace.Status status = spanData.getStatus();
Expand Down Expand Up @@ -220,11 +234,15 @@ private static TimeEvent.MessageEvent.Type toMessageEventTypeProto(

// These are the attributes of the Span, where usually we may add more attributes like the agent.
private static Attributes toAttributesProto(
io.opencensus.trace.export.SpanData.Attributes attributes) {
io.opencensus.trace.export.SpanData.Attributes attributes,
Map<String, AttributeValue> resourceLabels) {
Attributes.Builder attributesBuilder =
toAttributesBuilderProto(
attributes.getAttributeMap(), attributes.getDroppedAttributesCount());
attributesBuilder.putAttributeMap(AGENT_LABEL_KEY, AGENT_LABEL_VALUE);
for (Entry<String, AttributeValue> entry : resourceLabels.entrySet()) {
attributesBuilder.putAttributeMap(entry.getKey(), entry.getValue());
}
return attributesBuilder.build();
}

Expand All @@ -239,6 +257,119 @@ private static Attributes.Builder toAttributesBuilderProto(
return attributesBuilder;
}

// TODO(songya): make constructor of MonitoredResource public, and add unit tests for this method.
private static Map<String, AttributeValue> getResourceLabels(
@javax.annotation.Nullable MonitoredResource resource) {
if (resource == null) {
return Collections.emptyMap();
}
Map<String, AttributeValue> resourceLabels = new HashMap<String, AttributeValue>();
ResourceType resourceType = resource.getResourceType();
switch (resourceType) {
case AWS_EC2_INSTANCE:
AwsEc2InstanceMonitoredResource awsEc2InstanceMonitoredResource =
(AwsEc2InstanceMonitoredResource) resource;
putToResourceAttributeMap(
resourceLabels,
resourceType,
"aws_account",
awsEc2InstanceMonitoredResource.getAccount());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"instance_id",
awsEc2InstanceMonitoredResource.getInstanceId());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"region",
"aws:" + awsEc2InstanceMonitoredResource.getRegion());
return Collections.unmodifiableMap(resourceLabels);
case GCP_GCE_INSTANCE:
GcpGceInstanceMonitoredResource gcpGceInstanceMonitoredResource =
(GcpGceInstanceMonitoredResource) resource;
putToResourceAttributeMap(
resourceLabels,
resourceType,
"project_id",
gcpGceInstanceMonitoredResource.getAccount());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"instance_id",
gcpGceInstanceMonitoredResource.getInstanceId());
putToResourceAttributeMap(
resourceLabels, resourceType, "zone", gcpGceInstanceMonitoredResource.getZone());
return Collections.unmodifiableMap(resourceLabels);
case GCP_GKE_CONTAINER:
GcpGkeContainerMonitoredResource gcpGkeContainerMonitoredResource =
(GcpGkeContainerMonitoredResource) resource;
putToResourceAttributeMap(
resourceLabels,
resourceType,
"project_id",
gcpGkeContainerMonitoredResource.getAccount());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"instance_id",
gcpGkeContainerMonitoredResource.getInstanceId());
putToResourceAttributeMap(
resourceLabels, resourceType, "zone", gcpGkeContainerMonitoredResource.getZone());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"cluster_name",
gcpGkeContainerMonitoredResource.getClusterName());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"container_name",
gcpGkeContainerMonitoredResource.getContainerName());
putToResourceAttributeMap(
resourceLabels,
resourceType,
"namespace_id",
gcpGkeContainerMonitoredResource.getNamespaceId());
putToResourceAttributeMap(
resourceLabels, resourceType, "pod_id", gcpGkeContainerMonitoredResource.getPodId());
return Collections.unmodifiableMap(resourceLabels);
}
return Collections.emptyMap();
}

private static void putToResourceAttributeMap(
Map<String, AttributeValue> map,
ResourceType resourceType,
String attributeName,
String attributeValue) {
map.put(
createResourceLabelKey(resourceType, attributeName),
toStringAttributeValueProto(attributeValue));
}

@VisibleForTesting
static String createResourceLabelKey(ResourceType resourceType, String resourceAttribute) {
return String.format("g.co/r/%s/%s", mapToStringResourceType(resourceType), resourceAttribute);
}

private static String mapToStringResourceType(ResourceType resourceType) {
switch (resourceType) {
case GCP_GCE_INSTANCE:
return "gce_instance";
case GCP_GKE_CONTAINER:
return "gke_container";
case AWS_EC2_INSTANCE:
return "aws_ec2_instance";
}
throw new IllegalArgumentException("Unknown resource type.");
}

@VisibleForTesting
static AttributeValue toStringAttributeValueProto(String value) {
return AttributeValue.newBuilder().setStringValue(toTruncatableStringProto(value)).build();
}

private static String mapKey(String key) {
if (HTTP_ATTRIBUTE_MAPPING.containsKey(key)) {
return HTTP_ATTRIBUTE_MAPPING.get(key);
Expand Down Expand Up @@ -347,7 +478,7 @@ public void export(Collection<SpanData> spanDataList) {
.startScopedSpan()) {
List<Span> spans = new ArrayList<>(spanDataList.size());
for (SpanData spanData : spanDataList) {
spans.add(generateSpan(spanData));
spans.add(generateSpan(spanData, RESOURCE_LABELS));
}
// Sync call because it is already called for a batch of data, and on a separate thread.
// TODO(bdrutu): Consider to make this async in the future.
Expand Down
Loading