-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Application Signals runtime metrics (#892)
## Feature request Add runtime metrics collection into Application Signals. ## Description of changes: This PR is an umbrella PR to track the ongoing changes for runtime metrics. 1. [Add Application Signals runtime metrics with feature disabled #900](#900) [Merged in main] 2. [feat: Add contract tests for runtime metrics #893](#893) 3. Enable runtime metrics by default By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. *Issue #, if available:* *Description of changes:* By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. --------- Co-authored-by: Reno Seo <[email protected]>
- Loading branch information
1 parent
d21ac61
commit d97972b
Showing
6 changed files
with
225 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
165 changes: 165 additions & 0 deletions
165
.../src/test/java/software/amazon/opentelemetry/appsignals/test/misc/RuntimeMetricsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.opentelemetry.appsignals.test.misc; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import io.opentelemetry.proto.metrics.v1.Metric; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import org.junit.jupiter.api.Nested; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.TestInstance; | ||
| import org.testcontainers.junit.jupiter.Testcontainers; | ||
| import software.amazon.opentelemetry.appsignals.test.base.ContractTestBase; | ||
| import software.amazon.opentelemetry.appsignals.test.utils.AppSignalsConstants; | ||
| import software.amazon.opentelemetry.appsignals.test.utils.ResourceScopeMetric; | ||
|
|
||
| public class RuntimeMetricsTest { | ||
| private abstract static class RuntimeMetricsContractTestBase extends ContractTestBase { | ||
| @Override | ||
| protected String getApplicationImageName() { | ||
| return "aws-appsignals-tests-http-server-spring-mvc"; | ||
| } | ||
|
|
||
| @Override | ||
| protected String isRuntimeEnabled() { | ||
| return "true"; | ||
| } | ||
|
|
||
| protected String getApplicationWaitPattern() { | ||
| return ".*Started Application.*"; | ||
| } | ||
|
|
||
| protected void doTestRuntimeMetrics() { | ||
| var response = appClient.get("/success").aggregate().join(); | ||
|
|
||
| assertThat(response.status().isSuccess()).isTrue(); | ||
| assertRuntimeMetrics(); | ||
| } | ||
|
|
||
| protected void assertRuntimeMetrics() { | ||
| var metrics = | ||
| mockCollectorClient.getRuntimeMetrics( | ||
| Set.of( | ||
| AppSignalsConstants.JVM_GC_DURATION, | ||
| AppSignalsConstants.JVM_GC_COUNT, | ||
| AppSignalsConstants.JVM_HEAP_USED, | ||
| AppSignalsConstants.JVM_NON_HEAP_USED, | ||
| AppSignalsConstants.JVM_AFTER_GC, | ||
| AppSignalsConstants.JVM_POOL_USED, | ||
| AppSignalsConstants.JVM_THREAD_COUNT, | ||
| AppSignalsConstants.JVM_CLASS_LOADED, | ||
| AppSignalsConstants.JVM_CPU_TIME, | ||
| AppSignalsConstants.JVM_CPU_UTILIZATION, | ||
| AppSignalsConstants.LATENCY_METRIC, | ||
| AppSignalsConstants.ERROR_METRIC, | ||
| AppSignalsConstants.FAULT_METRIC)); | ||
|
|
||
| testResourceAttributes(metrics); | ||
| for (String metricName : List.of(AppSignalsConstants.JVM_POOL_USED)) { | ||
| testGaugeMetrics(metrics, metricName, "name"); | ||
| } | ||
| for (String metricName : | ||
| List.of( | ||
| AppSignalsConstants.JVM_HEAP_USED, | ||
| AppSignalsConstants.JVM_NON_HEAP_USED, | ||
| AppSignalsConstants.JVM_AFTER_GC, | ||
| AppSignalsConstants.JVM_THREAD_COUNT, | ||
| AppSignalsConstants.JVM_CLASS_LOADED, | ||
| AppSignalsConstants.JVM_CPU_UTILIZATION)) { | ||
| testGaugeMetrics(metrics, metricName, ""); | ||
| } | ||
| for (String metricName : | ||
| List.of(AppSignalsConstants.JVM_GC_DURATION, AppSignalsConstants.JVM_GC_COUNT)) { | ||
| testCounterMetrics(metrics, metricName, "name"); | ||
| } | ||
| for (String metricName : List.of(AppSignalsConstants.JVM_CPU_TIME)) { | ||
| testCounterMetrics(metrics, metricName, ""); | ||
| } | ||
| } | ||
|
|
||
| private void testGaugeMetrics( | ||
| List<ResourceScopeMetric> resourceScopeMetrics, String metricName, String attributeKey) { | ||
| for (ResourceScopeMetric rsm : resourceScopeMetrics) { | ||
| Metric metric = rsm.getMetric(); | ||
| if (metricName.equals(metric.getName())) { | ||
| assertThat(metric.getGauge().getDataPointsList()) | ||
| .as(metricName + " is not empty") | ||
| .isNotEmpty(); | ||
| assertThat(metric.getGauge().getDataPointsList()) | ||
| .as(metricName + " is valid") | ||
| .allMatch( | ||
| dp -> { | ||
| boolean valid = true; | ||
| if (!attributeKey.isEmpty()) { | ||
| valid = | ||
| dp.getAttributesList().stream() | ||
| .anyMatch(attribute -> attribute.getKey().equals(attributeKey)); | ||
| } | ||
| return valid && dp.getAsInt() >= 0; | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void testCounterMetrics( | ||
| List<ResourceScopeMetric> resourceScopeMetrics, String metricName, String attributeKey) { | ||
| for (ResourceScopeMetric rsm : resourceScopeMetrics) { | ||
| Metric metric = rsm.getMetric(); | ||
| if (metricName.equals(metric.getName())) { | ||
| assertThat(metric.getSum().getDataPointsList()) | ||
| .as(metricName + " is not empty") | ||
| .isNotEmpty(); | ||
| assertThat(metric.getSum().getDataPointsList()) | ||
| .as(metricName + " is valid") | ||
| .allMatch( | ||
| dp -> { | ||
| boolean valid = true; | ||
| if (!attributeKey.isEmpty()) { | ||
| valid = | ||
| dp.getAttributesList().stream() | ||
| .anyMatch(attribute -> attribute.getKey().equals(attributeKey)); | ||
| } | ||
| return valid && dp.getAsInt() >= 0; | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void testResourceAttributes(List<ResourceScopeMetric> resourceScopeMetrics) { | ||
| for (ResourceScopeMetric rsm : resourceScopeMetrics) { | ||
| assertThat(rsm.getResource().getResource().getAttributesList()) | ||
| .anyMatch( | ||
| attr -> | ||
| attr.getKey().equals(AppSignalsConstants.AWS_LOCAL_SERVICE) | ||
| && attr.getValue() | ||
| .getStringValue() | ||
| .equals(getApplicationOtelServiceName())); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Testcontainers(disabledWithoutDocker = true) | ||
| @TestInstance(TestInstance.Lifecycle.PER_CLASS) | ||
| @Nested | ||
| class ValidateRuntimeMetricsTest extends RuntimeMetricsContractTestBase { | ||
| @Test | ||
| void testRuntimeMetrics() { | ||
| doTestRuntimeMetrics(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters