monocle-apptrace 0.1.0__tar.gz → 0.2.0__tar.gz

monocle_apptrace-0.2.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+## 0.2.0 (Oct 22, 2024)
+
+- Ndjson format for S3 and Blob exporters ([#61](https://github.com/monocle2ai/monocle/pull/61))
+- Set monocle exporter from env setting ([#60](https://github.com/monocle2ai/monocle/pull/60))
+- Update workflow name and type with new format ([#59](https://github.com/monocle2ai/monocle/pull/59))
+- Updated async and custom output processor testcase for metamodel([#58](https://github.com/monocle2ai/monocle/pull/58))
+- Build okahu exporter and added test cases for okahu exporte ([#56](https://github.com/monocle2ai/monocle/pull/56))
+- Handle exception in span wrappers([#52](https://github.com/monocle2ai/monocle/pull/52))
+- Metamodel entity changes ([#51](https://github.com/monocle2ai/monocle/pull/51)), ([#54](https://github.com/monocle2ai/monocle/pull/54))
+- Error handling for llm_endpoint and tags ([#50](https://github.com/monocle2ai/monocle/pull/50))
+- Context_output for vector store retriever ([#48](https://github.com/monocle2ai/monocle/pull/48))
+- Direct exporter - AWS S3 ([#42](https://github.com/monocle2ai/monocle/pull/42))
+- Direct Exporter - Blob store ([#41](https://github.com/monocle2ai/monocle/pull/41))
+- Initial metamodel definition ([#39](https://github.com/monocle2ai/monocle/pull/39))
+- Improvement in vectorstore traces ([#38](https://github.com/monocle2ai/monocle/pull/38))
+- Update key for session context field in attributes ([#34](https://github.com/monocle2ai/monocle/pull/34))
+
+
+## 0.1.0 (Aug 27, 2024)
+
+- Fixed LlamaIndex tracing bugs ([#32](https://github.com/monocle2ai/monocle/pull/32))
+- Added support to add AWS cloud infra attributes ([#29](https://github.com/monocle2ai/monocle/pull/29))
+- Added support to add Azure cloud infra attributes ([#23](https://github.com/monocle2ai/monocle/pull/23))
+- Added support for adding provider name in LLM span in traces ([#22](https://github.com/monocle2ai/monocle/pull/22))
+- Added a default file span exporter ([#21](https://github.com/monocle2ai/monocle/pull/21))
+- Moved input and output context and prompts from attributes to events ([#15](https://github.com/monocle2ai/monocle/pull/15))
+
+
+
+
+
+
+## 0.0.1 (Jul 17, 2024)
+
+- First monocle release

{monocle_apptrace-0.1.0 → monocle_apptrace-0.2.0}/Monocle_User_Guide.md

@@ -1,4 +1,4 @@
-#Monocle User Guide
+# Monocle User Guide
 
 ## Monocle Concepts
 ### Traces
@@ -13,15 +13,27 @@ It’s typically the workflow code components of an application that generate th
 ``` 
     > pip install monocle_apptrace
 ```
+
+- For Azure support (to upload traces to Azure), install with the azure extra:
+```
+    > pip install monocle_apptrace[azure]
+```
+
+- For AWS support (to upload traces to AWS), install with the aws extra:
+```
+    > pip install monocle_apptrace[aws]
+```
+
 - You can locally build and install Monocle library from source
 ```
-> pip install .
+    > pip install .
 ```
 - Install the optional test dependencies listed against dev in pyproject.toml in editable mode
 ```
-> pip install -e ".[dev]"
+    > pip install -e ".[dev]"
 ```
 
+
 ## Using Monocle with your application to generate traces
 ### Enable Monocle tracing
 You need to import monocle package and invoke the API ``setup_monocle_telemetry(workflow=<workflow-name>)`` to enable the tracing. The 'workflow-name' is what you define to identify the give application workflow, for example "customer-chatbot". Monocle trace will include this name in every trace. The trace output will include a list of spans in the traces. You can print the output on the console or send it to an HTTP endpoint.
@@ -48,7 +60,7 @@ chain.invoke({"number":2})
 # Request callbacks: Finally, let's use the request `callbacks` to achieve the same result
 chain = LLMChain(llm=llm, prompt=prompt)
 chain.invoke({"number":2}, {"callbacks":[handler]})
-    
+
 ```
 
 ### Accessing monocle trace
@@ -63,6 +75,12 @@ setup_monocle_telemetry(workflow_name = "simple_math_app",
 ```
 To print the trace on the console, use ```ConsoleSpanExporter()``` instead of ```FileSpanExporter()```
 
+For Azure:
+    Install the Azure support as shown in the setup section, then use  ```AzureBlobSpanExporter()``` to upload the traces to Azure. 
+
+For AWS:
+    Install the AWS support as shown in the setup section, then use  ```S3SpanExporter()``` to upload the traces to an S3 bucket.
+ 
 ### Leveraging Monocle's extensibility to handle customization 
 When the out of box features from app frameworks are not sufficent, the app developers have to add custom code. For example, if you are extending a LLM class in LlamaIndex to use a model hosted in NVIDIA Triton. This new class is not know to Monocle. You can specify this new class method part of Monocle enabling API and it will be able to trace it.
 

monocle_apptrace-0.2.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.3
+Name: monocle_apptrace
+Version: 0.2.0
+Summary: package with monocle genAI tracing
+Project-URL: Homepage, https://github.com/monocle2ai/monocle
+Project-URL: Issues, https://github.com/monocle2ai/monocle/issues
+License-File: LICENSE
+License-File: NOTICE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: opentelemetry-api>=1.21.0
+Requires-Dist: opentelemetry-instrumentation
+Requires-Dist: opentelemetry-sdk>=1.21.0
+Requires-Dist: requests
+Requires-Dist: wrapt>=1.14.0
+Provides-Extra: aws
+Requires-Dist: boto3==1.35.19; extra == 'aws'
+Provides-Extra: azure
+Requires-Dist: azure-storage-blob==12.22.0; extra == 'azure'
+Provides-Extra: dev
+Requires-Dist: datasets==2.20.0; extra == 'dev'
+Requires-Dist: faiss-cpu==1.8.0; extra == 'dev'
+Requires-Dist: instructorembedding==1.0.1; extra == 'dev'
+Requires-Dist: langchain-chroma==0.1.1; extra == 'dev'
+Requires-Dist: langchain-community==0.2.5; extra == 'dev'
+Requires-Dist: langchain-openai==0.1.8; extra == 'dev'
+Requires-Dist: langchain==0.2.5; extra == 'dev'
+Requires-Dist: llama-index-embeddings-huggingface==0.2.0; extra == 'dev'
+Requires-Dist: llama-index-vector-stores-chroma==0.1.9; extra == 'dev'
+Requires-Dist: llama-index==0.10.30; extra == 'dev'
+Requires-Dist: numpy==1.26.4; extra == 'dev'
+Requires-Dist: parameterized==0.9.0; extra == 'dev'
+Requires-Dist: pytest==8.0.0; extra == 'dev'
+Requires-Dist: sentence-transformers==2.6.1; extra == 'dev'
+Requires-Dist: types-requests==2.31.0.20240106; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Monocle for tracing GenAI app code
+
+**Monocle** helps developers and platform engineers building or managing GenAI apps monitor these in prod by making it easy to instrument their code to capture traces that are compliant with open-source cloud-native observability ecosystem. 
+
+**Monocle** is a community-driven OSS framework for tracing GenAI app code governed as a [Linux Foundation AI & Data project](https://lfaidata.foundation/projects/monocle/). 
+
+## Why Monocle
+
+Monocle is built for: 
+- **app developers** to trace their app code in any environment without lots of custom code decoration 
+- **platform engineers** to instrument apps in prod through wrapping instead of asking app devs to recode
+- **GenAI component providers** to add observability features to their products 
+- **enterprises** to consume traces from GenAI apps in their existing open-source observability stack
+
+Benefits:
+- Monocle provides an implementation + package, not just a spec 
+   - No expertise in OpenTelemetry spec required
+   - No bespoke implementation of that spec required
+   - No last-mile GenAI domain specific code required to instrument your app
+- Monocle provides consistency  
+   - Connect traces across app code executions, model inference or data retrievals
+   - No cleansing of telemetry data across GenAI component providers required
+   - Works the same in personal lab dev or org cloud prod environments
+   - Send traces to location that fits your scale, budget and observability stack
+- Monocle is fully open source and community driven
+   - No vendor lock-in
+   - Implementation is transparent
+   - You can freely use or customize it to fit your needs 
+
+## What Monocle provides
+
+- Easy to [use](#use-monocle) code instrumentation
+- OpenTelemetry compatible format for [spans](src/monocle_apptrace/metamodel/spans/span_format.json). 
+- Community-curated and extensible [metamodel](src/monocle_apptrace/metamodel/README.md) for consisent tracing of GenAI components. 
+- Export to local and cloud storage 
+
+## Use Monocle
+
+- Get the Monocle package
+  
+```
+    pip install monocle_apptrace 
+```
+- Instrument your app code
+     - Import the Monocle package
+       ```
+          from monocle_apptrace.instrumentor import setup_monocle_telemetry
+       ```
+     - Setup instrumentation in your ```main()``` function  
+       ``` 
+          setup_monocle_telemetry(workflow_name="your-app-name")
+       ```         
+- (Optionally) Modify config to alter where traces are sent
+
+See [Monocle user guide](Monocle_User_Guide.md) for more details.
+  
+
+## Roadmap 
+
+Goal of Monocle is to support tracing for apps written in *any language* with *any LLM orchestration or agentic framework* and built using models, vectors, agents or other components served up by *any cloud or model inference provider*. 
+
+Current version supports: 
+- Language: (🟢) Python , (🔜) [Typescript](https://github.com/monocle2ai/monocle-typescript) 
+- LLM-frameworks: (🟢) Langchain, (🟢) Llamaindex, (🟢) Haystack, (🔜) Flask
+- LLM inference providers: (🟢) OpenAI, (🟢) Azure OpenAI, (🟢) Nvidia Triton, (🔜) AWS Bedrock, (🔜) Google Vertex, (🔜) Azure ML, (🔜) Hugging Face
+- Vector stores: (🟢) FAISS, (🔜) OpenSearch, (🔜) Milvus
+- Exporter: (🟢) stdout, (🟢) file, (🔜) Azure Blob Storage, (🔜) AWS S3, (🔜) Google Cloud Storage
+
+
+## Get involved
+### Provide feedback
+- Submit issues and enhancements requests via Github issues
+
+### Contribute
+- Monocle is community based open source project. We welcome your contributions. Please refer to the CONTRIBUTING and CODE_OF_CONDUCT for guidelines. The [contributor's guide](CONTRIBUTING.md) provides technical details of the project.
+