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

OpenCensus to OpenTelemetry metric exporter #2085

Merged
merged 9 commits into from
Dec 7, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
89 changes: 45 additions & 44 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -309,54 +309,55 @@ configure(opentelemetryProjects) {
]

libraries = [
auto_value : "com.google.auto.value:auto-value:${autoValueVersion}",
auto_value_annotation : "com.google.auto.value:auto-value-annotations:${autoValueVersion}",
disruptor : "com.lmax:disruptor:3.4.2",
errorprone_annotation : "com.google.errorprone:error_prone_annotations:${errorProneVersion}",
errorprone_core : "com.google.errorprone:error_prone_core:${errorProneVersion}",
errorprone_javac : "com.google.errorprone:javac:${errorProneJavacVersion}",
grpc_api : "io.grpc:grpc-api",
grpc_context : "io.grpc:grpc-context",
grpc_protobuf : "io.grpc:grpc-protobuf",
grpc_stub : "io.grpc:grpc-stub",
guava : "com.google.guava:guava",
javax_annotations : "javax.annotation:javax.annotation-api:1.3.2",
jmh_core : "org.openjdk.jmh:jmh-core:${jmhVersion}",
jmh_bytecode : "org.openjdk.jmh:jmh-generator-bytecode:${jmhVersion}",
jsr305 : "com.google.code.findbugs:jsr305:${findBugsJsr305Version}",
prometheus_client : "io.prometheus:simpleclient:${prometheusVersion}",
prometheus_client_common: "io.prometheus:simpleclient_common:${prometheusVersion}",
protobuf : "com.google.protobuf:protobuf-java",
protobuf_util : "com.google.protobuf:protobuf-java-util",
zipkin_reporter : "io.zipkin.reporter2:zipkin-reporter",
zipkin_okhttp : "io.zipkin.reporter2:zipkin-sender-okhttp3",
auto_value : "com.google.auto.value:auto-value:${autoValueVersion}",
auto_value_annotation : "com.google.auto.value:auto-value-annotations:${autoValueVersion}",
disruptor : "com.lmax:disruptor:3.4.2",
errorprone_annotation : "com.google.errorprone:error_prone_annotations:${errorProneVersion}",
errorprone_core : "com.google.errorprone:error_prone_core:${errorProneVersion}",
errorprone_javac : "com.google.errorprone:javac:${errorProneJavacVersion}",
grpc_api : "io.grpc:grpc-api",
grpc_context : "io.grpc:grpc-context",
grpc_protobuf : "io.grpc:grpc-protobuf",
grpc_stub : "io.grpc:grpc-stub",
guava : "com.google.guava:guava",
javax_annotations : "javax.annotation:javax.annotation-api:1.3.2",
jmh_core : "org.openjdk.jmh:jmh-core:${jmhVersion}",
jmh_bytecode : "org.openjdk.jmh:jmh-generator-bytecode:${jmhVersion}",
jsr305 : "com.google.code.findbugs:jsr305:${findBugsJsr305Version}",
prometheus_client : "io.prometheus:simpleclient:${prometheusVersion}",
prometheus_client_common : "io.prometheus:simpleclient_common:${prometheusVersion}",
protobuf : "com.google.protobuf:protobuf-java",
protobuf_util : "com.google.protobuf:protobuf-java-util",
zipkin_reporter : "io.zipkin.reporter2:zipkin-reporter",
zipkin_okhttp : "io.zipkin.reporter2:zipkin-sender-okhttp3",

// Compatibility layer
opencensus_api : "io.opencensus:opencensus-api:${opencensusVersion}",
opencensus_impl : "io.opencensus:opencensus-impl:${opencensusVersion}",
opencensus_impl_core : "io.opencensus:opencensus-impl-core:${opencensusVersion}",
opentracing : "io.opentracing:opentracing-api:${opentracingVersion}",
opencensus_api : "io.opencensus:opencensus-api:${opencensusVersion}",
opencensus_impl : "io.opencensus:opencensus-impl:${opencensusVersion}",
opencensus_impl_core : "io.opencensus:opencensus-impl-core:${opencensusVersion}",
opencensus_metric_exporter : "io.opencensus:opencensus-exporter-metrics-util:${opencensusVersion}",
opentracing : "io.opentracing:opentracing-api:${opentracingVersion}",

// Test dependencies.
assertj : "org.assertj:assertj-core:3.18.1",
guava_testlib : "com.google.guava:guava-testlib",
junit : 'junit:junit:4.13.1',
junit_pioneer : 'org.junit-pioneer:junit-pioneer:1.0.0',
junit_jupiter_api : 'org.junit.jupiter:junit-jupiter-api',
junit_jupiter_engine : 'org.junit.jupiter:junit-jupiter-engine',
junit_vintage_engine : 'org.junit.vintage:junit-vintage-engine',
mockito : "org.mockito:mockito-core:${mockitoVersion}",
mockito_junit_jupiter : "org.mockito:mockito-junit-jupiter:${mockitoVersion}",
okhttp : 'com.squareup.okhttp3:okhttp:3.14.9',
system_rules : 'com.github.stefanbirkner:system-rules:1.19.0', // env and system properties
slf4jsimple : 'org.slf4j:slf4j-simple:1.7.30', // Compatibility layer
awaitility : 'org.awaitility:awaitility:4.0.3',
testcontainers : 'org.testcontainers:junit-jupiter:1.15.0',
rest_assured : 'io.rest-assured:rest-assured:4.2.0',
jaeger_client : 'io.jaegertracing:jaeger-client:1.5.0', // Jaeger Client
zipkin_junit : "io.zipkin.zipkin2:zipkin-junit:${zipkinVersion}", // Zipkin JUnit rule
archunit : 'com.tngtech.archunit:archunit-junit4:0.14.1', //Architectural constraints
jqf : 'edu.berkeley.cs.jqf:jqf-fuzz:1.6', // fuzz testing
assertj : "org.assertj:assertj-core:3.18.1",
guava_testlib : "com.google.guava:guava-testlib",
junit : 'junit:junit:4.13.1',
junit_pioneer : 'org.junit-pioneer:junit-pioneer:1.0.0',
junit_jupiter_api : 'org.junit.jupiter:junit-jupiter-api',
junit_jupiter_engine : 'org.junit.jupiter:junit-jupiter-engine',
junit_vintage_engine : 'org.junit.vintage:junit-vintage-engine',
mockito : "org.mockito:mockito-core:${mockitoVersion}",
mockito_junit_jupiter : "org.mockito:mockito-junit-jupiter:${mockitoVersion}",
okhttp : 'com.squareup.okhttp3:okhttp:3.14.9',
system_rules : 'com.github.stefanbirkner:system-rules:1.19.0', // env and system properties
slf4jsimple : 'org.slf4j:slf4j-simple:1.7.30', // Compatibility layer
awaitility : 'org.awaitility:awaitility:4.0.3',
testcontainers : 'org.testcontainers:junit-jupiter:1.15.0',
rest_assured : 'io.rest-assured:rest-assured:4.2.0',
jaeger_client : 'io.jaegertracing:jaeger-client:1.5.0', // Jaeger Client
zipkin_junit : "io.zipkin.zipkin2:zipkin-junit:${zipkinVersion}", // Zipkin JUnit rule
archunit : 'com.tngtech.archunit:archunit-junit4:0.14.1', //Architectural constraints
jqf : 'edu.berkeley.cs.jqf:jqf-fuzz:1.6', // fuzz testing

// Tooling
android_signature : 'com.toasttab.android:gummy-bears-api-24:0.3.0:coreLib@signature'
Expand Down
4 changes: 3 additions & 1 deletion opencensus-shim/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ ext.moduleName = "io.opentelemetry.opencensusshim"

dependencies {
api project(':opentelemetry-api'),
project(':opentelemetry-sdk'),
libraries.opencensus_api,
libraries.opencensus_impl_core
libraries.opencensus_impl_core,
libraries.opencensus_metric_exporter

testImplementation project(':opentelemetry-sdk'),
libraries.junit,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.opencensusshim;

import com.google.common.base.Joiner;
import io.opencensus.common.Duration;
import io.opencensus.exporter.metrics.util.IntervalMetricReader;
import io.opencensus.exporter.metrics.util.MetricExporter;
import io.opencensus.exporter.metrics.util.MetricReader;
import io.opencensus.metrics.Metrics;
import io.opencensus.metrics.export.Metric;
import io.opencensus.metrics.export.MetricDescriptor;
import io.opencensus.metrics.export.Point;
import io.opencensus.metrics.export.Summary;
import io.opencensus.metrics.export.Summary.Snapshot;
import io.opencensus.metrics.export.TimeSeries;
import io.opentelemetry.api.common.Labels;
import io.opentelemetry.api.common.LabelsBuilder;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.data.MetricData.DoublePoint;
import io.opentelemetry.sdk.metrics.data.MetricData.LongPoint;
import io.opentelemetry.sdk.metrics.data.MetricData.SummaryPoint;
import io.opentelemetry.sdk.metrics.data.MetricData.ValueAtPercentile;
import io.opentelemetry.sdk.resources.Resource;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;

public class OpenTelemetryMetricsExporter extends MetricExporter {
private static final Logger LOGGER =
Logger.getLogger(OpenTelemetryMetricsExporter.class.getName());

private static final String EXPORTER_NAME = "OpenTelemetryMetricExporter";
private static final InstrumentationLibraryInfo INSTRUMENTATION_LIBRARY_INFO =
InstrumentationLibraryInfo.create("io.opentelemetry.opencensusshim", null);

private final IntervalMetricReader intervalMetricReader;
private final io.opentelemetry.sdk.metrics.export.MetricExporter otelExporter;

public static OpenTelemetryMetricsExporter createAndRegister(
io.opentelemetry.sdk.metrics.export.MetricExporter otelExporter) {
return new OpenTelemetryMetricsExporter(otelExporter, Duration.create(60, 0));
}

public static OpenTelemetryMetricsExporter createAndRegister(
io.opentelemetry.sdk.metrics.export.MetricExporter otelExporter, Duration exportInterval) {
return new OpenTelemetryMetricsExporter(otelExporter, exportInterval);
}

private OpenTelemetryMetricsExporter(
io.opentelemetry.sdk.metrics.export.MetricExporter otelExporter, Duration exportInterval) {
this.otelExporter = otelExporter;
IntervalMetricReader.Options.Builder options = IntervalMetricReader.Options.builder();
MetricReader reader =
MetricReader.create(
MetricReader.Options.builder()
.setMetricProducerManager(Metrics.getExportComponent().getMetricProducerManager())
.setSpanName(EXPORTER_NAME)
.build());
intervalMetricReader =
IntervalMetricReader.create(
this, reader, options.setExportInterval(exportInterval).build());
}

@Override
public void export(Collection<Metric> metrics) {
ArrayList<MetricData> metricData = new ArrayList<>();
zoercai marked this conversation as resolved.
Show resolved Hide resolved
ArrayList<MetricDescriptor.Type> unsupportedTypes = new ArrayList<>();
zoercai marked this conversation as resolved.
Show resolved Hide resolved
for (Metric metric : metrics) {
for (TimeSeries timeSeries : metric.getTimeSeriesList()) {
LabelsBuilder labelsBuilder = Labels.builder();
for (int i = 0; i < metric.getMetricDescriptor().getLabelKeys().size(); i++) {
labelsBuilder.put(
metric.getMetricDescriptor().getLabelKeys().get(i).getKey(),
Objects.requireNonNull(timeSeries.getLabelValues().get(i).getValue()));
zoercai marked this conversation as resolved.
Show resolved Hide resolved
}
Labels labels = labelsBuilder.build();
ArrayList<MetricData.Point> points = new ArrayList<>();
MetricDescriptor.Type type = null;
for (Point point : timeSeries.getPoints()) {
long timestampNanos =
zoercai marked this conversation as resolved.
Show resolved Hide resolved
TimeUnit.SECONDS.toNanos(point.getTimestamp().getSeconds())
+ point.getTimestamp().getNanos();
type = metric.getMetricDescriptor().getType();
switch (type) {
case GAUGE_INT64:
case CUMULATIVE_INT64:
points.add(
LongPoint.create(
timestampNanos,
timestampNanos,
labels,
point
.getValue()
.match(
Double::longValue,
arg -> arg,
arg -> null,
arg -> null,
arg -> null)));
break;
case GAUGE_DOUBLE:
case CUMULATIVE_DOUBLE:
points.add(
DoublePoint.create(
timestampNanos,
timestampNanos,
labels,
point
.getValue()
.match(
arg -> arg,
Long::doubleValue,
arg -> null,
arg -> null,
arg -> null)));
break;
case SUMMARY:
points.add(
SummaryPoint.create(
timestampNanos,
timestampNanos,
labels,
point
.getValue()
.match(
arg -> null,
arg -> null,
arg -> null,
Summary::getCount,
arg -> null),
point
.getValue()
.match(
arg -> null, arg -> null, arg -> null, Summary::getSum, arg -> null),
point
.getValue()
.match(
arg -> null,
arg -> null,
arg -> null,
OpenTelemetryMetricsExporter::mapPercentiles,
arg -> null)));
break;
default:
unsupportedTypes.add(type);
break;
}
}
MetricData.Type metricDataType = mapType(type);
if (metricDataType != null) {
metricData.add(
MetricData.create(
Resource.getDefault(),
INSTRUMENTATION_LIBRARY_INFO,
metric.getMetricDescriptor().getName(),
metric.getMetricDescriptor().getDescription(),
metric.getMetricDescriptor().getUnit(),
metricDataType,
points));
}
}
}
if (!unsupportedTypes.isEmpty()) {
LOGGER.warning(
Joiner.on(",").join(unsupportedTypes)
+ " not supported by OpenCensus to OpenTelemetry migrator.");
}
if (!metricData.isEmpty()) {
otelExporter.export(metricData);
}
}

private static MetricData.Type mapType(MetricDescriptor.Type type) {
if (type == null) {
return null;
}
switch (type) {
case GAUGE_INT64:
return MetricData.Type.GAUGE_LONG;
case GAUGE_DOUBLE:
return MetricData.Type.GAUGE_DOUBLE;
case CUMULATIVE_INT64:
return MetricData.Type.MONOTONIC_LONG;
case CUMULATIVE_DOUBLE:
return MetricData.Type.MONOTONIC_DOUBLE;
case SUMMARY:
return MetricData.Type.SUMMARY;
default:
return null;
}
}

private static List<ValueAtPercentile> mapPercentiles(Summary arg) {
ArrayList<ValueAtPercentile> percentiles = new ArrayList<>();
for (Snapshot.ValueAtPercentile percentile : arg.getSnapshot().getValueAtPercentiles()) {
percentiles.add(ValueAtPercentile.create(percentile.getPercentile(), percentile.getValue()));
}
return percentiles;
}

public void stop() {
intervalMetricReader.stop();
}
}
Loading