<sonar-maven-plugin.version>3.7.0.1746</sonar-maven-plugin.version>
<junit-jupiter-engine.version>5.6.0</junit-jupiter-engine.version>
<mockito-junit-jupiter.version>3.5.10</mockito-junit-jupiter.version>
- <ccsdk.sli.version>1.5.0-SNAPSHOT</ccsdk.sli.version>
</properties>
--- /dev/null
+#
+# ============LICENSE_START=======================================================
+# ONAP : ccsdk oran
+# ================================================================================
+# Copyright (C) 2022 Nordix Foundation. All rights reserved.
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+#
+
+# Sample Prometheus config
+# This assumes that your Prometheus instance can access this application on localhost:8081
+# host.docker.internal could be overridden as per the application's end-point e.g. localhost
+
+global:
+ scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+ evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
+ # scrape_timeout is set to the global default (10s).
+
+scrape_configs:
+ - job_name: 'A1 PMS scrape'
+ metrics_path: '/actuator/prometheus'
+ scrape_interval: 15s
+ static_configs:
+ - targets: ['host.docker.internal:8081']
<artifactId>spring-boot-starter-actuator</artifactId>
<scope>runtime</scope>
</dependency>
+ <dependency>
+ <groupId>io.micrometer</groupId>
+ <artifactId>micrometer-registry-prometheus</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-aop</artifactId>
+ </dependency>
<!--REQUIRED TO GENERATE DOCUMENTATION -->
<dependency>
<groupId>io.springfox</groupId>
package org.onap.ccsdk.oran.a1policymanagementservice;
import com.fasterxml.jackson.databind.ObjectMapper;
-
import org.apache.catalina.connector.Connector;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
-
import java.lang.invoke.MethodHandles;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
-
import lombok.Getter;
-
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.VoidResponse;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
+
+import io.micrometer.core.instrument.MeterRegistry;
+import java.lang.invoke.MethodHandles;
+import java.util.concurrent.atomic.AtomicLong;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+/**
+ * The aim is to collect statistical values from the A1 Policy Management Service.
+ * The counters are being updated every minute.
+ */
+@EnableScheduling
+@Component
+public class RefreshCounterTask {
+
+ private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+ private final Rics rics;
+ private final PolicyTypes policyTypes;
+ private final Policies policies;
+
+ private final MeterRegistry meterRegistry;
+
+ private final AtomicLong ricCount;
+ private final AtomicLong policyTypeCount;
+ private final AtomicLong policyCount;
+
+ @Autowired
+ public RefreshCounterTask(Rics rics, PolicyTypes policyTypes, Policies policies, MeterRegistry meterRegistry) {
+ this.rics = rics;
+ this.policyTypes = policyTypes;
+ this.policies = policies;
+ this.meterRegistry = meterRegistry;
+
+ ricCount = meterRegistry.gauge("total_ric_count", new AtomicLong(0));
+ policyTypeCount = meterRegistry.gauge("total_policy_type_count", new AtomicLong(0));
+ policyCount = meterRegistry.gauge("total_policy_count", new AtomicLong(0));
+ }
+
+ /**
+ * Every minute, updates counters for statistical purposes.
+ */
+ @Scheduled(fixedRate = 1000 * 60)
+ public void checkAllCounters() {
+ logger.trace("Checking counters starting...");
+ ricCount.set(rics.size());
+ policyCount.set(policies.size());
+ policyTypeCount.set(policyTypes.size());
+ }
+}
package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
import java.util.Collection;
-
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
-
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
return Mono.error(new SynchNeededException(ric));
}
}
+
return Mono.just(ric);
}
}
return Mono.error(new SynchNeededException(ric));
}
}
+
return Mono.just(ric);
}
--- /dev/null
+/*-
+ * ========================LICENSE_START=================================
+ * ONAP : ccsdk oran
+ * ======================================================================
+ * Copyright (C) 2022 Nordix Foundation. All rights reserved.
+ * ======================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.spy;
+
+import io.micrometer.prometheus.PrometheusConfig;
+import io.micrometer.prometheus.PrometheusMeterRegistry;
+import java.time.Instant;
+import java.util.Arrays;
+import java.util.Vector;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
+import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
+
+@ExtendWith(MockitoExtension.class)
+public class RefreshCounterTaskTest {
+
+ private static final String POLICY_TYPE_1_NAME = "type1";
+ private static final PolicyType POLICY_TYPE_1 = PolicyType.builder().id(POLICY_TYPE_1_NAME).schema("").build();
+
+ private static final Ric RIC_1 = new Ric(RicConfig.builder().ricId("ric_1").baseUrl("baseUrl1")
+ .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))).controllerName("controllerName")
+ .build());
+
+ private static final String POLICY_1_ID = "policyId1";
+ private static final Policy POLICY_1 = Policy.builder().id(POLICY_1_ID).json("").ownerServiceId("service")
+ .ric(RIC_1).type(POLICY_TYPE_1).lastModified(Instant.now()).isTransient(false)
+ .statusNotificationUri("statusNotificationUri").build();
+
+ private PrometheusMeterRegistry prometheusMeterRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
+ private final ApplicationConfig appConfig = new ApplicationConfig();
+
+ private PolicyTypes types;
+ private Policies policies;
+ private Rics rics = new Rics();
+
+ @BeforeEach
+ void init() {
+ types = new PolicyTypes(appConfig);
+ policies = new Policies(appConfig);
+
+ rics.clear();
+ RIC_1.setState(Ric.RicState.AVAILABLE);
+ RIC_1.clearSupportedPolicyTypes();
+ }
+
+ @Test
+ void testCounters_whenNeitherChangedPoliciesNorPolicyTypes() {
+ RIC_1.setState(Ric.RicState.AVAILABLE);
+ RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
+ rics.put(RIC_1);
+
+ types.put(POLICY_TYPE_1);
+
+ policies.put(POLICY_1);
+
+ RefreshCounterTask refreshCounterTaskUnderTest = spy(createRefreshCounterTask());
+ refreshCounterTaskUnderTest.checkAllCounters();
+
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
+ }
+
+ @Test
+ void testCounters_whenChangedPoliciesAndNoChangedPolicyTypes() {
+ RIC_1.setState(Ric.RicState.AVAILABLE);
+ RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
+ rics.put(RIC_1);
+
+ types.put(POLICY_TYPE_1);
+
+ policies.put(POLICY_1);
+
+ String POLICY_2_ID = "policyId2";
+ Policy POLICY_2 = Policy.builder() //
+ .id(POLICY_2_ID) //
+ .json("") //
+ .ownerServiceId("service") //
+ .ric(RIC_1) //
+ .type(POLICY_TYPE_1) //
+ .lastModified(Instant.now()) //
+ .isTransient(false) //
+ .statusNotificationUri("statusNotificationUri") //
+ .build();
+
+ policies.put(POLICY_2);
+
+ RefreshCounterTask refreshCounterTaskUnderTest = spy(createRefreshCounterTask());
+ refreshCounterTaskUnderTest.checkAllCounters();
+
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(2);
+ }
+
+ @Test
+ void testCounters_whenNoChangedPoliciesAndChangedPolicyTypes() {
+ RIC_1.setState(Ric.RicState.AVAILABLE);
+
+ String POLICY_TYPE_2_NAME = "type2";
+ PolicyType POLICY_TYPE_2 = PolicyType.builder() //
+ .id(POLICY_TYPE_2_NAME) //
+ .schema("") //
+ .build();
+
+ RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
+ RIC_1.addSupportedPolicyType(POLICY_TYPE_2);
+ rics.put(RIC_1);
+
+ types.put(POLICY_TYPE_1);
+ types.put(POLICY_TYPE_2);
+
+ policies.put(POLICY_1);
+
+ RefreshCounterTask refreshCounterTaskUnderTest = spy(createRefreshCounterTask());
+ refreshCounterTaskUnderTest.checkAllCounters();
+
+ assertThat(prometheusMeterRegistry.get("total_ric_count").gauge().value()).isEqualTo(1);
+ assertThat(prometheusMeterRegistry.get("total_policy_type_count").gauge().value()).isEqualTo(2);
+ assertThat(prometheusMeterRegistry.get("total_policy_count").gauge().value()).isEqualTo(1);
+ }
+
+ private RefreshCounterTask createRefreshCounterTask() {
+ return new RefreshCounterTask(rics, types, policies, prometheusMeterRegistry);
+ }
+}
import java.util.Collections;
import java.util.List;
import java.util.Vector;
-
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Code Review / ccsdk / oran.git / commitdiff