com.adobe.cq.commerce.graphql.client.impl.GraphqlClientMetrics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphql-client Show documentation
Generic GraphQL client for AEM
There is a newer version: 1.7.11
/*******************************************************************************
 *
 *    Copyright 2021 Adobe. All rights reserved.
 *    This file is licensed to you 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 REPRESENTATIONS
 *    OF ANY KIND, either express or implied. See the License for the specific language
 *    governing permissions and limitations under the License.
 *
 ******************************************************************************/
package com.adobe.cq.commerce.graphql.client.impl;

import java.util.function.Supplier;

import com.codahale.metrics.Timer;

/**
 * This interface provides a facade of the metrics tracked by the {@link GraphqlClientImpl}. With {@link GraphqlClientMetrics#NOOP} it
 * provides a no-operation implementation for environments that don't have cif metrics enabled.
 */
interface GraphqlClientMetrics {

    String REQUEST_DURATION_METRIC = "graphql-client.request.duration";
    String REQUEST_ERROR_COUNT_METRIC = "graphql-client.request.errors";
    String CACHE_HIT_METRIC = "graphql-client.cache.hits";
    String CACHE_MISS_METRIC = "graphql-client.cache.misses";
    String CACHE_EVICTION_METRIC = "graphql-client.cache.evictions";
    String CACHE_USAGE_METRIC = "graphql-client.cache.usage";
    String CONNECTION_POOL_AVAILABLE_METRIC = "graphql-client.connection-pool.available-connections";
    String CONNECTION_POOL_PENDING_METRIC = "graphql-client.connection-pool.pending-requests";
    String CONNECTION_POOL_USAGE_METRIC = "graphql-client.connection-pool.usage";

    GraphqlClientMetrics NOOP = new GraphqlClientMetrics() {

        @Override
        public void addConnectionPoolMetric(String metricName, Supplier valueSupplier) {
            // do nothing
        }

        @Override
        public void addCacheMetric(String metricName, String cacheName, Supplier valueSupplier) {
            // do nothing
        }

        @Override
        public Supplier startRequestDurationTimer() {
            return () -> null;
        }

        @Override
        public void incrementRequestErrors() {
            // do nothing
        }

        @Override
        public void incrementRequestErrors(int status) {
            // do nothing
        }
    };

    /**
     * Adds a connection pool metric.
     */
    void addConnectionPoolMetric(String metricName, Supplier valueSupplier);

    /**
     * Adds a cache metric.
     */
    void addCacheMetric(String metricName, String cacheName, Supplier valueSupplier);

    /**
     * Starts a request duration timer. The returned {@link Runnable} wraps the {@link Timer.Context#close()} and must be called in
     * order to add the measurement to the metric.
     *
     * @return
     */
    Supplier startRequestDurationTimer();

    /**
     * Increments the generic request error count.
     */
    void incrementRequestErrors();

    /**
     * Increments the specific request error count for the given status.
     *
     * @param
     */
    void incrementRequestErrors(int status);

}