Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

Radar Agent uses a YAML configuration file. Default location is radar-agent.yml in the current directory. Use --config to specify a different file.

Basic Example

agent:
  id: radar-agent-001
  collection_interval: 60s

server:
  grpc_url: https://grpc.radar.redis.io:443  # Production Radar gRPC endpoint
  api_key: ${RADAR_API_KEY}

deployments:
  - id: redis-local
    name: Local Redis
    type: standalone
    redis_url: redis://localhost:6379

Configuration Sections

agent

Agent settings:

  • id - Unique agent identifier (required)
  • collection_interval - How often to collect (default: 60s)
  • output_directory - Directory for offline collections (default: current directory)
  • redaction_level - Default redaction level: none, credentials, all (default: all)

server

Server connection:

  • grpc_url - Radar server gRPC endpoint (required)
  • api_key - Authentication key (required)
  • timeout - Request timeout (default: 30s)

deployments

List of Redis deployments to monitor. Each deployment needs:

  • id - Unique identifier (required)
  • name - Display name (required)
  • type - Deployment type (required)

Type-specific fields vary. See Deployment Types for details.

Environment Variables

Use ${VAR} or ${VAR:-default} syntax:

server:
  api_key: ${RADAR_API_KEY}
  grpc_url: ${RADAR_SERVER:-https://grpc.radar.redis.io:443}

Further Reading