Installation

Install Bot Pulse and connect your first robot in under 5 minutes.

Prerequisites

• Python 3.9 or later
• pip package manager

Install the package

pip install botpulse

Verify the installation

python -c "import botpulse; print(botpulse.__version__)"

Initialize Bot Pulse

Create a file called main.py and set up the client:

main.py

import botpulse

pulse = botpulse.init(
    service_name="my-robot-node",
    robot_id="robot-01",
)

The init() call returns a BotPulse instance. This is your entry point for all tracing, logging, and metrics.

Configuration options

pulse = botpulse.init(
    service_name="navigation-node",       # Name of this service/node
    robot_id="robot-01",                  # Unique robot identifier
    endpoint="http://localhost:4317",     # Backend collector endpoint
    batch_size=512,                       # How many events to batch before sending
    flush_interval=5.0,                   # Seconds between flushes
    enabled=True,                         # Toggle collection on/off
)

Parameter	Type	Default	Description
service_name	str	required	Identifies this service in your traces and logs
robot_id	str	None	Robot identifier, added as an attribute to all data
endpoint	str	http://localhost:4317	Collector endpoint (OpenTelemetry-compatible)
batch_size	int	512	Events buffered before a flush
flush_interval	float	5.0	Seconds between automatic flushes
enabled	bool	True	Master switch to disable collection

Run it

python main.py

If you have a collector running at the configured endpoint, you should see traces appearing. If not, Bot Pulse silently buffers events and retries.

Next steps

• Traces — Learn how to instrument timed operations
• Logs — Add structured log entries
• Metrics — Emit numeric measurements