ioa-observe-sdk 0.0.1__tar.gz

ioa_observe_sdk-0.0.1/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2025 Cisco and/or its affiliates.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ioa_observe_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: ioa-observe-sdk
+Version: 0.0.1
+Summary: IOA Observe Observability SDK
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: aiohappyeyeballs==2.4.8
+Requires-Dist: aiohttp==3.11.18
+Requires-Dist: aiosignal==1.3.2
+Requires-Dist: annotated-types==0.7.0
+Requires-Dist: anyio==4.8.0
+Requires-Dist: async-timeout==5.0.1
+Requires-Dist: attrs==25.1.0
+Requires-Dist: backoff==2.2.1
+Requires-Dist: certifi==2025.1.31
+Requires-Dist: charset-normalizer==3.4.1
+Requires-Dist: colorama==0.4.6
+Requires-Dist: Deprecated==1.2.18
+Requires-Dist: distro==1.9.0
+Requires-Dist: exceptiongroup==1.2.2
+Requires-Dist: frozenlist==1.5.0
+Requires-Dist: googleapis-common-protos==1.69.0
+Requires-Dist: grpcio==1.70.0
+Requires-Dist: h11==0.16.0
+Requires-Dist: httpcore==1.0.9
+Requires-Dist: httpx==0.28.1
+Requires-Dist: idna==3.10
+Requires-Dist: importlib_metadata==8.5.0
+Requires-Dist: Jinja2==3.1.6
+Requires-Dist: jiter==0.8.2
+Requires-Dist: MarkupSafe==3.0.2
+Requires-Dist: monotonic==1.6
+Requires-Dist: multidict==6.1.0
+Requires-Dist: openai==1.75.0
+Requires-Dist: opentelemetry-api==1.33.1
+Requires-Dist: opentelemetry-distro
+Requires-Dist: opentelemetry-exporter-otlp==1.33.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.33.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.33.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.33.1
+Requires-Dist: opentelemetry-instrumentation
+Requires-Dist: opentelemetry-instrumentation-logging==0.54b1
+Requires-Dist: opentelemetry-instrumentation-openai==0.40.2
+Requires-Dist: opentelemetry-instrumentation-llamaindex==0.40.2
+Requires-Dist: opentelemetry-instrumentation-ollama==0.40.2
+Requires-Dist: opentelemetry-instrumentation-langchain==0.40.2
+Requires-Dist: opentelemetry-instrumentation-threading==00.54b1
+Requires-Dist: opentelemetry-instrumentation-urllib3==0.54b1
+Requires-Dist: opentelemetry-proto==1.33.1
+Requires-Dist: opentelemetry-sdk==1.33.1
+Requires-Dist: opentelemetry-semantic-conventions==0.54b1
+Requires-Dist: opentelemetry-semantic-conventions-ai==0.4.5
+Requires-Dist: opentelemetry-util-http==0.54b1
+Requires-Dist: packaging==24.2
+Requires-Dist: propcache==0.3.0
+Requires-Dist: protobuf==5.29.3
+Requires-Dist: pydantic==2.10.6
+Requires-Dist: pydantic_core==2.27.2
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: regex==2024.11.6
+Requires-Dist: requests==2.32.3
+Requires-Dist: six==1.17.0
+Requires-Dist: sniffio==1.3.1
+Requires-Dist: tenacity==9.0.0
+Requires-Dist: tiktoken==0.9.0
+Requires-Dist: tqdm==4.67.1
+Requires-Dist: typing_extensions==4.12.2
+Requires-Dist: urllib3==2.3.0
+Requires-Dist: wrapt==1.17.2
+Requires-Dist: yarl==1.18.3
+Requires-Dist: zipp==3.21.0
+Requires-Dist: langgraph==0.4.1
+Requires-Dist: opentelemetry-instrumentation-requests
+Requires-Dist: opentelemetry-instrumentation-transformers>=0.40.2
+Requires-Dist: opentelemetry-instrumentation-crewai>=0.40.2
+Requires-Dist: llama-index-utils-workflow>=0.3.1
+Requires-Dist: pytest
+Requires-Dist: pytest-vcr
+Dynamic: license-file
+
+# Observe-SDK
+
+IOA observability SDK for your multi-agentic application.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install the package via PyPI, simply run:
+
+```bash
+pip install ioa_observe_sdk
+```
+
+Alternatively, to download the SDK from git, you could also use the following command. Ensure you have `uv` installed in your environment.
+
+```bash
+uv add "git+https://github.com/agntcy/observe"
+```
+
+## Dev
+
+To get started with development, start a Clickhouse DB and an OTel collector container locally using docker-compose like so:
+
+```
+cd deploy/
+docker compose up -d
+```
+
+Ensure the contents of `otel-collector.yaml` is correct.
+
+Check the logs of the collector to ensure it is running correctly:
+
+```
+docker logs -f otel-collector
+```
+
+Create a `.env` file with the following content:
+
+```bash
+OTLP_HTTP_ENDPOINT=http://localhost:4318
+```
+
+Install the dependencies and activate the virtual environment:
+
+```bash
+set -a
+source .env
+set +a
+
+python3 -m venv .venv
+source .venv/bin/activate
+uv sync
+```
+
+## Testing
+
+To run the unit tests, ensure you have the `OPENAI_API_KEY` set in your environment. You can run the tests using the following command:
+
+```bash
+OPENAI_API_KEY=<KEY> make test
+```
+
+## Getting Started
+
+For getting started with the SDK, please refer to the [GETTING-STARTED.md](GETTING-STARTED.md) file. It contains detailed instructions on how to set up and use the SDK effectively.
+
+## SLIM-Based Multi-Agentic Systems
+
+For distributed agent systems using SLIM protocol, additional instrumentation is available:
+
+
+### Initializing the SLIM Connector with your agent
+
+```python
+from ioa_observe.sdk.connectors.slim import SLIMConnector, process_slim_msg
+from ioa_observe.sdk.instrumentations.slim import SLIMInstrumentor
+
+# Initialize SLIM connector
+slim_connector = SLIMConnector(
+    remote_org="cisco",
+    remote_namespace="default",
+    shared_space="chat",
+)
+
+# Register agents with the connector
+slim_connector.register("remote_client_agent")
+
+# Instrument SLIM communications
+SLIMInstrumentor().instrument()
+```
+
+### Receiving Messages with a Callback
+
+Add the decorator `process_slim_msg` to the callback function to process incoming messages. This function will be called whenever a message is received in the shared space.
+
+```python
+
+# Define a callback to process incoming messages
+from ioa_observe.sdk.connectors.slim import SLIMConnector, process_slim_msg
+import json
+from typing import Dict, Any
+
+@process_slim_msg("remote_client_agent")
+async def send_and_recv(msg) -> Dict[str, Any]:
+    """Send message to remote endpoint and wait for reply."""
+    gateway = GatewayHolder.gateway
+    session_info = GatewayHolder.session_info
+
+    if gateway is not None:
+        await gateway.publish(session_info, msg.encode(), "cisco", "default", "server")
+        async with gateway:
+            _, recv = await gateway.receive(session=session_info.id)
+    else:
+        raise RuntimeError("Gateway is not initialized yet!")
+
+    response_data = json.loads(recv.decode("utf8"))
+    return {"messages": response_data.get("messages", [])}
+```
+
+### Starting the Message Receiver
+
+```python
+# Start receiving messages from the SLIM shared space
+await slim.receive(callback=on_message_received)
+```
+
+### Publishing Messages
+
+```python
+# Publish a message to the SLIM shared space
+message = {"type": "ChatMessage", "author": "moderator", "message": "Hello, world!"}
+await slim.publish(msg=json.dumps(message).encode("utf-8"))
+```
+
+We will observe various events and metrics being sent to the Otel collector as we interact with other agents in the shared space via SLIM.
+
+## Contributing
+
+Contributions are welcome! Please follow these steps to contribute:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Create a new Pull Request.

