Chapter 416: Telemetry

Core Idea

Remotion sometimes sends telemetry that reports when a render has been made, using the @remotion/licensing package. Telemetry never blocks or fails a render - even if the telemetry request fails, the render will still complete successfully.

Key Concepts

• Why Remotion has telemetry
• Telemetry in server-side rendering
• Telemetry in client-side rendering
• Obligation to set a license key
• Sent information
• Setting a license key
• Tracking usage
• Data retention

Code Examples

const serveUrl = '/path/to/bundle';
const outputLocation = '/path/to/video.mp4';

const inputProps = {};

const composition = await selectComposition({
  serveUrl,
  id: 'my-video',
  inputProps,
});

await renderMedia({
  composition,
  serveUrl,
  codec: 'h264',
  outputLocation,
  inputProps,
  licenseKey: 'free-license',
});

• What it demonstrates: Usage pattern for Telemetry from the official docs.

Key Takeaways

1. Understand why remotion has telemetry when working with Telemetry.
2. Understand telemetry in server-side rendering when working with Telemetry.
3. Understand telemetry in client-side rendering when working with Telemetry.
4. Understand obligation to set a license key when working with Telemetry.
5. Understand sent information when working with Telemetry.

Connects To

• Accessibility: related page in the Legal, Meta & Support section.
• dev: related page in the Legal, Meta & Support section.
• pro: related page in the Legal, Meta & Support section.