HyperDX

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

1. Get your Credentials

1. Sign in to your HyperDX account
2. Get your API Key:
   • Navigate to your HyperDX settings or API keys section
   • Generate or copy your existing API key
   • Example format: x6xx7265-43x3-476x-1112-x9x52x29xxxx

2. Configure OpenTelemetry Collector

HyperDX requires an OpenTelemetry Collector as an intermediary to receive and forward telemetry data.

Install OpenTelemetry Collector (if not already running)

For detailed installation instructions, refer to the OpenTelemetry Collector Documentation.

Configure the Collector

1. Configure HTTP Receiver: In the receivers section, ensure the otlp receiver is set with endpoint: 0.0.0.0:4318.
2. Define HyperDX Exporter: Add otlphttp/hdx exporter to send data to HyperDX.
3. Assign to Pipelines: Link the exporter to traces and metrics pipelines.

Complete Collector Configuration

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  batch:
  memory_limiter:
    # 80% of maximum memory up to 2G
    limit_mib: 1500
    # 25% of limit up to 2G
    spike_limit_mib: 512
    check_interval: 5s

exporters:
  otlphttp/hdx:
    endpoint: 'https://in-otel.hyperdx.io'
    headers:
      authorization: YOUR_HYPERDX_API_KEY_HERE
    compression: gzip

service:
  pipelines:
    traces:
      receivers: [ otlp ]
      processors: [ memory_limiter, batch ]
      exporters: [ otlphttp/hdx ]
    metrics:
      receivers: [ otlp ]
      processors: [ memory_limiter, batch ]
      exporters: [ otlphttp/hdx ]

Replace YOUR_HYPERDX_API_KEY_HERE with your actual HyperDX API Key.

3. Instrument your application

SDK

For direct integration into your Python applications:

Function Arguments

import shield360

shield360.init(
  otlp_endpoint="YOUR_OTELCOL_URL:4318"
)

Replace:

1. YOUR_OTELCOL_URL:4318 with the URL HTTP endpoint of your OpenTelemetry Collector.
   • Example: http://127.0.0.1:4318 (for local collector)
   • Example: http://otel-collector.default.svc.cluster.local:4318 (for Kubernetes)

Environment Variables

import shield360

shield360.init()

Set these environment variables:

export OTEL_EXPORTER_OTLP_ENDPOINT="YOUR_OTELCOL_URL:4318"

Replace:

1. YOUR_OTELCOL_URL:4318 with the URL HTTP endpoint of your OpenTelemetry Collector.
   • Example: http://127.0.0.1:4318 (for local collector)
   • Example: http://otel-collector.default.svc.cluster.local:4318 (for Kubernetes)

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_OTELCOL_URL:4318" \
  --service-name "my-ai-service" \
  --deployment-environment "production" \
  python app.py

Replace:

1. YOUR_OTELCOL_URL:4318 with the URL HTTP endpoint of your OpenTelemetry Collector.
   • Example: http://127.0.0.1:4318 (for local collector)
   • Example: http://otel-collector.default.svc.cluster.local:4318 (for Kubernetes)

Environment Variables

# Set environment variables (takes precedence over CLI args)
export OTEL_EXPORTER_OTLP_ENDPOINT="YOUR_OTELCOL_URL:4318"
export OTEL_SERVICE_NAME="my-ai-service"
export OTEL_DEPLOYMENT_ENVIRONMENT="production"

# Run your application
shield360-instrument python app.py

Replace:

1. YOUR_OTELCOL_URL:4318 with the URL HTTP endpoint of your OpenTelemetry Collector.
   • Example: http://127.0.0.1:4318 (for local collector)
   • Example: http://otel-collector.default.svc.cluster.local:4318 (for Kubernetes)

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

4. Import the pre-built Dashboard

You can directly import a pre-built GenAI Observability dashboard using this URL:

Import HyperDX Dashboard

This is an unsaved dashboard URL. When you click on it, the dashboard will open in your own HyperDX instance. You can then choose to save it, and it will be added to your HyperDX instance.