gerrit.onap Code Review - dcaegen2/services/sdk.git/blob

   1 /*
   2  * ============LICENSE_START====================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * =========================================================
   5  * Copyright (C) 2019 Nokia. All rights reserved.
   6  * =========================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *       http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=====================================
  19  */
  20
  21 package org.onap.dcaegen2.services.sdk.standardization.moher.metrics.api;
  22
  23 import io.micrometer.prometheus.PrometheusConfig;
  24 import io.micrometer.prometheus.PrometheusMeterRegistry;
  25 import org.onap.dcaegen2.services.sdk.standardization.moher.metrics.impl.MetricsImpl;
  26
  27 /**
  28  * Factory for creating {@link Metrics} object.
  29  *
  30  * <p>Typical usage:</p>
  31  *
  32  * <pre>
  33  *  // create registry
  34  *  PrometheusMeterRegistry registry = MetricsFactory.createDefaultRegistry();
  35  *  // create metrics
  36  *  Metrics metrics = MetricsFactory.createMetrics(registry);
  37  * </pre>
  38  *
  39  * @since 1.2.0
  40  */
  41 public class MetricsFactory {
  42
  43     /**
  44      * Method for creating default Prometheus registry.
  45      *
  46      * @since 1.2.0
  47      */
  48     public static PrometheusMeterRegistry createDefaultRegistry() {
  49         return new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
  50     }
  51
  52     /**
  53      * Method for creating {@link Metrics} with configured Prometheus registry.
  54      *
  55      * @param registry Prometheus registry to be used
  56      * @since 1.2.0
  57      */
  58     public static Metrics createMetrics(PrometheusMeterRegistry registry) {
  59         return new MetricsImpl(registry);
  60     }
  61 }