Giter Club home page Giter Club logo

rum-events-format's Introduction

rum-events-format

JSON schema of RUM events send by SDKs

Guidelines

The format must stay backward compatible in order to be able to validate old events, so:

  • New fields must not be set as required
  • Fields definition must not be updated, new fields must be created instead

Breaking changes to the format must be reflected by a major version update in _dd.format_version property.

After editing any schema, you must re-generate the JS + TS definitions (see below).

Consuming this repository

Consuming projects are encouraged to use a yarn github reference as dependency, e.g:

yarn add rum-events-format@DataDog/rum-events-format#workspace=rum-events-format

Updating to the latest change is possible with yarn up, e.g:

yarn up rum-events-format@DataDog/rum-events-format#workspace=rum-events-format

It is also possible to specify the exact commit hash to use, e.g:

yarn up "rum-events-format@DataDog/rum-events-format#workspace=rum-events-format&commit=COMMIT-HASH"

Tools

Prerequisite: install dependencies

yarn

Validate samples

yarn validate

Build JS sources + TS definitions

yarn build

Generate TS definitions out of the schemas

yarn generate

Prettify TS & JSON files

yarn format -w

External tools

Generate schema from sample

https://jsonschema.net/

rum-events-format's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.