gcp-observability: Fixed slowness for GcpObservabilityTest.enableObservability test case #11783
Conversation
….enableObservability test case.
shivaspeaks
added
the
kokoro:run
grpc-kokoro
removed
the
kokoro:run
As I have observed, enabling observability requires initializing certain things and classes, which makes the task within the try-with-resources block take longer. However, when observability is disabled, I did not observe many initializations in the test cases at lines 233 and 236, so I refactored the code to use a traditional try-catch block instead. |
|
You just don't close? No, we need to clean up and we want to test cleanup. Without close() we will leak resources and probably threads, and we don't want those running during other tests. |
I’m working on this and plan to implement a close() method with a configurable sleep time. After the test finishes, the close() method will be called with a shorter sleep duration to speed up the cleanup process. |
|
That sounds fine; just make the new method package-private. |
….enableObservability test case.
|
As per the suggestions above, I have pushed the latest changes, which include the addition of a new close method with sleep time. After executing the test case, I found that the execution time is now under 5 seconds. Could you please review the changes. |
| @@ -146,6 +146,21 @@ public void close() { | |||
| } | |||
| } | |||
|
|
|||
| public void closeWithSleepTime(long sleepTime) { | |||
There was a problem hiding this comment.
please add the missing doc comments for this method.
| gcpObservability.closeWithSleepTime(sleepTime); | ||
| verify(sink).close(); | ||
| } | ||
|
|
| public void closeWithSleepTime() throws Exception { | ||
| long sleepTime = 1000L; | ||
| Sink sink = mock(Sink.class); | ||
| ObservabilityConfig config = mock(ObservabilityConfig.class); |
There was a problem hiding this comment.
change variable config to observabilityConfig
….enableObservability test case - fixed review comments.
….enableObservability test case - fixed review comments.
There was a problem hiding this comment.
Changes LGTM and Lets wait for Review from @ejona86 @shivaspeaks
ejona86
added
the
kokoro:run
grpc-kokoro
removed
the
kokoro:run
| * | ||
| * @param sleepTime sleepTime | ||
| */ | ||
| public void closeWithSleepTime(long sleepTime) { |
There was a problem hiding this comment.
Don't make this public. We just want it for testing.
| */ | ||
| public void closeWithSleepTime(long sleepTime) { | ||
| synchronized (GcpObservability.class) { | ||
| sink.close(); |
There was a problem hiding this comment.
Add the missing instance == null check, and then have the old method call this new method with a hard-coded delay.
| * | ||
| * @param sleepTime sleepTime | ||
| */ | ||
| public void closeWithSleepTime(long sleepTime) { |
There was a problem hiding this comment.
sleepTime has no unit attached. You should either include the unit in the same, like sleepTimeMillis (this is more common in fields) or pass a TimeUnit as another parameter (this is more common in APIs). So here I suggest passing in a TimeUnit.
| @@ -208,6 +208,7 @@ public void run() { | |||
| assertThat(list.get(2)).isInstanceOf(ConditionalClientInterceptor.class); | |||
| assertThat(configurator.serverInterceptors).hasSize(1); | |||
| assertThat(configurator.tracerFactories).hasSize(2); | |||
| gcpObservability.closeWithSleepTime(3000); | |||
| } catch (Exception e) { | |||
There was a problem hiding this comment.
When the try block is exited, it calls close() again. We should be seeing a IllegalStateException exception. If the tests are passing, that needs to be looked in to.
|
|
||
| // Test to verify the closeWithSleepTime method along with sleep time explicitly. | ||
| @Test | ||
| public void closeWithSleepTime() throws Exception { |
There was a problem hiding this comment.
This seems identical to StaticTestingClassEnableObservability, except for the verify(sink).close(). That would be good to move to the other test and then we delete this one.
ejona86
changed the title
gcp-obsrevability : Fixed the slowness issue for GcpObservabilityTest.enableObservability test case.
Fixes #10146.
Snippet before fix as execuation time taking 1m 21sec
Snippet after fix as execuation time taking below 1sec 44msec.