oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentNodeStoreStatsCollector.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * 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 CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.jackrabbit.oak.plugins.document;

public interface DocumentNodeStoreStatsCollector {

    /**
     * Report to the collector that a background read was done.
     *
     * @param stats the stats for the background read operation.
     */
    void doneBackgroundRead(BackgroundReadStats stats);

    /**
     * Report to the collector that a background update was done.
     *
     * @param stats the stats for the background update operation.
     */
    void doneBackgroundUpdate(BackgroundWriteStats stats);

    /**
     * Report to the collector that a lease update was done.
     *
     * @param timeMicros the time in microseconds it took to update the lease.
     */
    void doneLeaseUpdate(long timeMicros);

    /**
     * Report to the collector that a branch commit was done.
     */
    void doneBranchCommit();

    /**
     * Report to the collector that a branch was merged.
     *
     * @param numCommits the number of branch commits merged.
     * @param numChanges the number of changes merged.
     */
    void doneMergeBranch(int numCommits, int numChanges);

    /**
     * Reports to the collector that a merge was done. The number of changes
     * reported with this method is the number of documents that were modified
     * with the merge.
     *
     * @param numChanges the number of changes in this merge.
     * @param numRetries the number of retries that were necessary.
     * @param timeMillis the time in milliseconds it took to merge the changes.
     * @param suspendMillis the time in milliseconds the merge was suspended.
     * @param exclusive whether the merge was holding an exclusive lock.
     */
    void doneMerge(int numChanges,
                   int numRetries,
                   long timeMillis,
                   long suspendMillis,
                   boolean exclusive);

    /**
     * Reports to the collector that a merge failed.
     *
     * @param numRetries the number of retries that were done.
     * @param timeMillis the time in milliseconds it took to attempt the merge.
     * @param suspendMillis the time in milliseconds the merge was suspended.
     * @param exclusive whether the merge was holding an exclusive lock.
     */
    void failedMerge(int numRetries, long timeMillis, long suspendMillis, boolean exclusive);

    /**
     * Reports to the collector that a commit finished waiting to become the
     * head of the commit queue.
     *
     * @param waitMicros the time it waited in microseconds to be come
     *         the head of the queue.
     */
    void doneWaitUntilHead(long waitMicros);

    /**
     * Reports to the collector that the commit acquired the merge lock in the
     * given time.
     *
     * @param timeMicros the time in microseconds.
     */
    void doneMergeLockAcquired(long timeMicros);

    /**
     * Reports to the collector that the commit hook processed a commit in the
     * given time.
     *
     * @param timeMicros the time in microseconds.
     */
    void doneCommitHookProcessed(long timeMicros);

    /**
     * Reports to the collector that the commit applied the changes to the
     * {@code DocumentStore} in the given time.
     *
     * @param timeMicros the time in microseconds.
     */
    void doneChangesApplied(long timeMicros);
}