com.palantir.atlasdb.transaction.impl.ExpectationsAwareTransaction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation

Palantir open source project

There is a newer version: 0.1152.0

/*
 * (c) Copyright 2023 Palantir Technologies Inc. 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.
 */

package com.palantir.atlasdb.transaction.impl;

import com.palantir.atlasdb.transaction.api.Transaction;
import com.palantir.atlasdb.transaction.api.expectations.TransactionCommitLockInfo;
import com.palantir.atlasdb.transaction.api.expectations.TransactionReadInfo;
import com.palantir.atlasdb.transaction.api.expectations.TransactionWriteMetadataInfo;

/**
 * Implementors of this interface provide methods useful for tracking transactional expectations and whether
 * they were breached as well as relevant metrics and alerts. Transactional expectations represent transaction-level
 * limits and rules for proper usage of AtlasDB transactions (e.g. reading too much data overall).
 */
public interface ExpectationsAwareTransaction extends Transaction {
    long getAgeMillis();

    /**
     * Returns a point-in-time snapshot of transaction read information.
     */
    TransactionReadInfo getReadInfo();

    /**
     * Returns transaction commit lock information.
     */
    TransactionCommitLockInfo getCommitLockInfo();

    TransactionWriteMetadataInfo getWriteMetadataInfo();

    /**
     * Update TEX data collection metrics for (post-mortem) transactions.
     * Expected usage is that this method is called once after the transaction has been committed or aborted.
     * This method won't report metrics if called on an in-progress transaction.
     * Calling this twice after the transaction has committed or aborted will result in duplication.
     * Clients should not call this method directly.
     */
    void reportExpectationsCollectedData();
}