otel-utils 0.1.11__tar.gz → 0.1.12__tar.gz

{otel_utils-0.1.11 → otel_utils-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: otel-utils
-Version: 0.1.11
+Version: 0.1.12
 Summary: Utilidades simplificadas para instrumentación con OpenTelemetry
 License: Proprietary
 Author: Harold Portocarrero
@@ -38,31 +38,35 @@ A Python library designed to simplify application instrumentation using OpenTele
 
 ## Installation
 
-To install the library from the private repository:
-
 ```bash
-pip install git+ssh://git@github.com/your-organization/otel-utils.git
+pip install otel-utils
 ```
 
-Or add this to your requirements.txt:
-```bash
-git+ssh://git@github.com/your-organization/otel-utils.git@v0.1.0
-```
+## Basic Usage
 
-# Basic Usage
-## Initial Configuration
+### Initial Configuration
 ```python
 from otel_utils import OtelConfig, OtelConfigurator
 
 config = OtelConfig(
     service_name="my-service",
-    environment="production"
+    environment="production",
+    otlp_endpoint="http://localhost:4318",  # Optional
+    protocol="http",                        # "http" or "grpc", default "grpc"
+    trace_sample_rate=1.0,                  # Sampling rate, default 1.0
+    metric_export_interval_ms=30000,        # Metrics export interval
+    log_level=logging.INFO,                 # Logging level
+    enable_console_logging=True,            # Enable console logging
+    additional_resources={                   # Optional additional resources
+        "deployment.region": "us-east-1",
+        "team.name": "backend"
+    }
 )
 
 OtelConfigurator(config)
 ```
 
-## Tracing
+### Tracing
 ```python
 from otel_utils import Tracer
 
@@ -80,7 +84,7 @@ with tracer.create_span("my_operation") as span:
     # Your code here
 ```
 
-## Metrics
+### Metrics
 ```python
 from otel_utils import Metrics
 
@@ -96,7 +100,7 @@ with metrics.measure_duration("request_duration"):
     pass
 ```
 
-## Structured Logging
+### Structured Logging
 ```python
 from otel_utils import StructuredLogger
 
@@ -107,15 +111,15 @@ with logger.operation_context("process_order", order_id="123"):
     # Your code here
 ```
 
-# OpenTelemetry Collector Integration
+## OpenTelemetry Collector Integration
+
 This library is designed to work seamlessly with the OpenTelemetry Collector. Telemetry data is sent using the OTLP protocol, which is the OpenTelemetry standard.
+
+### Collector Configuration with HTTP
 ```yaml
-# collector configuration example
 receivers:
   otlp:
     protocols:
-      grpc:
-        endpoint: 0.0.0.0:4317
       http:
         endpoint: 0.0.0.0:4318
 
@@ -129,20 +133,40 @@ service:
       exporters: [your-exporter]
 ```
 
-# Best Practices
-## Separation of Concerns
+### Collector Configuration with gRPC
+```yaml
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+
+exporters:
+  # configure your exporters here
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      exporters: [your-exporter]
+```
+
+## Best Practices
+
+### Separation of Concerns
 Keep instrumentation separate from business logic by creating domain-specific abstractions. Your business code should remain clean and focused on its primary responsibilities.
 
-## Consistent Naming
+### Consistent Naming
 Use coherent naming conventions for spans, metrics, and logs across your services. This makes it easier to correlate and analyze telemetry data.
 
-## Relevant Context
+### Relevant Context
 Include useful contextual information in spans and logs, but be mindful of sensitive data. Focus on information that aids debugging and monitoring.
 
-## Appropriate Granularity
+### Appropriate Granularity
 Don't instrument everything. Focus on significant operations that provide value for monitoring and debugging. Consider the overhead and noise ratio when adding instrumentation.
 
-# Development
+## Development
+
 To set up the development environment:
     
 ```bash
@@ -157,11 +181,9 @@ pip install -e ".[dev]"
 pytest
 ```
 
-# Contributing
+## Contributing
+
 1. Create a feature branch (`git checkout -b feature/new-feature`)
 2. Commit your changes (`git commit -am 'Add new feature'`)
 3. Push to the branch (`git push origin feature/new-feature`)
 4. Create a Pull Request
-
-I hope this documentation helps you understand and effectively use the OpenTelemetry Utils library. Each section is designed to guide you through the essential aspects of instrumenting your applications while maintaining clean and maintainable code.
-Let me know if you need any clarification or have questions about specific features or use cases. We can explore any aspect of the library in more detail.

{otel_utils-0.1.11 → otel_utils-0.1.12}/README.md

@@ -13,31 +13,35 @@ A Python library designed to simplify application instrumentation using OpenTele
 
 ## Installation
 
-To install the library from the private repository:
-
 ```bash
-pip install git+ssh://git@github.com/your-organization/otel-utils.git
+pip install otel-utils
 ```
 
-Or add this to your requirements.txt:
-```bash
-git+ssh://git@github.com/your-organization/otel-utils.git@v0.1.0
-```
+## Basic Usage
 
-# Basic Usage
-## Initial Configuration
+### Initial Configuration
 ```python
 from otel_utils import OtelConfig, OtelConfigurator
 
 config = OtelConfig(
     service_name="my-service",
-    environment="production"
+    environment="production",
+    otlp_endpoint="http://localhost:4318",  # Optional
+    protocol="http",                        # "http" or "grpc", default "grpc"
+    trace_sample_rate=1.0,                  # Sampling rate, default 1.0
+    metric_export_interval_ms=30000,        # Metrics export interval
+    log_level=logging.INFO,                 # Logging level
+    enable_console_logging=True,            # Enable console logging
+    additional_resources={                   # Optional additional resources
+        "deployment.region": "us-east-1",
+        "team.name": "backend"
+    }
 )
 
 OtelConfigurator(config)
 ```
 
-## Tracing
+### Tracing
 ```python
 from otel_utils import Tracer
 
@@ -55,7 +59,7 @@ with tracer.create_span("my_operation") as span:
     # Your code here
 ```
 
-## Metrics
+### Metrics
 ```python
 from otel_utils import Metrics
 
@@ -71,7 +75,7 @@ with metrics.measure_duration("request_duration"):
     pass
 ```
 
-## Structured Logging
+### Structured Logging
 ```python
 from otel_utils import StructuredLogger
 
@@ -82,15 +86,15 @@ with logger.operation_context("process_order", order_id="123"):
     # Your code here
 ```
 
-# OpenTelemetry Collector Integration
+## OpenTelemetry Collector Integration
+
 This library is designed to work seamlessly with the OpenTelemetry Collector. Telemetry data is sent using the OTLP protocol, which is the OpenTelemetry standard.
+
+### Collector Configuration with HTTP
 ```yaml
-# collector configuration example
 receivers:
   otlp:
     protocols:
-      grpc:
-        endpoint: 0.0.0.0:4317
       http:
         endpoint: 0.0.0.0:4318
 
@@ -104,20 +108,40 @@ service:
       exporters: [your-exporter]
 ```
 
-# Best Practices
-## Separation of Concerns
+### Collector Configuration with gRPC
+```yaml
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+
+exporters:
+  # configure your exporters here
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      exporters: [your-exporter]
+```
+
+## Best Practices
+
+### Separation of Concerns
 Keep instrumentation separate from business logic by creating domain-specific abstractions. Your business code should remain clean and focused on its primary responsibilities.
 
-## Consistent Naming
+### Consistent Naming
 Use coherent naming conventions for spans, metrics, and logs across your services. This makes it easier to correlate and analyze telemetry data.
 
-## Relevant Context
+### Relevant Context
 Include useful contextual information in spans and logs, but be mindful of sensitive data. Focus on information that aids debugging and monitoring.
 
-## Appropriate Granularity
+### Appropriate Granularity
 Don't instrument everything. Focus on significant operations that provide value for monitoring and debugging. Consider the overhead and noise ratio when adding instrumentation.
 
-# Development
+## Development
+
 To set up the development environment:
     
 ```bash
@@ -132,11 +156,9 @@ pip install -e ".[dev]"
 pytest
 ```
 
-# Contributing
+## Contributing
+
 1. Create a feature branch (`git checkout -b feature/new-feature`)
 2. Commit your changes (`git commit -am 'Add new feature'`)
 3. Push to the branch (`git push origin feature/new-feature`)
-4. Create a Pull Request
-
-I hope this documentation helps you understand and effectively use the OpenTelemetry Utils library. Each section is designed to guide you through the essential aspects of instrumenting your applications while maintaining clean and maintainable code.
-Let me know if you need any clarification or have questions about specific features or use cases. We can explore any aspect of the library in more detail.
+4. Create a Pull Request

{otel_utils-0.1.11 → otel_utils-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "otel-utils"
-version = "0.1.11"
+version = "0.1.12"
 description = "Utilidades simplificadas para instrumentación con OpenTelemetry"
 authors = ["Harold Portocarrero <harold@getcometa.com>"]
 readme = "README.md"