org.apache.pulsar.client.admin.BrokerStats Maven / Gradle / Ivy
/*
* 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.client.admin;
import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.common.stats.AllocatorStats;
import org.apache.pulsar.shade.org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport;
/**
* Admin interface for brokers management.
*/
public interface BrokerStats {
/**
* Returns Monitoring metrics.
*
* @return
* @throws PulsarAdminException
*/
String getMetrics() throws PulsarAdminException;
/**
* Returns Monitoring metrics asynchronously.
*
* @return
*/
CompletableFuture getMetricsAsync();
/**
* Requests JSON string server mbean dump.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
* @throws PulsarAdminException
*/
String getMBeans() throws PulsarAdminException;
/**
* Requests JSON string server mbean dump asynchronously.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
*/
CompletableFuture getMBeansAsync();
/**
* Returns JSON string topics stats.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
* @throws PulsarAdminException
*/
String getTopics() throws PulsarAdminException;
/**
* Returns JSON string topics stats asynchronously.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
*/
CompletableFuture getTopicsAsync();
/**
* Get pending bookie client op stats by namespace.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
* @throws PulsarAdminException
*/
String getPendingBookieOpsStats() throws PulsarAdminException;
/**
* Get pending bookie client op stats by namespace asynchronously.
*
* Notes: since we don't plan to introspect the response we avoid converting the response into POJO.
*
* @return
*/
CompletableFuture getPendingBookieOpsStatsAsync();
/**
* Get the stats for the Netty allocator.
*
* @param allocatorName
* @return
* @throws PulsarAdminException
*/
AllocatorStats getAllocatorStats(String allocatorName) throws PulsarAdminException;
/**
* Get the stats for the Netty allocator asynchronously.
*
* @param allocatorName
* @return
*/
CompletableFuture getAllocatorStatsAsync(String allocatorName);
/**
* Get load for this broker.
*
* @return
* @throws PulsarAdminException
*/
LoadManagerReport getLoadReport() throws PulsarAdminException;
/**
* Get load for this broker asynchronously.
*
* @return
*/
CompletableFuture getLoadReportAsync();
}