14/9/2021 Set up a standalone Pulsar in Docker · Apache Pulsar

next Search

Docs Téléchargement Clients API REST Cli Blog Community ▼ Apache ▼ Français

› Get Started

Set up a standalone Pulsar in Docker TRANSLATE

For local development and testing, you can run Pulsar in standalone mode on your own machine
within a Docker container.

If you have not installed Docker, download the Community edition and follow the instructions for
your OS.

Start Pulsar in Docker

For MacOS, Linux, and Windows:

$ docker run -it -p 6650:6650 -p 8080:8080 --mount source=pulsardata,target=/p

A few things to note about this command: * The data, metadata, and configuration are persisted on
Docker volumes in order to not start "fresh" every time the container is restarted. For details on the
volumes you can use docker volume inspect <sourcename> * For Docker on Windows make
sure to configure it to use Linux containers

If you start Pulsar successfully, you will see INFO -level log messages like this:

08:18:30.970 [main] INFO org.apache.pulsar.broker.web.WebService - HTTP Service st

...
07:53:37.322 [main] INFO org.apache.pulsar.broker.PulsarService - messaging servic
...

Tip
When you start a local standalone cluster, a public/default namespace is created

https://pulsar.apache.org/docs/fr/next/standalone-docker/ 1/5
14/9/2021 Set up a standalone Pulsar in Docker · Apache Pulsar

automatically. The namespace is used for development purposes. All Pulsar topics are
next Search
managed within namespaces. For more information, see Topics.

Docs Téléchargement Clients API REST Cli Blog Community ▼ Apache ▼ Français

Use Pulsar in Docker

Pulsar offers client libraries for Java, Go, Python and C++. If you're running a local standalone
cluster, you can use one of these root URLs to interact with your cluster:

pulsar://localhost:6650

http://localhost:8080

The following example will guide you get started with Pulsar quickly by using the Python client API
client API.

Install the Pulsar Python client library directly from PyPI:

$ pip install pulsar-client

Consume a message
Create a consumer and subscribe to the topic:

import pulsar

client = pulsar.Client('pulsar://localhost:6650')
consumer = client.subscribe('my-topic',
subscription_name='my-sub')

while True:
msg = consumer.receive()
print("Received message: '%s'" % msg.data())
consumer.acknowledge(msg)

client.close()

Produce a message
Now start a producer to send some test messages:

https://pulsar.apache.org/docs/fr/next/standalone-docker/ 2/5
14/9/2021 Set up a standalone Pulsar in Docker · Apache Pulsar

next Search
import pulsar

Docsclient = pulsar.Client('pulsar://localhost:6650')
Téléchargement Clients API REST Cli Blog Community ▼ Apache ▼ Français
producer = client.create_producer('my-topic')

for i in range(10):
producer.send(('hello-pulsar-%d' % i).encode('utf-8'))

client.close()

Get the topic statistics

In Pulsar, you can use REST, Java, or command-line tools to control every aspect of the system.
For details on APIs, refer to Admin API Overview.

In the simplest example, you can use curl to probe the stats for a particular topic:

$ curl http://localhost:8080/admin/v2/persistent/public/default/my-topic/stats | py

The output is something like this:

{
"msgRateIn": 0.0,
"msgThroughputIn": 0.0,
"msgRateOut": 1.8332950480217471,
"msgThroughputOut": 91.33142602871978,
"bytesInCounter": 7097,
"msgInCounter": 143,
"bytesOutCounter": 6607,
"msgOutCounter": 133,
"averageMsgSize": 0.0,
"msgChunkPublished": false,
"storageSize": 7097,
"backlogSize": 0,
"offloadedStorageSize": 0,
"publishers": [
{
"accessMode": "Shared",
"msgRateIn": 0.0,
"msgThroughputIn": 0.0,
"averageMsgSize": 0.0,
"chunkedMessageRate": 0.0,
https://pulsar.apache.org/docs/fr/next/standalone-docker/ 3/5
14/9/2021 Set up a standalone Pulsar in Docker · Apache Pulsar

"producerId": 0,
next
"metadata": {},
Search
"address": "/127.0.0.1:35604",
"connectedSince": "2021-07-04T09:05:43.04788Z",▼
Docs Téléchargement Clients API REST Cli Blog Community Apache ▼ Français
"clientVersion": "2.8.0",
"producerName": "standalone-2-5"
}
],
"waitingPublishers": 0,
"subscriptions": {
"my-sub": {
"msgRateOut": 1.8332950480217471,
"msgThroughputOut": 91.33142602871978,
"bytesOutCounter": 6607,
"msgOutCounter": 133,
"msgRateRedeliver": 0.0,
"chunkedMessageRate": 0,
"msgBacklog": 0,
"backlogSize": 0,
"msgBacklogNoDelayed": 0,
"blockedSubscriptionOnUnackedMsgs": false,
"msgDelayed": 0,
"unackedMessages": 0,
"type": "Exclusive",
"activeConsumerName": "3c544f1daa",
"msgRateExpired": 0.0,
"totalMsgExpired": 0,
"lastExpireTimestamp": 0,
"lastConsumedFlowTimestamp": 1625389101290,
"lastConsumedTimestamp": 1625389546070,
"lastAckedTimestamp": 1625389546162,
"lastMarkDeleteAdvancedTimestamp": 1625389546163,
"consumers": [
{
"msgRateOut": 1.8332950480217471,
"msgThroughputOut": 91.33142602871978,
"bytesOutCounter": 6607,
"msgOutCounter": 133,
"msgRateRedeliver": 0.0,
"chunkedMessageRate": 0.0,
"consumerName": "3c544f1daa",
"availablePermits": 867,
"unackedMessages": 0,
"avgMessagesPerEntry": 6,
"blockedConsumerOnUnackedMsgs": false,
"lastAckedTimestamp": 1625389546162,
"lastConsumedTimestamp": 1625389546070,
"metadata": {},
"address": "/127.0.0.1:35472",
https://pulsar.apache.org/docs/fr/next/standalone-docker/ 4/5
14/9/2021 Set up a standalone Pulsar in Docker · Apache Pulsar

"connectedSince": "2021-07-04T08:58:21.287682Z",
next
"clientVersion": "2.8.0"
Search
}
],
Docs Téléchargement Clients API REST Cli Blog Community ▼ Apache ▼ Français
"isDurable": true,
"isReplicated": false,
"consumersAfterMarkDeletePosition": {},
"nonContiguousDeletedMessagesRanges": 0,
"nonContiguousDeletedMessagesRangesSerializedSize": 0,
"durable": true,
"replicated": false
}
},
"replication": {},
"deduplicationStatus": "Disabled",
"nonContiguousDeletedMessagesRanges": 0,
"nonContiguousDeletedMessagesRangesSerializedSize": 0
}

← RUN PULSAR LOCALLY RUN PULSAR IN KUBERNETES →

Copyright © 2021 The Apache Software Foundation. All Rights Reserved. Apache, Apache Pulsar and the
Apache feather logo are trademarks of The Apache Software Foundation.

https://pulsar.apache.org/docs/fr/next/standalone-docker/ 5/5