io.streamnative.pulsar.handlers.kop.KopServerStats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-protocol-handler-kafka Show documentation
Kafka on Pulsar implemented using Pulsar Protocol Handler
There is a newer version: 4.0.0.4
Show newest version
/**
 * 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 io.streamnative.pulsar.handlers.kop;

/**
 * Kop server stats for prometheus metrics.
 */
public interface KopServerStats {
    String CATEGORY_SERVER = "server";

    String SERVER_SCOPE = "kop_server";

    String REQUEST_SCOPE = "request";
    String TOPIC_SCOPE = "topic";
    String PARTITION_SCOPE = "partition";
    String GROUP_SCOPE = "group";

    String KOP_EVENT_SCOPE = "kop_event";

    String WAITING_FETCHES_TRIGGERED = "WAITING_FETCHES_TRIGGERED";

    /**
     * Request stats.
     */
    String REQUEST_QUEUE_SIZE = "REQUEST_QUEUE_SIZE";
    String REQUEST_QUEUED_LATENCY = "REQUEST_QUEUED_LATENCY";
    String REQUEST_PARSE_LATENCY = "REQUEST_PARSE_LATENCY";
    String REQUEST_LATENCY = "REQUEST_LATENCY";

    /**
     * Channel stats.
     */
    String ALIVE_CHANNEL_COUNT = "ALIVE_CHANNEL_COUNT";
    String ACTIVE_CHANNEL_COUNT = "ACTIVE_CHANNEL_COUNT";

    /**
     * Response stats.
     */
    String RESPONSE_BLOCKED_TIMES = "RESPONSE_BLOCKED_TIMES";
    String RESPONSE_BLOCKED_LATENCY = "RESPONSE_BLOCKED_LATENCY";

    /**
     * PRODUCE STATS.
     */
    String PENDING_TOPIC_LATENCY = "PENDING_TOPIC_LATENCY";
    String PRODUCE_ENCODE = "PRODUCE_ENCODE";
    String MESSAGE_PUBLISH = "MESSAGE_PUBLISH";
    String MESSAGE_QUEUED_LATENCY = "MESSAGE_QUEUED_LATENCY";

    /**
     * Producer Stats.
     */
    String BYTES_IN = "BYTES_IN";
    String MESSAGE_IN = "MESSAGE_IN";
    String BATCH_COUNT_PER_MEMORYRECORDS = "BATCH_COUNT_PER_MEMORYRECORDS";
    String PRODUCE_MESSAGE_CONVERSIONS = "PRODUCE_MESSAGE_CONVERSIONS";
    String PRODUCE_MESSAGE_CONVERSIONS_TIME_NANOS = "PRODUCE_MESSAGE_CONVERSIONS_TIME_NANOS";

    /**
     * FETCH stats.
     *
     * 
     * Elapsed time estimation:
     * 1) HANDLE_FETCH_REQUEST = PREPARE_METADATA + TOTAL_MESSAGE_READ + FETCH_DECODE + Overhead
     * 2) TOTAL_MESSAGE_READ = read-recursion-times * topic-partitions * MESSAGE_READ + Overhead
     * 
     */
    String PREPARE_METADATA = "PREPARE_METADATA";
    String MESSAGE_READ = "MESSAGE_READ";
    String FETCH_DECODE = "FETCH_DECODE";

    /**
     * Consumer stats.
     */
    String BYTES_OUT = "BYTES_OUT";
    String MESSAGE_OUT = "MESSAGE_OUT";
    String ENTRIES_OUT = "ENTRIES_OUT";
    String CONSUME_MESSAGE_CONVERSIONS = "CONSUME_MESSAGE_CONVERSIONS";
    String CONSUME_MESSAGE_CONVERSIONS_TIME_NANOS = "CONSUME_MESSAGE_CONVERSIONS_TIME_NANOS";

    /**
     * Kop event queue stats.
     */
    String KOP_EVENT_QUEUE_SIZE = "KOP_EVENT_QUEUE_SIZE";
    String KOP_EVENT_QUEUED_LATENCY = "KOP_EVENT_QUEUED_LATENCY";
    String KOP_EVENT_LATENCY = "KOP_EVENT_LATENCY";

    /**
     * Network stats.
     */
    String NETWORK_TOTAL_BYTES_IN = "NETWORK_TOTAL_BYTES_IN";
    String NETWORK_TOTAL_BYTES_OUT = "NETWORK_TOTAL_BYTES_OUT";
}