flock-core 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

flock/__init__.py

@@ -1 +1,5 @@
 """Flock package initialization."""
+
+from flock.config import TELEMETRY
+
+tracer = TELEMETRY.setup_tracing()

flock/config.py

@@ -0,0 +1,29 @@
+# flock/config.py
+import os
+
+from flock.core.logging.telemetry import TelemetryConfig
+
+# -- Connection and External Service Configurations --
+TEMPORAL_SERVER_URL = os.getenv("TEMPORAL_SERVER_URL", "localhost:7233")
+DEFAULT_MODEL = os.getenv("DEFAULT_MODEL", "openai/gpt-4o")
+
+# API Keys and related settings
+TAVILY_API_KEY = os.getenv("TAVILY_API_KEY", "")
+GITHUB_PAT = os.getenv("GITHUB_PAT", "")
+GITHUB_REPO = os.getenv("GITHUB_REPO", "")
+GITHUB_USERNAME = os.getenv("GITHUB_USERNAME", "")
+
+# -- Debugging and Logging Configurations --
+LOCAL_DEBUG = os.getenv("LOCAL_DEBUG", "0") == "1"
+LOG_LEVEL = os.getenv("LOG_LEVEL", "DEBUG")
+
+OTL_SERVICE_NAME = os.getenv("OTL_SERVICE_NAME", "otel-flock")
+JAEGER_ENDPOINT = os.getenv(
+    "JAEGER_ENDPOINT", "http://localhost:14268/api/traces"
+)  # Default gRPC endpoint for Jaeger
+JAEGER_TRANSPORT = os.getenv(
+    "JAEGER_TRANSPORT", "http"
+).lower()  # Options: "grpc" or "http"
+
+
+TELEMETRY = TelemetryConfig(OTL_SERVICE_NAME, JAEGER_ENDPOINT, JAEGER_TRANSPORT)

flock/core/__init__.py

@@ -1 +1,6 @@
+"""This module contains the core classes of the flock package."""
 
+from flock.core.flock import Flock
+from flock.core.flock_agent import FlockAgent
+
+__all__ = ["Flock", "FlockAgent"]

flock/core/flock.py

@@ -15,14 +15,13 @@ from flock.core.flock_agent import FlockAgent
 from flock.core.logging.formatters.base_formatter import FormatterOptions
 from flock.core.logging.formatters.pprint_formatter import PrettyPrintFormatter
 from flock.core.logging.logging import get_logger
-from flock.core.logging.telemetry import setup_tracing
 from flock.core.registry.agent_registry import Registry
 from flock.core.util.cli_helper import display_banner
 from flock.core.util.input_resolver import top_level_to_keys
 
 T = TypeVar("T", bound=FlockAgent)
 logger = get_logger("flock")
-tracer = setup_tracing()
+
 tracer = trace.get_tracer(__name__)
 
 

flock/core/logging/formatters/pprint_formatter.py

@@ -1,15 +1,21 @@
+import json
 from typing import Any
 
 from flock.core.logging.formatters.base_formatter import BaseFormatter
 
 
 class PrettyPrintFormatter(BaseFormatter):
-    def display_result(self, result: dict[str, Any], agent_name: str, **kwargs) -> None:
+    def display_result(
+        self, result: dict[str, Any], agent_name: str, **kwargs
+    ) -> None:
         """Print an agent's result using Rich formatting."""
-        from devtools import pprint
+        from rich.console import Console
+        from rich.json import JSON
+
+        console = Console()
 
-        pprint(agent_name)
-        pprint(result)
+        console.print(agent_name)
+        console.print(JSON(json.dumps(result)))
 
     def display_data(self, data: dict[str, Any], **kwargs) -> None:
         """Print an agent's result using Rich formatting."""

flock/core/logging/telemetry.py

@@ -1,21 +1,109 @@
+"""This module sets up OpenTelemetry tracing for a service."""
+
 from opentelemetry import trace
