From 8157af01a10e7c834951b4a9c464224622e207dd Mon Sep 17 00:00:00 2001 From: John Watson Date: Wed, 23 Sep 2020 18:28:44 -0700 Subject: [PATCH] Update zipkin attribute names to match the spec. (#1693) * Update zipkin attribute names to match the spec. * remove out of date comment. --- .../exporters/zipkin/ZipkinSpanExporter.java | 12 ++++-------- .../exporters/zipkin/ZipkinSpanExporterTest.java | 4 ++-- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/exporters/zipkin/src/main/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporter.java b/exporters/zipkin/src/main/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporter.java index 6495e3d44f..f1b1c42f35 100644 --- a/exporters/zipkin/src/main/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporter.java +++ b/exporters/zipkin/src/main/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporter.java @@ -81,12 +81,8 @@ public final class ZipkinSpanExporter implements SpanExporter { private static final Logger logger = Logger.getLogger(ZipkinSpanExporter.class.getName()); - // The naming follows Zipkin convention. For http see here: - // https://github.com/openzipkin/brave/blob/eee993f998ae57b08644cc357a6d478827428710/instrumentation/http/src/main/java/brave/http/HttpTags.java - // For discussion about GRPC errors/tags, see here: https://github.com/openzipkin/brave/pull/999 - // Note: these 3 fields are non-private for testing - static final String GRPC_STATUS_CODE = "grpc.status_code"; - static final String GRPC_STATUS_DESCRIPTION = "grpc.status_description"; + static final String OTEL_STATUS_CODE = "otel.status_code"; + static final String OTEL_STATUS_DESCRIPTION = "otel.status_description"; static final AttributeKey STATUS_ERROR = stringKey("error"); static final String KEY_INSTRUMENTATION_LIBRARY_NAME = "otel.instrumentation_library.name"; @@ -159,9 +155,9 @@ public final class ZipkinSpanExporter implements SpanExporter { Status status = spanData.getStatus(); // for GRPC spans, include status code & description. if (status != null && spanAttributes.get(SemanticAttributes.RPC_SERVICE) != null) { - spanBuilder.putTag(GRPC_STATUS_CODE, status.getCanonicalCode().toString()); + spanBuilder.putTag(OTEL_STATUS_CODE, status.getCanonicalCode().toString()); if (status.getDescription() != null) { - spanBuilder.putTag(GRPC_STATUS_DESCRIPTION, status.getDescription()); + spanBuilder.putTag(OTEL_STATUS_DESCRIPTION, status.getDescription()); } } // add the error tag, if it isn't already in the source span. diff --git a/exporters/zipkin/src/test/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporterTest.java b/exporters/zipkin/src/test/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporterTest.java index 864b59a48a..70ff8449f1 100644 --- a/exporters/zipkin/src/test/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporterTest.java +++ b/exporters/zipkin/src/test/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporterTest.java @@ -226,9 +226,9 @@ class ZipkinSpanExporterTest { .isEqualTo( buildZipkinSpan(Span.Kind.SERVER) .toBuilder() - .putTag(ZipkinSpanExporter.GRPC_STATUS_DESCRIPTION, errorMessage) + .putTag(ZipkinSpanExporter.OTEL_STATUS_DESCRIPTION, errorMessage) .putTag(SemanticAttributes.RPC_SERVICE.getKey(), "my service name") - .putTag(ZipkinSpanExporter.GRPC_STATUS_CODE, "DEADLINE_EXCEEDED") + .putTag(ZipkinSpanExporter.OTEL_STATUS_CODE, "DEADLINE_EXCEEDED") .putTag(ZipkinSpanExporter.STATUS_ERROR.getKey(), "DEADLINE_EXCEEDED") .build()); }