Skip to main content

Telemetry

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.

Why Remotion has telemetry​

Remotion is free for individuals and small companies but requires a paid license for bigger companies. The price depends on the amount of renders.

Telemetry makes it easier to track renders and ensure accountability.
We do not use telemetry for any other purposes than ensuring proper licensing.

Telemetry in server-side rendering​

Server-side rendering APIs only send telemetry when the licenseKey option is set, and only for successful renders:

Telemetry in client-side rendering​

Client-side rendering APIs always send a telemetry event for every render, even if no licenseKey is set:

An event is sent whether the render succeeded or failed.
If the render is aborted, no event is sent.

Obligation to set a license key​

In Remotion 5.0, it becomes obligatory for companies which are under the "Remotion for Automators" plan to set the licenseKey field and opt into telemetry.

Customers who cannot enable telemetry due to company policy must arrange an alternative reporting method with Remotion.

Sent information​

The following information is sent:

  • License key (if set)
  • IP address of the machine triggering the render
  • Whether this render was a video or a still image
  • Whether this render was in production or development

For client-side rendering, the following additional information is sent:

  • Domain name (e.g. https://www.remotion.dev) - the value of window.location.origin of the page performing the render. Server-side rendering does not send a domain name.
  • Whether the render succeeded or failed - server-side rendering only sends events for successful renders.

No content or metadata of the video rendered, or any user data is collected.

note

If you utilize client-side rendering, the end user's IP address is transmitted to Remotion strictly for license verification and billing metrics. You should ensure your app's privacy policy reflects that limited operational telemetry is shared with technical service providers under Legitimate Interest.

Setting a license key​

If you qualify for the free license, pass "free-license" to licenseKey to declare your eligibility for the free license.
For client-side rendering, this also disables the warning in the console.

If you have a Remotion Company License or Enterprise License, go to remotion.pro and get your license key from the License keys page.

For tracking server-side renders, you should use the private key.

Pass the licenseKey option to renderMedia(), renderStill() or the equivalent APIs of @remotion/lambda and @remotion/vercel:

Declare eligibility for the free license
await renderMedia({
  composition,
  serveUrl,
  codec: 'h264',
  outputLocation,
  inputProps,
  licenseKey: 'free-license',
});
Set a license key
await renderMedia({
  composition,
  serveUrl,
  codec: 'h264',
  outputLocation,
  inputProps,
  licenseKey: 'rm_sec_abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
});

Tracking usage​

After you set up the license key, you can now track your usage on the same Usage tab.

Usage is not (yet) tied to billing.
You will need to update your render count manually periodically to reflect your usage.

To check the usage programmatically, for example to implement spend controls, use getUsage() from the @remotion/licensing package.

Data retention​

Telemetry data is currently retained indefinitely and is not regularly deleted.
It is not shared with any third parties and is only used internally by Remotion for license accountability.

See also​