initial commit of logging support extension

sdk_extensions/logging/README.md

@@ -0,0 +1,6 @@
+# OpenTelemetry Experimental Logging Support
+
+This project contains experimental support for transport of logs via OpenTelemetry. The API
+presented is intended for the use of logging library adapters to enable resource and request
+correlation with other observability signals and transport of logs through the OpenTelemetry
+collector.

sdk_extensions/logging/build.gradle

@@ -0,0 +1,20 @@
+plugins {
+    id "java"
+    id "maven-publish"
+
+    id "ru.vyarus.animalsniffer"
+}
+
+description = 'OpenTelemetry Contrib Logging Support'
+ext.moduleName = "io.opentelemetry.sdk.extensions.logging"
+
+dependencies {
+    api project(':opentelemetry-sdk')
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.10.4'
+    testImplementation libraries.awaitility
+
+    annotationProcessor libraries.auto_value
+
+    signature "org.codehaus.mojo.signature:java17:1.0@signature"
+    signature "net.sf.androidscents.signature:android-api-level-24:7.0_r2@signature"
+}

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/LogProcessor.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.sdk.logging;
+
+import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.logging.data.LogRecord;
+import io.opentelemetry.sdk.trace.TracerSdkProvider;
+
+public interface LogProcessor {
+
+  void addLogRecord(LogRecord record);
+
+  /**
+   * Called when {@link TracerSdkProvider#shutdown()} is called.
+   *
+   * @return result
+   */
+  CompletableResultCode shutdown();
+
+  /**
+   * Processes all span events that have not yet been processed.
+   *
+   * @return result
+   */
+  CompletableResultCode forceFlush();
+}

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/LogSink.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.sdk.logging;
+
+import io.opentelemetry.sdk.logging.data.LogRecord;
+
+/** A LogSink accepts logging records for transmission to an aggregator or log processing system. */
+public interface LogSink {
+  /**
+   * Pass a record to the SDK for transmission to a logging exporter.
+   *
+   * @param record record to transmit
+   */
+  void offer(LogRecord record);
+}

sdk_extensions/logging/src/main/java/io/opentelemetry/sdk/logging/LogSinkSdkProvider.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2020, OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.sdk.logging;
+
+import io.opentelemetry.internal.Utils;
+import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.logging.data.LogRecord;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class LogSinkSdkProvider {
+  private final LogSink logSink = new SdkLogSink();
+  private final List<LogProcessor> processors = new ArrayList<>();
+
+  private LogSinkSdkProvider() {}
+
+  public LogSink get(String instrumentationName, String instrumentationVersion) {
+    // Currently there is no differentiation by instrumentation library
+    return logSink;
+  }
+
+  public void addLogProcessor(LogProcessor processor) {
+    processors.add(Utils.checkNotNull(processor, "Processor can not be null"));
+  }
+
+  /**
+   * Flushes all attached processors.
+   *
+   * @return result
+   */
+  public CompletableResultCode forceFlush() {
+    final List<CompletableResultCode> processorResults = new ArrayList<>(processors.size());
+    for (LogProcessor processor : processors) {
+      processorResults.add(processor.forceFlush());
+    }
+    return CompletableResultCode.ofAll(processorResults);
+  }
+
+  /**
+   * Shut down of provider and associated processors.
+   *
+   * @return result
+   */
+  public CompletableResultCode shutdown() {
+    Collection<CompletableResultCode> processorResults = new ArrayList<>(processors.size());
+    for (LogProcessor processor : processors) {
+      processorResults.add(processor.shutdown());
+    }
+    return CompletableResultCode.ofAll(processorResults);
+  }
+
+  private class SdkLogSink implements LogSink {
+    @Override
+    public void offer(LogRecord record) {
+      for (LogProcessor processor : processors) {
+        processor.addLogRecord(record);
+      }
+    }
+  }
+
+  public static class Builder {
+    public LogSinkSdkProvider build() {
+      return new LogSinkSdkProvider();
+    }
+  }
+}