Skip to content
Last updated

Rudderstack Analytics

Integrate Rudderstack Analytics into Redocly project.

Configuration

OptionTypeDescription
includeInDevelopmentbooleanSet this option to true to enable Rudderstack Analytics in development mode and preview builds. Default is false.
writeKeystringREQUIRED. Rudderstack write key
trackPagebooleanSet this to false to disable page visits tracking. Defaults to true.
dataPlaneUrlstringSet this URL if you need to proxy events through a custom data plane.
controlPlaneUrlstringSet this URL if you are self-hosting the Control Plane
sdkURLstringSet this if you want to serve SDK script from a custom domain
loadOptionsobjectRudderstack loading options described in Rudderstack documentation

Example

analytics:
  rudderstack:
    includeInDevelopment: true
    writeKey: my-write-key
    trackPage: true
    dataPlaneUrl: https://my-data-plane-url.com
    controlPlaneUrl: https://my-control-plane-url.com
    sdkUrl: https://my-custom-sdk-url.com
    loadOptions:
      secureCookie: true
      logLevel: 'INFO'
      useBeacon: true
 
Next page