org.neo4j.driver.Metrics Maven / Gradle / Ivy

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * 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.
 */
package org.neo4j.driver;

import java.util.Collection;
import org.neo4j.driver.util.Experimental;

/**
 * Provides driver internal metrics.
 */
@Experimental
public interface Metrics {
    /**
     * Connection pool metrics records metrics of connection pools that are currently in use.
     * As the connection pools are dynamically added and removed while the server topology changes, the metrics collection changes over time.
     * @return Connection pool metrics for all current active pools.
     */
    Collection connectionPoolMetrics();
}