-from opentelemetry.exporter.jaeger.thrift import JaegerExporter
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
-from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.sdk.trace.export import (
+    BatchSpanProcessor,
+)
+
+from flock.core.logging.telemetry_exporter.file_span import FileSpanExporter
+from flock.core.logging.telemetry_exporter.sqllite_span import (
+    SQLiteSpanExporter,
+)
+
+
+class TelemetryConfig:
+    """This configuration class sets up OpenTelemetry tracing.
+
+      - Export spans to a Jaeger collector using gRPC.
+      - Write spans to a file.
+      - Save spans in a SQLite database.
+
+    Only exporters with a non-None configuration will be activated.
+    """
+
+    def __init__(
+        self,
+        service_name: str,
+        jaeger_endpoint: str = None,
+        jaeger_transport: str = "grpc",
+        file_export_path: str = None,
+        sqlite_db_path: str = None,
+        batch_processor_options: dict = None,
+    ):
+        """:param service_name: Name of your service.
+
+        :param jaeger_endpoint: The Jaeger collector gRPC endpoint (e.g., "localhost:14250").
+        :param file_export_path: If provided, spans will be written to this file.
+        :param sqlite_db_path: If provided, spans will be stored in this SQLite DB.
+        :param batch_processor_options: Dict of options for BatchSpanProcessor (e.g., {"max_export_batch_size": 10}).
+        """
+        self.service_name = service_name
+        self.jaeger_endpoint = jaeger_endpoint
+        self.jaeger_transport = jaeger_transport
+        self.file_export_path = file_export_path
+        self.sqlite_db_path = sqlite_db_path
+        self.batch_processor_options = batch_processor_options or {}
+
+    def setup_tracing(self):
+        # Create a Resource with the service name.
+        resource = Resource(attributes={"service.name": self.service_name})
+        provider = TracerProvider(resource=resource)
+        trace.set_tracer_provider(provider)
+
+        # List to collect our span processors.
+        span_processors = []
+
+        # If a Jaeger endpoint is specified, add the Jaeger gRPC exporter.
+        if self.jaeger_endpoint:
+            if self.jaeger_transport == "grpc":
+                from opentelemetry.exporter.jaeger.proto.grpc import (
+                    JaegerExporter,
+                )
+
+                jaeger_exporter = JaegerExporter(
+                    endpoint=self.jaeger_endpoint,
+                    insecure=True,
+                )
+            elif self.jaeger_transport == "http":
+                from opentelemetry.exporter.jaeger.thrift import JaegerExporter
+
+                jaeger_exporter = JaegerExporter(
+                    collector_endpoint=self.jaeger_endpoint,
+                )
+            else:
+                raise ValueError(
+                    "Invalid JAEGER_TRANSPORT specified. Use 'grpc' or 'http'."
+                )
+
+            span_processors.append(
+                BatchSpanProcessor(
+                    jaeger_exporter, **self.batch_processor_options
+                )
+            )
 
+        # If a file path is provided, add the custom file exporter.
+        if self.file_export_path:
+            file_exporter = FileSpanExporter(self.file_export_path)
+            span_processors.append(
+                BatchSpanProcessor(
+                    file_exporter, **self.batch_processor_options
+                )
+            )
 
-def setup_tracing():
-    resource = Resource(attributes={"service.name": "flock-agent-framework"})
-    provider = TracerProvider(resource=resource)
-    trace.set_tracer_provider(provider)
+        # If a SQLite database path is provided, add the custom SQLite exporter.
+        if self.sqlite_db_path:
+            sqlite_exporter = SQLiteSpanExporter(self.sqlite_db_path)
+            span_processors.append(
+                BatchSpanProcessor(
+                    sqlite_exporter, **self.batch_processor_options
+                )
+            )
 
-    # Create a Jaeger exporter
-    jaeger_exporter = JaegerExporter(
-        agent_host_name="localhost",  # or the hostname where Jaeger is running
-        agent_port=6831,  # default Jaeger agent port
-    )
+        # Register all span processors with the provider.
+        for processor in span_processors:
+            provider.add_span_processor(processor)
 
-    provider.add_span_processor(BatchSpanProcessor(jaeger_exporter))
-    tracer = trace.get_tracer(__name__)
-    return tracer
+        # Return a tracer instance.
+        return trace.get_tracer(__name__)

flock/core/logging/telemetry_exporter/file_span.py

@@ -0,0 +1,37 @@
+import json
+
+from opentelemetry.sdk.trace.export import (
+    SpanExporter,
+    SpanExportResult,
+)
+
+
+class FileSpanExporter(SpanExporter):
+    """A simple exporter that writes span data as JSON lines into a file."""
+
+    def __init__(self, file_path: str):
+        self.file_path = file_path
+
+    def export(self, spans) -> SpanExportResult:
+        try:
+            with open(self.file_path, "a") as f:
+                for span in spans:
+                    # Create a dictionary representation of the span.
+                    span_dict = {
+                        "name": span.name,
+                        "trace_id": format(span.context.trace_id, "032x"),
+                        "span_id": format(span.context.span_id, "016x"),
+                        "start_time": span.start_time,
+                        "end_time": span.end_time,
+                        "attributes": span.attributes,
+                        "status": str(span.status),
+                    }
+                    f.write(json.dumps(span_dict) + "\n")
+            return SpanExportResult.SUCCESS
+        except Exception as e:
+            print("Error exporting spans to file:", e)
+            return SpanExportResult.FAILURE
+
+    def shutdown(self) -> None:
+        # Nothing special needed on shutdown.
+        pass

