Add tracer for getHttpTransports (opensearch-project#3338)

Add tracer for getHttpTransports - Related Add Tracing Instrumentation at Network and Rest layer OpenSearch#9415 Signed-off-by: Ryan Liang <[email protected]>
stephen-crawford · Sep 11, 2023 · c9e109f · c9e109f
1 parent 72c6186
commit c9e109f
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 17 deletions.
diff --git a/src/main/java/org/opensearch/security/OpenSearchSecurityPlugin.java b/src/main/java/org/opensearch/security/OpenSearchSecurityPlugin.java
@@ -180,6 +180,7 @@
 import org.opensearch.security.user.User;
 import org.opensearch.security.user.UserService;
 import org.opensearch.tasks.Task;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.RemoteClusterService;
 import org.opensearch.transport.Transport;
@@ -860,7 +861,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  NamedXContentRegistry xContentRegistry,
  NetworkService networkService,
  Dispatcher dispatcher,
- ClusterSettings clusterSettings
+ ClusterSettings clusterSettings,
+ Tracer tracer
  ) {
 
  if (SSLConfig.isSslOnlyMode()) {
@@ -873,7 +875,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  xContentRegistry,
  networkService,
  dispatcher,
- clusterSettings
+ clusterSettings,
+ tracer
  );
  }
 
@@ -898,7 +901,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  xContentRegistry,
  validatingDispatcher,
  clusterSettings,
- sharedGroupFactory
+ sharedGroupFactory,
+ tracer
  );
 
  return Collections.singletonMap("org.opensearch.security.http.SecurityHttpServerTransport", () -> odshst);
@@ -913,7 +917,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  xContentRegistry,
  dispatcher,
  clusterSettings,
- sharedGroupFactory
+ sharedGroupFactory,
+ tracer
  )
  );
  }

diff --git a/src/main/java/org/opensearch/security/http/SecurityHttpServerTransport.java b/src/main/java/org/opensearch/security/http/SecurityHttpServerTransport.java
@@ -35,6 +35,7 @@
 import org.opensearch.security.ssl.SslExceptionHandler;
 import org.opensearch.security.ssl.http.netty.SecuritySSLNettyHttpServerTransport;
 import org.opensearch.security.ssl.http.netty.ValidatingDispatcher;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.SharedGroupFactory;
 
@@ -50,7 +51,8 @@ public SecurityHttpServerTransport(
  final NamedXContentRegistry namedXContentRegistry,
  final ValidatingDispatcher dispatcher,
  final ClusterSettings clusterSettings,
- SharedGroupFactory sharedGroupFactory
+ SharedGroupFactory sharedGroupFactory,
+ Tracer tracer
  ) {
  super(
  settings,
@@ -62,7 +64,8 @@ public SecurityHttpServerTransport(
  dispatcher,
  sslExceptionHandler,
  clusterSettings,
- sharedGroupFactory
+ sharedGroupFactory,
+ tracer
  );
  }
 }
diff --git a/src/main/java/org/opensearch/security/http/SecurityNonSslHttpServerTransport.java b/src/main/java/org/opensearch/security/http/SecurityNonSslHttpServerTransport.java
@@ -36,6 +36,7 @@
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.http.HttpHandlingSettings;
 import org.opensearch.http.netty4.Netty4HttpServerTransport;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.SharedGroupFactory;
 
@@ -49,9 +50,20 @@ public SecurityNonSslHttpServerTransport(
  final NamedXContentRegistry namedXContentRegistry,
  final Dispatcher dispatcher,
  ClusterSettings clusterSettings,
- SharedGroupFactory sharedGroupFactory
+ SharedGroupFactory sharedGroupFactory,
+ Tracer tracer
  ) {
- super(settings, networkService, bigArrays, threadPool, namedXContentRegistry, dispatcher, clusterSettings, sharedGroupFactory);
+ super(
+ settings,
+ networkService,
+ bigArrays,
+ threadPool,
+ namedXContentRegistry,
+ dispatcher,
+ clusterSettings,
+ sharedGroupFactory,
+ tracer
+ );
  }
 
  @Override

diff --git a/src/main/java/org/opensearch/security/ssl/OpenSearchSecuritySSLPlugin.java b/src/main/java/org/opensearch/security/ssl/OpenSearchSecuritySSLPlugin.java
@@ -80,6 +80,7 @@
 import org.opensearch.security.ssl.transport.SecuritySSLNettyTransport;
 import org.opensearch.security.ssl.transport.SecuritySSLTransportInterceptor;
 import org.opensearch.security.ssl.util.SSLConfigConstants;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.SharedGroupFactory;
 import org.opensearch.transport.Transport;
@@ -242,7 +243,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  NamedXContentRegistry xContentRegistry,
  NetworkService networkService,
  Dispatcher dispatcher,
