streamdal/python-sdk

Python SDK

MOVED TO github.com/streamdal/streamdal/sdks/python

Streamdal Python SDK

python-sdk is the python client SDK for Streamdal's open source observability server https://github.com/streamdal/streamdal

Documentation

See https://docs.streamdal.com

Installation

python -m pip install streamdal

Requirements

• python >= 3.8

Example Usage

import json
from streamdal import (OPERATION_TYPE_CONSUMER, ProcessRequest, StreamdalClient, StreamdalConfig, EXEC_STATUS_TRUE)

client = StreamdalClient(
    cfg=StreamdalConfig(
        service_name="order-ingest",
        streamdal_url="streamdal-server.svc.cluster.local:8082",
        streamdal_token="1234",
    )
)

res = client.process(
    ProcessRequest(
        operation_type=OPERATION_TYPE_CONSUMER,
        operation_name="new-order-topic",
        component_name="kafka",
        data=b'{"object": {"email": "user@streamdal.com"}}',
    )
)

# Check that process() completed successfully
if res.status == EXEC_STATUS_TRUE:
    print("Success processed payload")
    data = json.loads(res.data)
    print("Response:", json.dumps(data, indent=2))
else:
    print("Failed to process payload")
    print("Error:", res.status_message)

Metrics

Metrics are published to Streamdal server and are available in Prometheus format at http://streamdal_server_url:8081/metrics

Metric	Description	Labels
streamdal_counter_consume_bytes	Number of bytes consumed by the client	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_consume_errors	Number of errors encountered while consuming payloads	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_consume_processed	Number of payloads processed by the client	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_produce_bytes	Number of bytes produced by the client	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_produce_errors	Number of errors encountered while producing payloads	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_produce_processed	Number of payloads processed by the client	service, component_name, operation_name, pipeline_id, pipeline_name
streamdal_counter_notify	Number of notifications sent to the server	service, component_name, operation_name, pipeline_id, pipeline_name

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details