Skip to content

Latest commit

 

History

History
148 lines (95 loc) · 4.33 KB

admin-api-brokers.md

File metadata and controls

148 lines (95 loc) · 4.33 KB
id title sidebar_label
admin-api-brokers
Managing Brokers
Brokers

Pulsar brokers consist of two components:

  1. An HTTP server exposing a {@inject: rest:REST:/} interface administration and topic lookup.
  2. A dispatcher that handles all Pulsar message transfers.

Brokers can be managed via:

  • The brokers command of the pulsar-admin tool
  • The /admin/v2/brokers endpoint of the admin {@inject: rest:REST:/} API
  • The brokers method of the {@inject: javadoc:PulsarAdmin:/admin/org/apache/pulsar/client/admin/PulsarAdmin.html} object in the Java API

In addition to being configurable when you start them up, brokers can also be dynamically configured.

See the Configuration page for a full listing of broker-specific configuration parameters.

Brokers resources

List active brokers

Fetch all available active brokers that are serving traffic.

pulsar-admin

$ pulsar-admin brokers list use
broker1.use.org.com:8080
REST

{@inject: endpoint|GET|/admin/v2/brokers/:cluster|operation/getActiveBrokers}

Java
admin.brokers().getActiveBrokers(clusterName)

list of namespaces owned by a given broker

It finds all namespaces which are owned and served by a given broker.

CLI
$ pulsar-admin brokers namespaces use \
  --url broker1.use.org.com:8080
{
  "my-property/use/my-ns/0x00000000_0xffffffff": {
    "broker_assignment": "shared",
    "is_controlled": false,
    "is_active": true
  }
}
REST

{@inject: endpoint|GET|/admin/v2/brokers/:cluster/:broker/ownedNamespaces|operation/getOwnedNamespaes}

Java
admin.brokers().getOwnedNamespaces(cluster,brokerUrl);

Dynamic broker configuration

One way to configure a Pulsar broker is to supply a configuration when the broker is started up.

But since all broker configuration in Pulsar is stored in ZooKeeper, configuration values can also be dynamically updated while the broker is running. When you update broker configuration dynamically, ZooKeeper will notify the broker of the change and the broker will then override any existing configuration values.

  • The brokers command for the pulsar-admin tool has a variety of subcommands that enable you to manipulate a broker's configuration dynamically, enabling you to update config values and more.
  • In the Pulsar admin {@inject: rest:REST:/} API, dynamic configuration is managed through the /admin/v2/brokers/configuration endpoint.

Update dynamic configuration

pulsar-admin

The update-dynamic-config subcommand will update existing configuration. It takes two arguments: the name of the parameter and the new value. Here's an example for the brokerShutdownTimeoutMs parameter:

$ pulsar-admin brokers update-dynamic-config brokerShutdownTimeoutMs 100

REST API

{@inject: endpoint|POST|/admin/v2/brokers/configuration/:configName/:configValue|operation/updateDynamicConfiguration}

Java

admin.brokers().updateDynamicConfiguration(configName, configValue);

List updated values

Fetch a list of all potentially updatable configuration parameters.

pulsar-admin

$ pulsar-admin brokers list-dynamic-config
brokerShutdownTimeoutMs

REST API

{@inject: endpoint|GET|/admin/v2/brokers/configuration|operation/getDynamicConfigurationName}

Java

admin.brokers().getDynamicConfigurationNames();

List all

Fetch a list of all parameters that have been dynamically updated.

pulsar-admin

$ pulsar-admin brokers get-all-dynamic-config
brokerShutdownTimeoutMs:100

REST API

{@inject: endpoint|GET|/admin/v2/brokers/configuration/values|operation/getAllDynamicConfigurations}

Java

admin.brokers().getAllDynamicConfigurations();