observability: rename Observability to GcpObservability (#9030)

* observability: rename Observability to GcpObservability rename artifact to grpc-gcp-observability enable maven publication of grpc-gcp-observability
grpc · Mar 30, 2022 · 5113e92 · 5113e92
1 parent 30b5d6b
commit 5113e92
Show file tree

Hide file tree

Showing 32 changed files with 99 additions and 100 deletions.
diff --git a/observability/build.gradle → gcp-observability/build.gradle b/observability/build.gradle → gcp-observability/build.gradle
@@ -6,7 +6,7 @@ plugins {
     id "ru.vyarus.animalsniffer"
 }
 
-description = "gRPC: Observability"
+description = "gRPC: Google Cloud Platform Observability"
 
 [compileJava].each() {
     it.options.compilerArgs += [
@@ -52,5 +52,3 @@ dependencies {
 }
 
 configureProtoCompilation()
-
-[publishMavenPublicationToMavenRepository]*.onlyIf { false }
diff --git a/.../io/grpc/observability/Observability.java → ...c/gcp/observability/GcpObservability.java b/.../io/grpc/observability/Observability.java → ...c/gcp/observability/GcpObservability.java
@@ -14,34 +14,34 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.common.annotations.VisibleForTesting;
 import io.grpc.ExperimentalApi;
 import io.grpc.ManagedChannelProvider.ProviderNotFoundException;
+import io.grpc.gcp.observability.interceptors.ConfigFilterHelper;
+import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
+import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
+import io.grpc.gcp.observability.interceptors.LogHelper;
+import io.grpc.gcp.observability.logging.GcpLogSink;
+import io.grpc.gcp.observability.logging.Sink;
 import io.grpc.internal.TimeProvider;
-import io.grpc.observability.interceptors.ConfigFilterHelper;
-import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
-import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
-import io.grpc.observability.interceptors.LogHelper;
-import io.grpc.observability.logging.GcpLogSink;
-import io.grpc.observability.logging.Sink;
 import java.io.IOException;
 
-/** The main class for gRPC Observability features. */
+/** The main class for gRPC Google Cloud Platform Observability features. */
 @ExperimentalApi("https://github.com/grpc/grpc-java/issues/8869")
-public final class Observability implements AutoCloseable {
-  private static Observability instance = null;
+public final class GcpObservability implements AutoCloseable {
+  private static GcpObservability instance = null;
   private final Sink sink;
 
   /**
    * Initialize grpc-observability.
    *
    * @throws ProviderNotFoundException if no underlying channel/server provider is available.
    */
-  public static synchronized Observability grpcInit() throws IOException {
+  public static synchronized GcpObservability grpcInit() throws IOException {
     if (instance == null) {
       GlobalLoggingTags globalLoggingTags = new GlobalLoggingTags();
       ObservabilityConfigImpl observabilityConfig = ObservabilityConfigImpl.getInstance();
@@ -56,21 +56,21 @@ public static synchronized Observability grpcInit() throws IOException {
     return instance;
   }
 
-  @VisibleForTesting static Observability grpcInit(Sink sink,
+  @VisibleForTesting static GcpObservability grpcInit(Sink sink,
       InternalLoggingChannelInterceptor.Factory channelInterceptorFactory,
       InternalLoggingServerInterceptor.Factory serverInterceptorFactory) {
     if (instance == null) {
-      instance = new Observability(sink, channelInterceptorFactory, serverInterceptorFactory);
+      instance = new GcpObservability(sink, channelInterceptorFactory, serverInterceptorFactory);
     }
     return instance;
   }
 
   /** Un-initialize/shutdown grpc-observability. */
   @Override
   public void close() {
-    synchronized (Observability.class) {
+    synchronized (GcpObservability.class) {
       if (instance == null) {
-        throw new IllegalStateException("Observability already closed!");
+        throw new IllegalStateException("GcpObservability already closed!");
       }
       LoggingChannelProvider.shutdown();
       LoggingServerProvider.shutdown();
@@ -79,7 +79,7 @@ public void close() {
     }
   }
 
-  private Observability(Sink sink,
+  private GcpObservability(Sink sink,
       InternalLoggingChannelInterceptor.Factory channelInterceptorFactory,
       InternalLoggingServerInterceptor.Factory serverInterceptorFactory) {
     this.sink = checkNotNull(sink);

diff --git a/...grpc/observability/GlobalLoggingTags.java → .../gcp/observability/GlobalLoggingTags.java b/...grpc/observability/GlobalLoggingTags.java → .../gcp/observability/GlobalLoggingTags.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 

diff --git a/...observability/LoggingChannelProvider.java → ...observability/LoggingChannelProvider.java b/...observability/LoggingChannelProvider.java → ...observability/LoggingChannelProvider.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -23,7 +23,7 @@
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.ManagedChannelProvider;
 import io.grpc.ManagedChannelRegistry;
-import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
+import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
 
 /** A channel provider that injects logging interceptor. */
 final class LoggingChannelProvider extends ManagedChannelProvider {

diff --git a/.../observability/LoggingServerProvider.java → .../observability/LoggingServerProvider.java b/.../observability/LoggingServerProvider.java → .../observability/LoggingServerProvider.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -23,7 +23,7 @@
 import io.grpc.ServerCredentials;
 import io.grpc.ServerProvider;
 import io.grpc.ServerRegistry;
-import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
+import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
 
 /** A server provider that injects the logging interceptor. */
 final class LoggingServerProvider extends ServerProvider {

diff --git a/...io/grpc/observability/MetadataConfig.java → ...rpc/gcp/observability/MetadataConfig.java b/...io/grpc/observability/MetadataConfig.java → ...rpc/gcp/observability/MetadataConfig.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import com.google.api.client.http.GenericUrl;
 import com.google.api.client.http.HttpHeaders;

diff --git a/...pc/observability/ObservabilityConfig.java → ...cp/observability/ObservabilityConfig.java b/...pc/observability/ObservabilityConfig.java → ...cp/observability/ObservabilityConfig.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
 import java.util.List;

diff --git a/...bservability/ObservabilityConfigImpl.java → ...bservability/ObservabilityConfigImpl.java b/...bservability/ObservabilityConfigImpl.java → ...bservability/ObservabilityConfigImpl.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.base.Preconditions.checkArgument;
 
@@ -27,7 +27,7 @@
 import java.util.Map;
 
 /**
- * gRPC Observability configuration processor.
+ * gRPC GcpObservability configuration processor.
  */
 final class ObservabilityConfigImpl implements ObservabilityConfig {
   private static final String CONFIG_ENV_VAR_NAME = "GRPC_CONFIG_OBSERVABILITY";

diff --git a/...lity/interceptors/ConfigFilterHelper.java → ...lity/interceptors/ConfigFilterHelper.java b/...lity/interceptors/ConfigFilterHelper.java → ...lity/interceptors/ConfigFilterHelper.java
@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.interceptors;
+package io.grpc.gcp.observability.interceptors;
 
 import com.google.auto.value.AutoValue;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import io.grpc.Internal;
 import io.grpc.MethodDescriptor;
-import io.grpc.observability.ObservabilityConfig;
-import io.grpc.observability.ObservabilityConfig.LogFilter;
+import io.grpc.gcp.observability.ObservabilityConfig;
+import io.grpc.gcp.observability.ObservabilityConfig.LogFilter;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
 import java.util.HashMap;
 import java.util.List;
@@ -33,7 +33,7 @@
 import java.util.logging.Logger;
 
 /**
- * Parses gRPC Observability configuration filters for interceptors usage.
+ * Parses gRPC GcpObservability configuration filters for interceptors usage.
  */
 @Internal
 public class ConfigFilterHelper {

diff --git a/...ability/interceptors/InetAddressUtil.java → ...ability/interceptors/InetAddressUtil.java b/...ability/interceptors/InetAddressUtil.java → ...ability/interceptors/InetAddressUtil.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.interceptors;
+package io.grpc.gcp.observability.interceptors;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;

diff --git a/...rs/InternalLoggingChannelInterceptor.java → ...rs/InternalLoggingChannelInterceptor.java b/...rs/InternalLoggingChannelInterceptor.java → ...rs/InternalLoggingChannelInterceptor.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.interceptors;
+package io.grpc.gcp.observability.interceptors;
 
 import com.google.protobuf.Duration;
 import com.google.protobuf.util.Durations;
@@ -30,7 +30,7 @@
 import io.grpc.Metadata;
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
-import io.grpc.observability.interceptors.ConfigFilterHelper.FilterParams;
+import io.grpc.gcp.observability.interceptors.ConfigFilterHelper.FilterParams;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
 import java.util.UUID;

diff --git a/...ors/InternalLoggingServerInterceptor.java → ...ors/InternalLoggingServerInterceptor.java b/...ors/InternalLoggingServerInterceptor.java → ...ors/InternalLoggingServerInterceptor.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.interceptors;
+package io.grpc.gcp.observability.interceptors;
 
 import com.google.protobuf.Duration;
 import com.google.protobuf.util.Durations;
@@ -29,7 +29,7 @@
 import io.grpc.ServerInterceptor;
 import io.grpc.Status;
 
-import io.grpc.observability.interceptors.ConfigFilterHelper.FilterParams;
+import io.grpc.gcp.observability.interceptors.ConfigFilterHelper.FilterParams;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
 import java.net.SocketAddress;

diff --git a/...observability/interceptors/LogHelper.java → ...observability/interceptors/LogHelper.java b/...observability/interceptors/LogHelper.java → ...observability/interceptors/LogHelper.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.interceptors;
+package io.grpc.gcp.observability.interceptors;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
@@ -29,8 +29,8 @@
 import io.grpc.InternalMetadata;
 import io.grpc.Metadata;
 import io.grpc.Status;
+import io.grpc.gcp.observability.logging.Sink;
 import io.grpc.internal.TimeProvider;
-import io.grpc.observability.logging.Sink;
 import io.grpc.observabilitylog.v1.GrpcLogRecord;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.Address;
 import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
@@ -318,7 +318,7 @@ GrpcLogRecord.Builder createTimestamp() {
     return GrpcLogRecord.newBuilder().setTimestamp(Timestamps.fromNanos(nanos));
   }
 
-  // TODO(DNVindhya): Evaluate if we need following clause for metadata logging in Observability
+  // TODO(DNVindhya): Evaluate if we need following clause for metadata logging in GcpObservability
   // Leaving the implementation for now as is to have same behavior across Java and Go
   private static final Set<String> NEVER_INCLUDED_METADATA = new HashSet<>(
       Collections.singletonList(

diff --git a/...vability/logging/CloudLoggingHandler.java → ...vability/logging/CloudLoggingHandler.java b/...vability/logging/CloudLoggingHandler.java → ...vability/logging/CloudLoggingHandler.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.logging;
+package io.grpc.gcp.observability.logging;
 
 import com.google.cloud.MonitoredResource;
 import com.google.cloud.logging.LogEntry;

diff --git a/...rpc/observability/logging/GcpLogSink.java → ...gcp/observability/logging/GcpLogSink.java b/...rpc/observability/logging/GcpLogSink.java → ...gcp/observability/logging/GcpLogSink.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.logging;
+package io.grpc.gcp.observability.logging;
 
 import com.google.cloud.MonitoredResource;
 import com.google.cloud.logging.LogEntry;

diff --git a/...rvability/logging/LogRecordExtension.java → ...rvability/logging/LogRecordExtension.java b/...rvability/logging/LogRecordExtension.java → ...rvability/logging/LogRecordExtension.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.logging;
+package io.grpc.gcp.observability.logging;
 
 import io.grpc.Internal;
 import io.grpc.observabilitylog.v1.GrpcLogRecord;

diff --git a/...a/io/grpc/observability/logging/Sink.java → .../grpc/gcp/observability/logging/Sink.java b/...a/io/grpc/observability/logging/Sink.java → .../grpc/gcp/observability/logging/Sink.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability.logging;
+package io.grpc.gcp.observability.logging;
 
 import io.grpc.ExperimentalApi;
 import io.grpc.observabilitylog.v1.GrpcLogRecord;

diff --git a/...bservabilitylog/v1/observabilitylog.proto → ...bservabilitylog/v1/observabilitylog.proto b/...bservabilitylog/v1/observabilitylog.proto → ...bservabilitylog/v1/observabilitylog.proto
diff --git a/...grpc/observability/ObservabilityTest.java → ...p/observability/GcpObservabilityTest.java b/...grpc/observability/ObservabilityTest.java → ...p/observability/GcpObservabilityTest.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.fail;
@@ -23,15 +23,15 @@
 
 import io.grpc.ManagedChannelProvider;
 import io.grpc.ServerProvider;
-import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
-import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
-import io.grpc.observability.logging.Sink;
+import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
+import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
+import io.grpc.gcp.observability.logging.Sink;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
 @RunWith(JUnit4.class)
-public class ObservabilityTest {
+public class GcpObservabilityTest {
 
   @Test
   public void initFinish() {
@@ -42,12 +42,12 @@ public void initFinish() {
         InternalLoggingChannelInterceptor.Factory.class);
     InternalLoggingServerInterceptor.Factory serverInterceptorFactory = mock(
         InternalLoggingServerInterceptor.Factory.class);
-    Observability observability1;
-    try (Observability observability = Observability.grpcInit(sink, channelInterceptorFactory,
+    GcpObservability observability1;
+    try (GcpObservability observability = GcpObservability.grpcInit(sink, channelInterceptorFactory,
         serverInterceptorFactory)) {
       assertThat(ManagedChannelProvider.provider()).isInstanceOf(LoggingChannelProvider.class);
       assertThat(ServerProvider.provider()).isInstanceOf(ServerProvider.class);
-      observability1 = Observability.grpcInit(sink, channelInterceptorFactory,
+      observability1 = GcpObservability.grpcInit(sink, channelInterceptorFactory,
               serverInterceptorFactory);
       assertThat(observability1).isSameInstanceAs(observability);
 
@@ -59,7 +59,7 @@ public void initFinish() {
       observability1.close();
       fail("should have failed for calling close() second time");
     } catch (IllegalStateException e) {
-      assertThat(e).hasMessageThat().contains("Observability already closed!");
+      assertThat(e).hasMessageThat().contains("GcpObservability already closed!");
     }
   }
 }
diff --git a/.../observability/GlobalLoggingTagsTest.java → .../observability/GlobalLoggingTagsTest.java b/.../observability/GlobalLoggingTagsTest.java → .../observability/GlobalLoggingTagsTest.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.grpc.observability;
+package io.grpc.gcp.observability;
 
 import static com.google.common.truth.Truth.assertThat;