Skip to content

Commit 5113e92

Browse files
sanjaypujaresanjaypujare
authored
observability: rename Observability to GcpObservability (grpc#9030)
* observability: rename Observability to GcpObservability rename artifact to grpc-gcp-observability enable maven publication of grpc-gcp-observability
1 parent 30b5d6b commit 5113e92

32 files changed

+99
-100
lines changed

‎observability/build.gradle renamed to ‎gcp-observability/build.gradle

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ plugins {
66
id "ru.vyarus.animalsniffer"
77
}
88

9-
description = "gRPC: Observability"
9+
description = "gRPC: Google Cloud Platform Observability"
1010

1111
[compileJava].each() {
1212
it.options.compilerArgs += [
@@ -52,5 +52,3 @@ dependencies {
5252
}
5353

5454
configureProtoCompilation()
55-
56-
[publishMavenPublicationToMavenRepository]*.onlyIf { false }

‎observability/src/main/java/io/grpc/observability/Observability.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/GcpObservability.java

+16-16
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,34 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.base.Preconditions.checkNotNull;
2020

2121
import com.google.common.annotations.VisibleForTesting;
2222
import io.grpc.ExperimentalApi;
2323
import io.grpc.ManagedChannelProvider.ProviderNotFoundException;
24+
import io.grpc.gcp.observability.interceptors.ConfigFilterHelper;
25+
import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
26+
import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
27+
import io.grpc.gcp.observability.interceptors.LogHelper;
28+
import io.grpc.gcp.observability.logging.GcpLogSink;
29+
import io.grpc.gcp.observability.logging.Sink;
2430
import io.grpc.internal.TimeProvider;
25-
import io.grpc.observability.interceptors.ConfigFilterHelper;
26-
import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
27-
import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
28-
import io.grpc.observability.interceptors.LogHelper;
29-
import io.grpc.observability.logging.GcpLogSink;
30-
import io.grpc.observability.logging.Sink;
3131
import java.io.IOException;
3232

33-
/** The main class for gRPC Observability features. */
33+
/** The main class for gRPC Google Cloud Platform Observability features. */
3434
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/8869")
35-
public final class Observability implements AutoCloseable {
36-
private static Observability instance = null;
35+
public final class GcpObservability implements AutoCloseable {
36+
private static GcpObservability instance = null;
3737
private final Sink sink;
3838

3939
/**
4040
* Initialize grpc-observability.
4141
*
4242
* @throws ProviderNotFoundException if no underlying channel/server provider is available.
4343
*/
44-
public static synchronized Observability grpcInit() throws IOException {
44+
public static synchronized GcpObservability grpcInit() throws IOException {
4545
if (instance == null) {
4646
GlobalLoggingTags globalLoggingTags = new GlobalLoggingTags();
4747
ObservabilityConfigImpl observabilityConfig = ObservabilityConfigImpl.getInstance();
@@ -56,21 +56,21 @@ public static synchronized Observability grpcInit() throws IOException {
5656
return instance;
5757
}
5858

59-
@VisibleForTesting static Observability grpcInit(Sink sink,
59+
@VisibleForTesting static GcpObservability grpcInit(Sink sink,
6060
InternalLoggingChannelInterceptor.Factory channelInterceptorFactory,
6161
InternalLoggingServerInterceptor.Factory serverInterceptorFactory) {
6262
if (instance == null) {
63-
instance = new Observability(sink, channelInterceptorFactory, serverInterceptorFactory);
63+
instance = new GcpObservability(sink, channelInterceptorFactory, serverInterceptorFactory);
6464
}
6565
return instance;
6666
}
6767

6868
/** Un-initialize/shutdown grpc-observability. */
6969
@Override
7070
public void close() {
71-
synchronized (Observability.class) {
71+
synchronized (GcpObservability.class) {
7272
if (instance == null) {
73-
throw new IllegalStateException("Observability already closed!");
73+
throw new IllegalStateException("GcpObservability already closed!");
7474
}
7575
LoggingChannelProvider.shutdown();
7676
LoggingServerProvider.shutdown();
@@ -79,7 +79,7 @@ public void close() {
7979
}
8080
}
8181

82-
private Observability(Sink sink,
82+
private GcpObservability(Sink sink,
8383
InternalLoggingChannelInterceptor.Factory channelInterceptorFactory,
8484
InternalLoggingServerInterceptor.Factory serverInterceptorFactory) {
8585
this.sink = checkNotNull(sink);

‎observability/src/main/java/io/grpc/observability/GlobalLoggingTags.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/GlobalLoggingTags.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.base.Preconditions.checkNotNull;
2020

‎observability/src/main/java/io/grpc/observability/LoggingChannelProvider.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/LoggingChannelProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.base.Preconditions.checkNotNull;
2020

@@ -23,7 +23,7 @@
2323
import io.grpc.ManagedChannelBuilder;
2424
import io.grpc.ManagedChannelProvider;
2525
import io.grpc.ManagedChannelRegistry;
26-
import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
26+
import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
2727

2828
/** A channel provider that injects logging interceptor. */
2929
final class LoggingChannelProvider extends ManagedChannelProvider {

‎observability/src/main/java/io/grpc/observability/LoggingServerProvider.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/LoggingServerProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.base.Preconditions.checkNotNull;
2020

@@ -23,7 +23,7 @@
2323
import io.grpc.ServerCredentials;
2424
import io.grpc.ServerProvider;
2525
import io.grpc.ServerRegistry;
26-
import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
26+
import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
2727

2828
/** A server provider that injects the logging interceptor. */
2929
final class LoggingServerProvider extends ServerProvider {

‎observability/src/main/java/io/grpc/observability/MetadataConfig.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/MetadataConfig.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import com.google.api.client.http.GenericUrl;
2020
import com.google.api.client.http.HttpHeaders;

‎observability/src/main/java/io/grpc/observability/ObservabilityConfig.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/ObservabilityConfig.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
2020
import java.util.List;

‎observability/src/main/java/io/grpc/observability/ObservabilityConfigImpl.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/ObservabilityConfigImpl.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.base.Preconditions.checkArgument;
2020

@@ -27,7 +27,7 @@
2727
import java.util.Map;
2828

2929
/**
30-
* gRPC Observability configuration processor.
30+
* gRPC GcpObservability configuration processor.
3131
*/
3232
final class ObservabilityConfigImpl implements ObservabilityConfig {
3333
private static final String CONFIG_ENV_VAR_NAME = "GRPC_CONFIG_OBSERVABILITY";

‎observability/src/main/java/io/grpc/observability/interceptors/ConfigFilterHelper.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/ConfigFilterHelper.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.interceptors;
17+
package io.grpc.gcp.observability.interceptors;
1818

1919
import com.google.auto.value.AutoValue;
2020
import com.google.common.annotations.VisibleForTesting;
2121
import com.google.common.collect.ImmutableMap;
2222
import com.google.common.collect.ImmutableSet;
2323
import io.grpc.Internal;
2424
import io.grpc.MethodDescriptor;
25-
import io.grpc.observability.ObservabilityConfig;
26-
import io.grpc.observability.ObservabilityConfig.LogFilter;
25+
import io.grpc.gcp.observability.ObservabilityConfig;
26+
import io.grpc.gcp.observability.ObservabilityConfig.LogFilter;
2727
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
2828
import java.util.HashMap;
2929
import java.util.List;
@@ -33,7 +33,7 @@
3333
import java.util.logging.Logger;
3434

3535
/**
36-
* Parses gRPC Observability configuration filters for interceptors usage.
36+
* Parses gRPC GcpObservability configuration filters for interceptors usage.
3737
*/
3838
@Internal
3939
public class ConfigFilterHelper {

‎observability/src/main/java/io/grpc/observability/interceptors/InetAddressUtil.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InetAddressUtil.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.interceptors;
17+
package io.grpc.gcp.observability.interceptors;
1818

1919
import static com.google.common.base.Preconditions.checkArgument;
2020
import static com.google.common.base.Preconditions.checkNotNull;

‎observability/src/main/java/io/grpc/observability/interceptors/InternalLoggingChannelInterceptor.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingChannelInterceptor.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.interceptors;
17+
package io.grpc.gcp.observability.interceptors;
1818

1919
import com.google.protobuf.Duration;
2020
import com.google.protobuf.util.Durations;
@@ -30,7 +30,7 @@
3030
import io.grpc.Metadata;
3131
import io.grpc.MethodDescriptor;
3232
import io.grpc.Status;
33-
import io.grpc.observability.interceptors.ConfigFilterHelper.FilterParams;
33+
import io.grpc.gcp.observability.interceptors.ConfigFilterHelper.FilterParams;
3434
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
3535
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
3636
import java.util.UUID;

‎observability/src/main/java/io/grpc/observability/interceptors/InternalLoggingServerInterceptor.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/InternalLoggingServerInterceptor.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.interceptors;
17+
package io.grpc.gcp.observability.interceptors;
1818

1919
import com.google.protobuf.Duration;
2020
import com.google.protobuf.util.Durations;
@@ -29,7 +29,7 @@
2929
import io.grpc.ServerInterceptor;
3030
import io.grpc.Status;
3131

32-
import io.grpc.observability.interceptors.ConfigFilterHelper.FilterParams;
32+
import io.grpc.gcp.observability.interceptors.ConfigFilterHelper.FilterParams;
3333
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
3434
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventType;
3535
import java.net.SocketAddress;

‎observability/src/main/java/io/grpc/observability/interceptors/LogHelper.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/interceptors/LogHelper.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.interceptors;
17+
package io.grpc.gcp.observability.interceptors;
1818

1919
import static com.google.common.base.Preconditions.checkArgument;
2020
import static com.google.common.base.Preconditions.checkNotNull;
@@ -29,8 +29,8 @@
2929
import io.grpc.InternalMetadata;
3030
import io.grpc.Metadata;
3131
import io.grpc.Status;
32+
import io.grpc.gcp.observability.logging.Sink;
3233
import io.grpc.internal.TimeProvider;
33-
import io.grpc.observability.logging.Sink;
3434
import io.grpc.observabilitylog.v1.GrpcLogRecord;
3535
import io.grpc.observabilitylog.v1.GrpcLogRecord.Address;
3636
import io.grpc.observabilitylog.v1.GrpcLogRecord.EventLogger;
@@ -318,7 +318,7 @@ GrpcLogRecord.Builder createTimestamp() {
318318
return GrpcLogRecord.newBuilder().setTimestamp(Timestamps.fromNanos(nanos));
319319
}
320320

321-
// TODO(DNVindhya): Evaluate if we need following clause for metadata logging in Observability
321+
// TODO(DNVindhya): Evaluate if we need following clause for metadata logging in GcpObservability
322322
// Leaving the implementation for now as is to have same behavior across Java and Go
323323
private static final Set<String> NEVER_INCLUDED_METADATA = new HashSet<>(
324324
Collections.singletonList(

‎observability/src/main/java/io/grpc/observability/logging/CloudLoggingHandler.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/logging/CloudLoggingHandler.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.logging;
17+
package io.grpc.gcp.observability.logging;
1818

1919
import com.google.cloud.MonitoredResource;
2020
import com.google.cloud.logging.LogEntry;

‎observability/src/main/java/io/grpc/observability/logging/GcpLogSink.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/logging/GcpLogSink.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.logging;
17+
package io.grpc.gcp.observability.logging;
1818

1919
import com.google.cloud.MonitoredResource;
2020
import com.google.cloud.logging.LogEntry;

‎observability/src/main/java/io/grpc/observability/logging/LogRecordExtension.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/logging/LogRecordExtension.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.logging;
17+
package io.grpc.gcp.observability.logging;
1818

1919
import io.grpc.Internal;
2020
import io.grpc.observabilitylog.v1.GrpcLogRecord;

‎observability/src/main/java/io/grpc/observability/logging/Sink.java renamed to ‎gcp-observability/src/main/java/io/grpc/gcp/observability/logging/Sink.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability.logging;
17+
package io.grpc.gcp.observability.logging;
1818

1919
import io.grpc.ExperimentalApi;
2020
import io.grpc.observabilitylog.v1.GrpcLogRecord;

‎observability/src/main/proto/grpc/observabilitylog/v1/observabilitylog.proto renamed to ‎gcp-observability/src/main/proto/grpc/observabilitylog/v1/observabilitylog.proto

File renamed without changes.

‎observability/src/test/java/io/grpc/observability/ObservabilityTest.java renamed to ‎gcp-observability/src/test/java/io/grpc/gcp/observability/GcpObservabilityTest.java

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.truth.Truth.assertThat;
2020
import static org.junit.Assert.fail;
@@ -23,15 +23,15 @@
2323

2424
import io.grpc.ManagedChannelProvider;
2525
import io.grpc.ServerProvider;
26-
import io.grpc.observability.interceptors.InternalLoggingChannelInterceptor;
27-
import io.grpc.observability.interceptors.InternalLoggingServerInterceptor;
28-
import io.grpc.observability.logging.Sink;
26+
import io.grpc.gcp.observability.interceptors.InternalLoggingChannelInterceptor;
27+
import io.grpc.gcp.observability.interceptors.InternalLoggingServerInterceptor;
28+
import io.grpc.gcp.observability.logging.Sink;
2929
import org.junit.Test;
3030
import org.junit.runner.RunWith;
3131
import org.junit.runners.JUnit4;
3232

3333
@RunWith(JUnit4.class)
34-
public class ObservabilityTest {
34+
public class GcpObservabilityTest {
3535

3636
@Test
3737
public void initFinish() {
@@ -42,12 +42,12 @@ public void initFinish() {
4242
InternalLoggingChannelInterceptor.Factory.class);
4343
InternalLoggingServerInterceptor.Factory serverInterceptorFactory = mock(
4444
InternalLoggingServerInterceptor.Factory.class);
45-
Observability observability1;
46-
try (Observability observability = Observability.grpcInit(sink, channelInterceptorFactory,
45+
GcpObservability observability1;
46+
try (GcpObservability observability = GcpObservability.grpcInit(sink, channelInterceptorFactory,
4747
serverInterceptorFactory)) {
4848
assertThat(ManagedChannelProvider.provider()).isInstanceOf(LoggingChannelProvider.class);
4949
assertThat(ServerProvider.provider()).isInstanceOf(ServerProvider.class);
50-
observability1 = Observability.grpcInit(sink, channelInterceptorFactory,
50+
observability1 = GcpObservability.grpcInit(sink, channelInterceptorFactory,
5151
serverInterceptorFactory);
5252
assertThat(observability1).isSameInstanceAs(observability);
5353

@@ -59,7 +59,7 @@ public void initFinish() {
5959
observability1.close();
6060
fail("should have failed for calling close() second time");
6161
} catch (IllegalStateException e) {
62-
assertThat(e).hasMessageThat().contains("Observability already closed!");
62+
assertThat(e).hasMessageThat().contains("GcpObservability already closed!");
6363
}
6464
}
6565
}

‎observability/src/test/java/io/grpc/observability/GlobalLoggingTagsTest.java renamed to ‎gcp-observability/src/test/java/io/grpc/gcp/observability/GlobalLoggingTagsTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.observability;
17+
package io.grpc.gcp.observability;
1818

1919
import static com.google.common.truth.Truth.assertThat;
2020

0 commit comments

Comments
 (0)