SigNoz

To directly send OpenTelemetry metrics and traces generated by Shield360 from your AI Application to SigNoz, follow the below steps.

1. Get your Credentials

SigNoz configuration requires two values:

1. SigNoz Endpoint: Your SigNoz instance endpoint URL

   • SigNoz Cloud: https://ingest.{region}.signoz.cloud:443
   • Self-Hosted: http://your-signoz-host:4318 (or your custom endpoint)

2. Ingestion Key: Your SigNoz access token for authentication

   • SigNoz Cloud: Available in your SigNoz Cloud settings → Ingestion Keys
   • Self-Hosted: Set up according to your SigNoz deployment configuration

Note

For SigNoz Cloud users, you can find your specific endpoint and ingestion key in your SigNoz Cloud dashboard under Settings → Ingestion Keys.

2. Instrument your application

SDK

For direct integration into your Python applications:

Function Arguments

import shield360

shield360.init(
  otlp_endpoint="SIGNOZ_ENDPOINT",
  otlp_headers="signoz-access-token=SIGNOZ_INGESTION_KEY"
)

Replace:

1. SIGNOZ_ENDPOINT with your SigNoz endpoint URL.
   • Example: https://ingest.{region}.signoz.cloud:443
2. SIGNOZ_INGESTION_KEY with the access token provided by SigNoz.
   • Example: 896cc137-xxxx-xxxx-b8a0-a6d7ab65f274

Environment Variables

import shield360

shield360.init()

Set these environment variables:

export OTEL_EXPORTER_OTLP_ENDPOINT="SIGNOZ_ENDPOINT"
export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token=SIGNOZ_INGESTION_KEY"

Replace:

1. SIGNOZ_ENDPOINT with your SigNoz endpoint URL.
   • Example: https://ingest.{region}.signoz.cloud:443
2. SIGNOZ_INGESTION_KEY with the access token provided by SigNoz.
   • Example: 896cc137-xxxx-xxxx-b8a0-a6d7ab65f274

Refer to the Shield360 SDK configuration reference for more advanced configurations and use cases.

CLI

For zero-code auto-instrumentation via command line:

CLI Arguments

# Using CLI arguments
shield360-instrument \
  --otlp-endpoint "SIGNOZ_ENDPOINT" \
  --otlp-headers "signoz-access-token=SIGNOZ_INGESTION_KEY" \
  --service-name "my-ai-service" \
  --deployment-environment "production" \
  python app.py

Replace:

1. SIGNOZ_ENDPOINT with your SigNoz endpoint URL.
   • Example: https://ingest.{region}.signoz.cloud:443
2. SIGNOZ_INGESTION_KEY with the access token provided by SigNoz.
   • Example: 896cc137-xxxx-xxxx-b8a0-a6d7ab65f274

Environment Variables

# Set environment variables (takes precedence over CLI args)
export OTEL_EXPORTER_OTLP_ENDPOINT="SIGNOZ_ENDPOINT"
export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token=SIGNOZ_INGESTION_KEY"
export OTEL_SERVICE_NAME="my-ai-service"
export OTEL_DEPLOYMENT_ENVIRONMENT="production"

# Run your application
shield360-instrument python app.py

Replace:

1. SIGNOZ_ENDPOINT with your SigNoz endpoint URL.
   • Example: https://ingest.{region}.signoz.cloud:443
2. SIGNOZ_INGESTION_KEY with the access token provided by SigNoz.
   • Example: 896cc137-xxxx-xxxx-b8a0-a6d7ab65f274

Refer to the Shield360 SDK configuration reference for more advanced configurations and use cases.

3. Explore your telemetry

After telemetry arrives, use SigNoz’s query builder and dashboard tools to create views that fit your application and deployment.