Shield360 SDK is a monitoring framework built on top of OpenTelemetry that gives your complete Observability for your AI stack, from LLMs to vector databases and GPUs, with just one line of code with tracing and metrics. It also allows you to send the generated traces and metrics to your existing monitoring tools like Grafana, New Relic, and more.
This project proudly follows and maintains the Semantic Conventions with the OpenTelemetry community, consistently updating to align with the latest standards in Observability.
- 🔎 Auto Instrumentation: Works with 50+ LLM providers, Agents, Vector databases, and GPUs with just one line of code.
- 🔭 OpenTelemetry-Native Observability SDKs: Vendor-neutral SDKs that can send traces and metrics to your existing observability tool like Prometheus and Jaeger.
- 💲 Cost Tracking for Custom and Fine-Tuned Models: Pass custom pricing files for accurate budgeting of custom and fine-tuned models.
- 🚀 Support for Shield360 Features: Includes support for prompt management and secrets management features available in Shield360.
- ✅ OpenTelemetry Collector
- ✅ Prometheus + Tempo
- ✅ Prometheus + Jaeger
- ✅ Grafana Cloud
- ✅ New Relic
- ✅ Elastic
- ✅ Middleware.io
- ✅ HyperDX
- ✅ DataDog
- ✅ SigNoz
- ✅ OneUptime
- ✅ Dynatrace
- ✅ OpenObserve
- ✅ Highlight.io
- ✅ SigLens
- ✅ Oodle
pip install shield360Open your command line or terminal and run:
pip install shield360Integrate Shield360 into your AI applications by adding the following lines to your code.
import shield360
shield360.init()Configure the telemetry data destination as follows:
| Purpose | Parameter/Environment Variable | For Sending to Shield360 |
|---|---|---|
| Send data to an HTTP OTLP endpoint | otlp_endpoint or OTEL_EXPORTER_OTLP_ENDPOINT |
"http://127.0.0.1:4318" |
| Authenticate telemetry backends | otlp_headers or OTEL_EXPORTER_OTLP_HEADERS |
Not required by default |
💡 Info: If the
otlp_endpointorOTEL_EXPORTER_OTLP_ENDPOINTis not provided, the Shield360 SDK will output traces directly to your console, which is recommended during the development phase.
Initialize using Function Arguments
Add the following two lines to your application code:
import shield360
shield360.init(
otlp_endpoint="YOUR_OTEL_ENDPOINT",
otlp_headers ="YOUR_OTEL_ENDPOINT_AUTH"
)Initialize using Environment Variables
Add the following two lines to your application code:
import shield360
shield360.init()Then, configure the your OTLP endpoint using environment variable:
export OTEL_EXPORTER_OTLP_ENDPOINT = "YOUR_OTEL_ENDPOINT"
export OTEL_EXPORTER_OTLP_HEADERS = "YOUR_OTEL_ENDPOINT_AUTH"Now that your LLM observability data is being collected and sent to configured OpenTelemetry destination, the next step is to visualize and analyze this data. This will help you understand your LLM application's performance and behavior and identify where it can be improved.
If you want to use Shield360's Observability Dashboard to monitor LLM usage—like cost, tokens, and user interactions—please check out our Quickstart Guide.
If you're sending metrics and traces to other observability tools, take a look at our Connections Guide to start using a pre-built dashboard we have created for these tools.
Below is a detailed overview of the configuration options available, allowing you to adjust Shield360's behavior and functionality to align with your specific observability needs:
| Argument | Description | Default Value | Required |
|---|---|---|---|
environment |
The deployment environment of the application. | "default" |
Yes |
application_name |
Identifies the name of your application. | "default" |
Yes |
tracer |
An instance of OpenTelemetry Tracer for tracing operations. | None |
No |
meter |
An OpenTelemetry Metrics instance for capturing metrics. | None |
No |
otlp_endpoint |
Specifies the OTLP endpoint for transmitting telemetry data. | None |
No |
otlp_headers |
Defines headers for the OTLP exporter, useful for backends requiring authentication. | None |
No |
disable_batch |
A flag to disable batch span processing, favoring immediate dispatch. | False |
No |
capture_message_content |
Enables tracing of content for deeper insights. | True |
No |
disabled_instrumentors |
List of instrumentors to disable. | None |
No |
disable_metrics |
If set, disables the collection of metrics. | False |
No |
pricing_json |
URL or file path of the pricing JSON file. | Bundled pricing.json |
No |
collect_gpu_stats |
Flag to enable or disable GPU metrics collection. | False |
No |
custom_metrics_attributes |
Custom key-value attributes applied to every metric recording. Useful for grouping metrics by custom tags (e.g., client ID, team, project). | None |
No |
Below are the parameters for use with the SDK for Shield360 Prompt Hub for prompt management:
| Parameter | Description |
|---|---|
url |
Sets the Shield360 URL. Defaults to the SHIELD360_URL environment variable. |
api_key |
Sets the Shield360 API Key. Can also be provided via the SHIELD360_API_KEY environment variable. |
name |
Sets the name to fetch a unique prompt. Use this or prompt_id. |
prompt_id |
Sets the ID to fetch a unique prompt. Use this or name. Optional |
version |
Set to True to get the prompt with variable substitution.. Optional |
shouldCompile |
Boolean value that compiles the prompt using the provided variables. Optional |
variables |
Sets the variables for prompt compilation. Optional |
meta_properties |
Sets the meta-properties for storing in the prompt's access history metadata. Optional |
Below are the parameters for use with the SDK for Shield360 Vault for secret management:
| Parameter | Description |
|---|---|
url |
Sets the Shield360 URL. Defaults to the SHIELD360_URL environment variable. |
api_key |
Sets the Shield360 API Key. Can also be provided via the SHIELD360_API_KEY environment variable. |
key |
Sets the key to fetch a specific secret. Optional |
should_set_env |
Boolean value that sets all the secrets as environment variables for the application. Optional |
tags |
Sets the tags for fetching only the secrets that have the mentioned tags assigned. Optional |
Evaluate trace attributes against the Shield360 Rule Engine to retrieve matching rules and associated entities (contexts, prompts, evaluation configurations).
| Parameter | Description |
|---|---|
url |
Sets the Shield360 URL. Defaults to the SHIELD360_URL environment variable. |
api_key |
Sets the Shield360 API Key. Can also be provided via the SHIELD360_API_KEY environment variable. |
entity_type |
Type of entity to match: "context", "prompt", or "evaluation". |
fields |
Dictionary of trace attributes to evaluate against rules. e.g. {"gen_ai.system": "openai", "gen_ai.request.model": "gpt-4"} |
include_entity_data |
If True, include full entity data in the response. Default: False. Optional |
entity_inputs |
Optional dictionary of inputs for entity resolution (e.g. prompt variables, version). |
import shield360
# Evaluate rules to get matching contexts
result = shield360.evaluate_rule(
entity_type="context",
fields={
"gen_ai.system": "openai",
"gen_ai.request.model": "gpt-4",
"service.name": "my-app",
},
include_entity_data=True,
)
if result:
print("Matching rules:", result["matchingRuleIds"])
print("Entities:", result["entities"])
# Use with evaluations:
# contexts = result.get("entity_data", {})Attach numeric, boolean, or categorical scores and user feedback to a GenAI span. When called inside an instrumented LLM request, the score auto-attaches to the active span.
| Parameter | Description |
|---|---|
name |
Score name, for example user_feedback or quality. |
value |
Numeric, boolean, or categorical score value. |
span |
Optional explicit OpenTelemetry span. |
trace_id |
Optional trace ID for async feedback against a past trace. |
span_id |
Optional span ID for async feedback against a past trace. |
comment |
Optional explanation or reviewer comment. |
idempotency_key |
Optional key to deduplicate score updates. |
metadata |
Optional dictionary of extra event attributes. |
import shield360
shield360.init()
# Thumbs up/down style feedback on the current span
shield360.log_score("user_feedback", True, comment="Helpful response")
# Numeric reviewer score
shield360.log_score("quality", 0.85, metadata={"reviewer": "human"})
# Categorical label
shield360.log_score("category", "accurate")We are dedicated to continuously improving Shield360 SDKs. Here's a look at what's been accomplished and what's on the horizon:
| Feature | Status |
|---|---|
| OpenTelmetry auto-instrumentation for LLM Providers like OpenAI, Anthropic | ✅ Completed |
| OpenTelmetry auto-instrumentation for Vector databases like Pinecone, Chroma | ✅ Completed |
| OpenTelmetry auto-instrumentation for LLM Frameworks like LangChain, LlamaIndex | ✅ Completed |
| OpenTelemetry-native auto-instrumentation for NVIDIA GPU Monitoring | ✅ Completed |
| Real-Time Guardrails Implementation | ✅ Completed |
| Programmatic Evaluation for LLM Response | ✅ Completed |
| OpenTelemetry-native AI Agent Observability | ✅ Completed |
Whether it's big or small, we love contributions 💚. Check out our Contribution guide to get started
Unsure where to start? Here are a few ways to get involved:
- Have a question or some feedback? Reach us at shield360.ai.
Your input helps us grow and improve, and we're here to support you every step of the way.
Connect with the Shield360 community and maintainers for support, discussions, and updates:
- 🌟 If you like it, Leave a star on our GitHub
- 🐞 Report bugs on our GitHub Issues to help us improve Shield360.