flock/core/logging/telemetry_exporter/sqllite_span.py

@@ -0,0 +1,68 @@
+import json
+import sqlite3
+
+from opentelemetry.sdk.trace.export import (
+    SpanExporter,
+    SpanExportResult,
+)
+
+
+class SQLiteSpanExporter(SpanExporter):
+    """A custom exporter that writes span data into a SQLite database."""
+
+    def __init__(self, sqlite_db_path: str):
+        self.sqlite_db_path = sqlite_db_path
+        self.conn = sqlite3.connect(
+            self.sqlite_db_path, check_same_thread=False
+        )
+        self._create_table()
+
+    def _create_table(self):
+        cursor = self.conn.cursor()
+        cursor.execute(
+            """
+            CREATE TABLE IF NOT EXISTS spans (
+                id TEXT PRIMARY KEY,
+                name TEXT,
+                trace_id TEXT,
+                span_id TEXT,
+                start_time INTEGER,
+                end_time INTEGER,
+                attributes TEXT,
+                status TEXT
+            )
+            """
+        )
+        self.conn.commit()
+
+    def export(self, spans) -> SpanExportResult:
+        try:
+            cursor = self.conn.cursor()
+            for span in spans:
+                span_id = format(span.context.span_id, "016x")
+                trace_id = format(span.context.trace_id, "032x")
+                cursor.execute(
+                    """
+                    INSERT OR REPLACE INTO spans 
+                    (id, name, trace_id, span_id, start_time, end_time, attributes, status)
+                    VALUES (?, ?, ?, ?, ?, ?, ?, ?)
+                    """,
+                    (
+                        span_id,
+                        span.name,
+                        trace_id,
+                        span_id,
+                        span.start_time,
+                        span.end_time,
+                        json.dumps(span.attributes),
+                        str(span.status),
+                    ),
+                )
+            self.conn.commit()
+            return SpanExportResult.SUCCESS
+        except Exception as e:
+            print("Error exporting spans to SQLite:", e)
+            return SpanExportResult.FAILURE
+
+    def shutdown(self) -> None:
+        self.conn.close()

flock/core/util/cli_helper.py

@@ -1,6 +1,13 @@
+from importlib.metadata import PackageNotFoundError, version
+
 from rich.console import Console
 from rich.syntax import Text
 
+try:
+    __version__ = version("flock-core")
+except PackageNotFoundError:
+    __version__ = "0.2.0"
+
 console = Console()
 
 
@@ -21,5 +28,5 @@ def display_banner():
     )
     console.print(banner_text)
     console.print(
-        f"[bold]v0.2.1[/] - [bold]white duck GmbH[/] - [cyan]https://whiteduck.de[/]\n"
+        f"[bold]v{__version__}[/] - [bold]white duck GmbH[/] - [cyan]https://whiteduck.de[/]\n"
     )

flock/workflow/activities.py

