org.apache.pulsar.metadata.api.MetadataStoreConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-metadata Show documentation
The newest version!
/*
 * 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.pulsar.metadata.api;

import io.opentelemetry.api.OpenTelemetry;
import lombok.Builder;
import lombok.Getter;
import lombok.ToString;

/**
 * The configuration builder for a {@link MetadataStore} config.
 */
@Builder
@Getter
@ToString
public class MetadataStoreConfig {
    public static final String METADATA_STORE = "metadata-store";
    public static final String STATE_METADATA_STORE = "state-metadata-store";
    public static final String CONFIGURATION_METADATA_STORE = "configuration-metadata-store";

    /**
     * The (implementation specific) session timeout, in milliseconds.
     */
    @Builder.Default
    private final int sessionTimeoutMillis = 30_000;

    /**
     * Whether we should allow the metadata client to operate in read-only mode, when the backend store is not writable.
     */
    @Builder.Default
    private final boolean allowReadOnlyOperations = false;

    /**
     * Config file path for the underlying metadata store implementation.
     */
    @Builder.Default
    private final String configFilePath = null;

    /**
     * Whether we should enable metadata operations batching.
     */
    @Builder.Default
    private final boolean batchingEnabled = true;

    /**
     * Maximum delay to impose on batching grouping.
     */
    @Builder.Default
    private final int batchingMaxDelayMillis = 5;

    /**
     * Maximum number of operations to include in a singular batch.
     */
    @Builder.Default
    private final int batchingMaxOperations = 1_000;

    /**
     * Maximum size of a batch.
     */
    @Builder.Default
    private final int batchingMaxSizeKb = 128;

    /**
     * The name of a metadata store.
     */
    @Builder.Default
    private final String metadataStoreName = "";

    /**
     * Whether we should enable fsync for local metadata store, It's supported by RocksdbMetadataStore for now.
     */
    @Builder.Default
    private final boolean fsyncEnable = true;

    /**
     * Pluggable MetadataEventSynchronizer to sync metadata events across the
     * separate clusters.
     */
    private MetadataEventSynchronizer synchronizer;

    /**
     * OpenTelemetry instance to monitor metadata store operations.
     */
    @Builder.Default
    private OpenTelemetry openTelemetry = OpenTelemetry.noop();
}