 |
VOOZH | about |
|
VOOZH | about |
This page provides definitions for codebase-specific terms, abbreviations, and domain concepts used throughout the rudder-php-sdk. It serves as a technical reference for onboarding engineers to understand the implementation details and data flow within the SDK.
The destination endpoint where the SDK sends collected events. In the codebase, this is often referred to as host or data_plane_url. The SDK performs normalization on this string to ensure it includes the correct protocol (HTTP/HTTPS) based on the ssl configuration.
Rudder::handleSSL lib/Rudder.php212-232 and Rudder::handleUrl lib/Rudder.php243-245hosted.rudderlabs.com lib/Rudder.php22A unique identifier for your RudderStack source. It is required during initialization and used for basic authentication in HTTP requests.
Rudder::init lib/Rudder.php19-21 and subsequently used by consumers as a "secret" for Authorization headers lib/Consumer/LibCurl.php39An abstraction layer responsible for the transport of event data from the PHP application to the RudderStack Data Plane. The SDK supports multiple consumer types (e.g., LibCurl, ForkCurl, Socket, File).
Rudder\Consumer\Consumer lib/Consumer/Consumer.phpQueueConsumer lib/Consumer/QueueConsumer.php which manages internal memory buffers.| Term | Definition | Code Pointer |
|---|---|---|
| Flush | The process of sending queued events from the consumer's memory buffer to the destination. | Client::flush() lib/Client.php |
| Batch | A collection of events sent in a single HTTP request to the /v1/batch endpoint. | QueueConsumer::flushBatch() lib/Consumer/QueueConsumer.php |
| AnonymousId | A unique identifier used to track users before they are identified. | Rudder::validate() lib/Rudder.php102 |
| Context | A dictionary of extra information about an event (e.g., library name, version, OS). | Client::message() lib/Client.php |
| Backoff | An exponential retry strategy used when the Data Plane returns retriable errors (e.g., 429 or 5xx). | LibCurl::flushBatch() lib/Consumer/LibCurl.php32-34 |
The following diagrams bridge the gap between high-level SDK operations and the specific classes or functions that handle them.
This diagram tracks the flow from a public static call to the final transport selection.
Sources: lib/Rudder.php67-75 lib/Rudder.php99-104 lib/Consumer/Consumer.php
This diagram maps different "Consumer Types" to their specific implementation classes and the PHP extensions they depend on.
Sources: lib/Consumer/LibCurl.php36-37 lib/Consumer/ForkCurl.php86 lib/Consumer/Socket.php70-76 composer.json35-38
flush_at: The number of events to buffer before triggering a flushBatch call.
max_queue_size: The maximum number of items allowed in the consumer's memory queue.
max_item_size_bytes: Maximum size of a single message in bytes (Default: 32KB).
compress_request: When true, the SDK uses gzencode (or gzip via shell in ForkCurl) to compress the JSON payload before transmission.
timeout / curl_timeout: Controls the network timeout for requests. timeout is used for Socket consumer lib/Consumer/Socket.php24 while curl_timeout is specific to LibCurl lib/Consumer/LibCurl.php41HTTP status codes that trigger the exponential backoff logic.
429 (Rate Limited), 500-600 (Server Errors).Socket::makeRequest lib/Consumer/Socket.php200 and LibCurl::flushBatch lib/Consumer/LibCurl.php103A special HTTP header (AnonymousId) sent during single-event batches to help the RudderStack server maintain event ordering.
base64_encoded before being added to the headers.Automatically injected metadata identifying the SDK.
rudder-php-sdk, version is sourced from Version.php.Sources:
Refresh this wiki