ioa_observe_sdk-0.0.1/README.md

@@ -0,0 +1,152 @@
+# Observe-SDK
+
+IOA observability SDK for your multi-agentic application.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install the package via PyPI, simply run:
+
+```bash
+pip install ioa_observe_sdk
+```
+
+Alternatively, to download the SDK from git, you could also use the following command. Ensure you have `uv` installed in your environment.
+
+```bash
+uv add "git+https://github.com/agntcy/observe"
+```
+
+## Dev
+
+To get started with development, start a Clickhouse DB and an OTel collector container locally using docker-compose like so:
+
+```
+cd deploy/
+docker compose up -d
+```
+
+Ensure the contents of `otel-collector.yaml` is correct.
+
+Check the logs of the collector to ensure it is running correctly:
+
+```
+docker logs -f otel-collector
+```
+
+Create a `.env` file with the following content:
+
+```bash
+OTLP_HTTP_ENDPOINT=http://localhost:4318
+```
+
+Install the dependencies and activate the virtual environment:
+
+```bash
+set -a
+source .env
+set +a
+
+python3 -m venv .venv
+source .venv/bin/activate
+uv sync
+```
+
+## Testing
+
+To run the unit tests, ensure you have the `OPENAI_API_KEY` set in your environment. You can run the tests using the following command:
+
+```bash
+OPENAI_API_KEY=<KEY> make test
+```
+
+## Getting Started
+
+For getting started with the SDK, please refer to the [GETTING-STARTED.md](GETTING-STARTED.md) file. It contains detailed instructions on how to set up and use the SDK effectively.
+
+## SLIM-Based Multi-Agentic Systems
+
+For distributed agent systems using SLIM protocol, additional instrumentation is available:
+
+
+### Initializing the SLIM Connector with your agent
+
+```python
+from ioa_observe.sdk.connectors.slim import SLIMConnector, process_slim_msg
+from ioa_observe.sdk.instrumentations.slim import SLIMInstrumentor
+
+# Initialize SLIM connector
+slim_connector = SLIMConnector(
+    remote_org="cisco",
+    remote_namespace="default",
+    shared_space="chat",
+)
+
+# Register agents with the connector
+slim_connector.register("remote_client_agent")
+
+# Instrument SLIM communications
+SLIMInstrumentor().instrument()
+```
+
+### Receiving Messages with a Callback
+
+Add the decorator `process_slim_msg` to the callback function to process incoming messages. This function will be called whenever a message is received in the shared space.
+
+```python
+
+# Define a callback to process incoming messages
+from ioa_observe.sdk.connectors.slim import SLIMConnector, process_slim_msg
+import json
+from typing import Dict, Any
+
+@process_slim_msg("remote_client_agent")
+async def send_and_recv(msg) -> Dict[str, Any]:
+    """Send message to remote endpoint and wait for reply."""
+    gateway = GatewayHolder.gateway
+    session_info = GatewayHolder.session_info
+
+    if gateway is not None:
+        await gateway.publish(session_info, msg.encode(), "cisco", "default", "server")
+        async with gateway:
+            _, recv = await gateway.receive(session=session_info.id)
+    else:
+        raise RuntimeError("Gateway is not initialized yet!")
+
+    response_data = json.loads(recv.decode("utf8"))
+    return {"messages": response_data.get("messages", [])}
+```
+
+### Starting the Message Receiver
+
+```python
+# Start receiving messages from the SLIM shared space
+await slim.receive(callback=on_message_received)
+```
+
+### Publishing Messages
+
+```python
+# Publish a message to the SLIM shared space
+message = {"type": "ChatMessage", "author": "moderator", "message": "Hello, world!"}
+await slim.publish(msg=json.dumps(message).encode("utf-8"))
+```
+
+We will observe various events and metrics being sent to the Otel collector as we interact with other agents in the shared space via SLIM.
+
+## Contributing
+
+Contributions are welcome! Please follow these steps to contribute:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Create a new Pull Request.