- ClusterSettings clusterSettings
+ ClusterSettings clusterSettings,
+ Tracer tracer
  ) {
 
  if (!client && httpSSLEnabled) {
@@ -264,7 +266,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  validatingDispatcher,
  NOOP_SSL_EXCEPTION_HANDLER,
  clusterSettings,
- sharedGroupFactory
+ sharedGroupFactory,
+ tracer
  );
 
  return Collections.singletonMap("org.opensearch.security.ssl.http.netty.SecuritySSLNettyHttpServerTransport", () -> sgsnht);

diff --git a/...main/java/org/opensearch/security/ssl/http/netty/SecuritySSLNettyHttpServerTransport.java b/...main/java/org/opensearch/security/ssl/http/netty/SecuritySSLNettyHttpServerTransport.java
@@ -38,6 +38,7 @@
 import org.opensearch.http.netty4.Netty4HttpServerTransport;
 import org.opensearch.security.ssl.SecurityKeyStore;
 import org.opensearch.security.ssl.SslExceptionHandler;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.SharedGroupFactory;
 
@@ -56,9 +57,20 @@ public SecuritySSLNettyHttpServerTransport(
  final ValidatingDispatcher dispatcher,
  final SslExceptionHandler errorHandler,
  ClusterSettings clusterSettings,
- SharedGroupFactory sharedGroupFactory
+ SharedGroupFactory sharedGroupFactory,
+ Tracer tracer
  ) {
- super(settings, networkService, bigArrays, threadPool, namedXContentRegistry, dispatcher, clusterSettings, sharedGroupFactory);
+ super(
+ settings,
+ networkService,
+ bigArrays,
+ threadPool,
+ namedXContentRegistry,
+ dispatcher,
+ clusterSettings,
+ sharedGroupFactory,
+ tracer
+ );
  this.sks = sks;
  this.errorHandler = errorHandler;
  }

diff --git a/src/test/java/org/opensearch/security/test/plugin/UserInjectorPlugin.java b/src/test/java/org/opensearch/security/test/plugin/UserInjectorPlugin.java
@@ -48,6 +48,7 @@
 import org.opensearch.rest.RestChannel;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.security.support.ConfigConstants;
+import org.opensearch.telemetry.tracing.Tracer;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.SharedGroupFactory;
 
@@ -78,7 +79,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  NamedXContentRegistry xContentRegistry,
  NetworkService networkService,
  Dispatcher dispatcher,
- ClusterSettings clusterSettings
+ ClusterSettings clusterSettings,
+ Tracer tracer
  ) {
 
  final UserInjectingDispatcher validatingDispatcher = new UserInjectingDispatcher(dispatcher);
@@ -92,7 +94,8 @@ public Map<String, Supplier<HttpServerTransport>> getHttpTransports(
  xContentRegistry,
  validatingDispatcher,
  clusterSettings,
- sharedGroupFactory
+ sharedGroupFactory,
+ tracer
  )
  );
  }
@@ -107,9 +110,20 @@ public UserInjectingServerTransport(
  final NamedXContentRegistry namedXContentRegistry,
  final Dispatcher dispatcher,
  ClusterSettings clusterSettings,
- SharedGroupFactory sharedGroupFactory
+ SharedGroupFactory sharedGroupFactory,
+ Tracer tracer
  ) {
- super(settings, networkService, bigArrays, threadPool, namedXContentRegistry, dispatcher, clusterSettings, sharedGroupFactory);
+ super(
+ settings,
+ networkService,
+ bigArrays,
+ threadPool,
+ namedXContentRegistry,
+ dispatcher,
+ clusterSettings,
+ sharedGroupFactory,
+ tracer
+ );
  }
  }
 

diff --git a/src/test/java/org/opensearch/security/transport/SecurityInterceptorTests.java b/src/test/java/org/opensearch/security/transport/SecurityInterceptorTests.java
@@ -33,6 +33,7 @@
 import org.opensearch.security.support.Base64Helper;
 import org.opensearch.security.support.ConfigConstants;
 import org.opensearch.security.user.User;
+import org.opensearch.telemetry.tracing.noop.NoopTracer;
 import org.opensearch.test.transport.MockTransport;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.Transport.Connection;
@@ -122,7 +123,8 @@ public void testSendRequestDecorate() {
  TransportService.NOOP_TRANSPORT_INTERCEPTOR,
  boundTransportAddress -> clusterService.state().nodes().get(SecurityInterceptor.class.getSimpleName()),
  null,
- emptySet()
+ emptySet(),
+ NoopTracer.INSTANCE
  );
 
  // CS-SUPPRESS-SINGLE: RegexpSingleline Extensions manager used for creating a mock