Grafana Cloud

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

1. Get your Credentials

1. Sign in to Grafana Cloud Portal and select your Grafana Cloud Stack.
2. Click Configure in the OpenTelemetry section.
3. In the Password / API Token section, click on Generate now to create a new API token:
   • Give the API token a name, for example shield360
   • Click on Create token
   • Click on Close without copying the token
   • Copy and Save the value for OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS

     Note

     Replace the space after Basic with %20: OTEL_EXPORTER_OTLP_HEADERS=“Authorization=Basic%20[base64 instanceID:token]”
     

2. Instrument your application

SDK

For direct integration into your Python applications:

Function Arguments

import shield360

shield360.init(
  otlp_endpoint="YOUR_GRAFANA_OTEL_GATEWAY_URL",
  otlp_headers="YOUR_GRAFANA_OTEL_GATEWAY_AUTH"
)

Replace:

1. YOUR_GRAFANA_OTEL_GATEWAY_URL with the OTEL_EXPORTER_OTLP_ENDPOINT value you copied in Step 1.
   • Example: https://otlp-gateway-<zone>.grafana.net/otlp
2. YOUR_GRAFANA_OTEL_GATEWAY_AUTH with the OTEL_EXPORTER_OTLP_HEADERS value you copied in Step 1.
   • Example: Authorization=Basic%20<base64 encoded Instance ID and API Token>

Environment Variables

import shield360

shield360.init()

Set these environment variables:

export OTEL_EXPORTER_OTLP_ENDPOINT="YOUR_GRAFANA_OTEL_GATEWAY_URL"
export OTEL_EXPORTER_OTLP_HEADERS="YOUR_GRAFANA_OTEL_GATEWAY_AUTH"

Replace:

1. YOUR_GRAFANA_OTEL_GATEWAY_URL with the OTEL_EXPORTER_OTLP_ENDPOINT value you copied in Step 1.
   • Example: https://otlp-gateway-<zone>.grafana.net/otlp
2. YOUR_GRAFANA_OTEL_GATEWAY_AUTH with the OTEL_EXPORTER_OTLP_HEADERS value you copied in Step 1.
   • Example: Authorization=Basic%20<base64 encoded Instance ID and API Token>

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 "YOUR_GRAFANA_OTEL_GATEWAY_URL" \
  --otlp-headers "YOUR_GRAFANA_OTEL_GATEWAY_AUTH" \
  --service-name "my-ai-service" \
  --deployment-environment "production" \
  python app.py

Replace:

1. YOUR_GRAFANA_OTEL_GATEWAY_URL with the OTEL_EXPORTER_OTLP_ENDPOINT value you copied in Step 1.
   • Example: https://otlp-gateway-<zone>.grafana.net/otlp
2. YOUR_GRAFANA_OTEL_GATEWAY_AUTH with the OTEL_EXPORTER_OTLP_HEADERS value you copied in Step 1.
   • Example: Authorization=Basic%20<base64 encoded Instance ID and API Token>

Environment Variables

# Set environment variables (takes precedence over CLI args)
export OTEL_EXPORTER_OTLP_ENDPOINT="YOUR_GRAFANA_OTEL_GATEWAY_URL"
export OTEL_EXPORTER_OTLP_HEADERS="YOUR_GRAFANA_OTEL_GATEWAY_AUTH"
export OTEL_SERVICE_NAME="my-ai-service"
export OTEL_DEPLOYMENT_ENVIRONMENT="production"

# Run your application
shield360-instrument python app.py

Replace:

1. YOUR_GRAFANA_OTEL_GATEWAY_URL with the OTEL_EXPORTER_OTLP_ENDPOINT value you copied in Step 1.
   • Example: https://otlp-gateway-<zone>.grafana.net/otlp
2. YOUR_GRAFANA_OTEL_GATEWAY_AUTH with the OTEL_EXPORTER_OTLP_HEADERS value you copied in Step 1.
   • Example: Authorization=Basic%20<base64 encoded Instance ID and API Token>

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

3. Import the pre-built Dashboard

1. Log into your Grafana Cloud Instance.
2. Click Dashboards in the primary menu.
3. Click New and select Import in the drop-down menu.
4. Copy the dashboard JSONs provided in the offical Grafana AI Observability repository
5. Paste the dashboard JSONs one by one directly into the text area.
6. Click Import.
7. Save the dashboard.