Skip to content
Volidator Docs

Telemetry Presets

TelemetryConfig.preset sets a default policy for IP, user-agent, and location collection across all log calls. Individual fields in the config override the preset.

Preset comparison

Section titled “Preset comparison”
Field strict standard full
IP Not collected HMAC hash (anonymized) Raw IP address stored
User-Agent Not collected Parsed to browser + OS + device type Raw string stored + parsed
Country Not collected Stored Stored
Region Not collected Stored Stored
City Not collected Not collected Stored

Field override behavior

Section titled “Field override behavior”

Set individual fields to override the preset for that dimension only.

// Standard preset, but track raw IP
const volidator = new VolidatorClient({
  apiKey: '...',
  encryptionKey: '...',
  telemetry: {
    preset: 'standard',
    ip: 'track',   // overrides the 'anonymize' default from standard
  },
});

Individual field values:

Field Accepted values
ip 'track', 'anonymize', 'skip'
userAgent 'track', 'parse', 'skip'
location true, false

Choosing a preset

Section titled “Choosing a preset”

Use strict when:

  • Your product operates under HIPAA or similar regulations that restrict metadata collection.
  • You want a minimal compliance surface area.

Use standard when:

  • You want geo and device analytics without storing raw PII.
  • You need to correlate events from the same IP without storing the IP itself.

Use full when:

  • You have an explicit legal basis for storing raw IPs and user-agents.
  • You are doing fraud detection or security investigations.
Section titled “Related”