@@ -96,7 +96,7 @@ async def run_agent(
                     context.record(
                         agent.name,
                         result,
-                        timestamp=datetime.now(),
+                        timestamp=datetime.now().isoformat(),
                         hand_off=None,
                         called_from=previous_agent_name,
                     )

{flock_core-0.2.2.dist-info → flock_core-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flock-core
-Version: 0.2.2
+Version: 0.2.4
 Summary: Declarative LLM Orchestration at Scale
 Author-email: Andre Ratzenberger <andre.ratzenberger@whiteduck.de>
 License-File: LICENSE
@@ -15,6 +15,7 @@ Requires-Dist: httpx>=0.28.1
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: msgpack>=1.1.0
 Requires-Dist: opentelemetry-api>=1.30.0
+Requires-Dist: opentelemetry-exporter-jaeger-proto-grpc>=1.21.0
 Requires-Dist: opentelemetry-exporter-jaeger>=1.21.0
 Requires-Dist: opentelemetry-exporter-otlp>=1.30.0
 Requires-Dist: opentelemetry-instrumentation-logging>=0.51b0
@@ -35,7 +36,14 @@ Description-Content-Type: text/markdown
 
 <p align="center">
 <img src="docs/img/flock.png" width="600"><br>
-<h1 align="center">Flock<br></h1><br>
+<img alt="Dynamic TOML Badge" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fwhiteducksoftware%2Fflock%2Frefs%2Fheads%2Fbadges%2Fpyproject.toml%3Ftoken%3DGHSAT0AAAAAACVFDVNBU3S6HLJSC36P3YNQZ5LNPQQ&query=%24.project.version&style=for-the-badge&logo=pypi&logoSize=large&label=pip%20version&link=https%3A%2F%2Fpypi.org%2Fproject%2Fflock-core%2F">
+
+
+
+
+
+
+
 
 
 ## Overview

{flock_core-0.2.2.dist-info → flock_core-0.2.4.dist-info}/RECORD

@@ -1,6 +1,7 @@
-flock/__init__.py,sha256=JeRpPR29wyqXe8El-Ug4v_Ibhf5GQm_i8yWMi0cUYz0,36
-flock/core/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-flock/core/flock.py,sha256=BKuPrOVzudoqauokWyf59UXKlKZ3Qy9iKOm3ZaU_18E,9517
+flock/__init__.py,sha256=uJxXAxt0def69cccAAdLjBxQOFXVRO72RE82hJnODSw,108
+flock/config.py,sha256=hul_Vmgl8w5a_4YNfg3Mvll3iVEkjiR5At9D0WsVesw,1006
+flock/core/__init__.py,sha256=0Xq_txurlxxjKGXjRn6GNJusGTiBcd7zw2eF0L7JyuU,183
+flock/core/flock.py,sha256=Iw7Frmz2aZheApxi2KSjsX7gA8ZcemzXhfKXeQdtY0w,9438
 flock/core/flock_agent.py,sha256=59qQ7ohOy2lc1KjI6SV7IcrqYL86ofAhq32pZGgk6eA,27761
 flock/core/context/context.py,sha256=jH06w4C_O5CEL-YxjX_x_dmgLe9Rcllnn1Ebs0dvwaE,6171
 flock/core/context/context_manager.py,sha256=qMySVny_dbTNLh21RHK_YT0mNKIOrqJDZpi9ZVdBsxU,1103
@@ -9,20 +10,22 @@ flock/core/execution/local_executor.py,sha256=O_dgQ_HJPCp97ghdEoDSNDIiaYkogrUS0G
 flock/core/execution/temporal_executor.py,sha256=ai6ikr9rEiN2Kc-208OalxtfqL_FTt_UaH6a--oEkJM,2010
 flock/core/logging/__init__.py,sha256=Q8hp9-1ilPIUIV0jLgJ3_cP7COrea32cVwL7dicPnlM,82
 flock/core/logging/logging.py,sha256=F-FDz9etBXmAIT-fjx3pUfvNXsckgR6ONCMaFZIc4Kw,4619
-flock/core/logging/telemetry.py,sha256=K7uhMQHf1aGvfeNnuAM-wd65tpal9ch5piYF6RxU4Js,786
+flock/core/logging/telemetry.py,sha256=T2CRSiqOWvOsXe-WRsObkkOkrrd6z-BwEYLaBUU2AAM,4017
 flock/core/logging/trace_and_logged.py,sha256=h4YH8s0KjK4tiBdrEZdCLd4fDzMB5-NKwqzrtkWhQw4,1999
 flock/core/logging/formatters/base_formatter.py,sha256=CyG-X2NWq8sqEhFEO2aG7Mey5tVkIzoWiihW301_VIo,1023
 flock/core/logging/formatters/formatter_factory.py,sha256=hmH-NpCESHkioX0GBQ5CuQR4axyIXnSRWwAZCHylx6Q,1283
-flock/core/logging/formatters/pprint_formatter.py,sha256=2CZoMbfzJB9Xp9WaItxnXY3hfANMjDTXowk3ni6N-h4,565
+flock/core/logging/formatters/pprint_formatter.py,sha256=tTm2WhwlCw-SX2Ouci5I9U_HVgxNGY5SSnzB9HZh8bg,692
 flock/core/logging/formatters/rich_formatters.py,sha256=h1FD0_cIdQBQ8P2x05XhgD1cmmP80IBNVT5jb3cAV9M,4776
 flock/core/logging/formatters/theme_builder.py,sha256=1RUEwPIDfCjwTapbK1liasA5SdukOn7YwbZ4H4j1WkI,17364
 flock/core/logging/formatters/themed_formatter.py,sha256=CbxmqUC7zkLzyIxngk-3dcpQ6vxPR6zaDNA2TAMitCI,16714
+flock/core/logging/telemetry_exporter/file_span.py,sha256=e4hr4D7tC9j4KT7JZBuZU0YxQCdHKADpXNeUNEwggN4,1294
+flock/core/logging/telemetry_exporter/sqllite_span.py,sha256=9bqxHt1mDQGyhKxA9dON5xDi_6FMOfBSdrU_zWV0xv4,2107
 flock/core/mixin/dspy_integration.py,sha256=oT5YfXxPhHkMCuwhXoppBAYBGePUAKse7KebGSM-bq0,6880
 flock/core/mixin/prompt_parser.py,sha256=eOqI-FK3y17gVqpc_y5GF-WmK1Jv8mFlkZxTcgweoxI,5121
 flock/core/registry/agent_registry.py,sha256=QHdr3Cb-32PEdz8jFCIZSH9OlfpRwAJMtSRpHCWJDq4,4889
 flock/core/tools/basic_tools.py,sha256=nRc1bIz96z-WUTe_yYf9V6EfCPEncl_XnrpGdC7dEmo,8721
 flock/core/tools/dev_tools/github.py,sha256=6ya2_eN-qITV3b_pYP24jQC3X4oZbRY5GKh1AF-9Zic,6836
-flock/core/util/cli_helper.py,sha256=hXBXhTQizZILXiVeBFR6QdAsQm0Qj29ANHJRgiekwyw,859
+flock/core/util/cli_helper.py,sha256=aHLKjl5JBLIczLzjYeUcGQlVQRlypunxV2TYeAFX0KE,1030
 flock/core/util/input_resolver.py,sha256=OesGqX2Dld8myL9Qz04mmxLqoYqOSQC632pj1EMk9Yk,5456
 flock/core/util/serializable.py,sha256=SymJ0YrjBx48mOBItYSqoRpKuzIc4vKWRS6ScTzre7s,2573
 flock/themes/3024-day.toml,sha256=uOVHqEzSyHx0WlUk3D0lne4RBsNBAPCTy3C58yU7kEY,667
@@ -362,11 +365,11 @@ flock/themes/zenburned.toml,sha256=UEmquBbcAO3Zj652XKUwCsNoC2iQSlIh-q5c6DH-7Kc,1
 flock/themes/zenwritten-dark.toml,sha256=To5l6520_3UqAGiEumpzGWsHhXxqu9ThrMildXKgIO0,1669
 flock/themes/zenwritten-light.toml,sha256=G1iEheCPfBNsMTGaVpEVpDzYBHA_T-MV27rolUYolmE,1666
 flock/workflow/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-flock/workflow/activities.py,sha256=G3LcW0Bs0-Iu_ry0Ch8DbP8yJ1eftwaZZ71PVWJaoVs,7634
+flock/workflow/activities.py,sha256=YEg-Gr8kzVsxWsmsZguIVhX2XwMRvhZ2OlnsJoG5g_A,7646
 flock/workflow/agent_activities.py,sha256=NhBZscflEf2IMfSRa_pBM_TRP7uVEF_O0ROvWZ33eDc,963
 flock/workflow/temporal_setup.py,sha256=VWBgmBgfTBjwM5ruS_dVpA5AVxx6EZ7oFPGw4j3m0l0,1091
 flock/workflow/workflow.py,sha256=I9MryXW_bqYVTHx-nl2epbTqeRy27CAWHHA7ZZA0nAk,1696
-flock_core-0.2.2.dist-info/METADATA,sha256=P_6coaQ37bbmA6pbqptH8N5EvDHqroC_shFqAChW1_A,11065
-flock_core-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-flock_core-0.2.2.dist-info/licenses/LICENSE,sha256=iYEqWy0wjULzM9GAERaybP4LBiPeu7Z1NEliLUdJKSc,1072
-flock_core-0.2.2.dist-info/RECORD,,
+flock_core-0.2.4.dist-info/METADATA,sha256=VztTdTQKj4pIiPnSearGjlMDmPA_1o0Nak_EefDzs4o,11488
+flock_core-0.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+flock_core-0.2.4.dist-info/licenses/LICENSE,sha256=iYEqWy0wjULzM9GAERaybP4LBiPeu7Z1NEliLUdJKSc,1072
+flock_core-0.2.4.dist-info/RECORD,,