Skip to content

Latest commit

 

History

History
269 lines (173 loc) · 16.4 KB

README.md

File metadata and controls

269 lines (173 loc) · 16.4 KB
Raw

Build Status Release

What is RudderStack?

Short answer: RudderStack is an open-source Segment alternative written in Go, built for the enterprise. .

Long answer: RudderStack is a platform for collecting, storing and routing customer event data to dozens of tools. RudderStack is open-source, can run in your cloud environment (AWS, GCP, Azure or even your data-centre) and provides a powerful transformation framework to process your event data on the fly.

RudderStack runs as a single go binary with Postgres. It also needs the destination (e.g. GA, Amplitude) specific transformation code which are node scripts. This repo contains the core backend and the transformation modules of Rudder. The client SDKs are in a separate repo (link below).

Rudder server is released under AGPLv3 License

See the HackerNews discussion around RudderStack.

Questions? Read our Docs OR join our Discord channel. Or please email soumyadeb at rudderlabs.com.

Try RudderStack?

You can use the hosted RudderStack instance to experience the product. Click here.

Features

  1. Production Ready: Multiple companies from startups to large engerprieses are running RudderStack for collecting events.
  2. Extreme Scale: One of our largest installations is sending 300M events/day with peak of 40K req/sec via a multi-node RudderStack setup.
  3. Segment API Compatibile: RudderStack is Segment API and library compatible so don't need to change your app if you are using Segment.
  4. Cloud Destinations: Google Analytics, Amplitude, MixPanel, Adjust, AppsFlyer and dozens more destinations.
  5. Warehouse Destinations: S3, Minio, Redshift, Snowflake, Google BigQuery support.
  6. Transformations: User-specified transformation to filter/transform events.
  7. Rich UI: Written in react
  8. SDKs: Javascript, Android or iOS and server-side SDKs.
  9. Detailed Docs: Docs

Why RudderStack ?

We are building RudderStack because we believe open-source and cloud-prem is important for three main reasons

  1. Privacy & Security: You should be able to collect and store your customer data without sending everything to a 3rd party vendor or embedding proprietary SDKs. With RudderStack, the event data is always in your control. Besides, RudderStack gives you fine-grained control over what data to forward to what analytical tool.

  2. Processing Flexibility: You should be able to enhance OR transform your event data by combining it with your other internal data, e.g. stored in your transactional systems. RudderStack makes that possible because it provides a powerful JS-based event transformation framework. Furthermore, since RudderStack runs inside your cloud or on-prem environment, you can access your production data to join with the event data.

  3. Unlimited Events: Event volume-based pricing of most commercial systems is broken. You should be able to collect as much data as possible without worrying about overrunning event budgets. RudderStack's core BE is open-source and free to use.

Contribution

We would love to see people contributing to RudderStack. see CONTRIBUTING.md for more information on contributing to RudderStack.

Stay Connected

  1. Join our Discord
  2. Follow RudderStack on Twitter

UI Pages

Connections Page

image

Events Page

image

Setup Instructions (Hosted Demo Account)

  1. Go to the dashboard and set up your account.
  2. Select RudderStack Hosted Service from the top right corner after you login.
  3. Follow (Send Test Events) instructions below to send test event.

Setup Instructions (Docker)

The docker setup is the easiest & fastest way to try out RudderStack.

  1. Go to the dashboard https://app.rudderlabs.com and set up your account. Copy your workspace token from top of the home page.

    (Note) Instead of our full featured hosted UI, you can also use the open-source config-generator-UI to create the source & destination configs and pass it to RudderStack.

  2. If you have a Github account with SSH key added, then clone the repo with git clone [email protected]:rudderlabs/rudder-server.git. Move to the directory cd rudder-server and update the rudder-transformer with git submodule init && git submodule update

    (Optional) If you don't have SSH enabled Github account or prefer HTTPS, then clone the repo with git clone https://github.com/rudderlabs/rudder-server.git. Move to the directory cd rudder-server and change the rudder-transformer submodule path to HTTPS sed -i.bak 's,[email protected]:rudderlabs/rudder-transformer.git,https://github.com/rudderlabs/rudder-transformer.git,g' .gitmodules. Update the rudder-transformer with git submodule init && git submodule update

  3. Replace <your_workspace_token> in build/docker.env with the above token.

  4. (Optional) Uncomment and set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in build/docker.env if you want to add S3 as a destination on the UI.

  5. Run the command docker-compose up --build to bring up all the services.

  6. Follow (Send Test Events) instructions below to send test event.

Setup Instructions (Kubernetes)

Note: This is the recommended way of installing RudderStack for running in production. Our hosted deployment runs on Kubernetes so we maintain/patch much more frequently.

  1. Go to the [dashboard][dashboad-on] https://app.rudderlabs.com and set up your account. Copy your workspace token from top of the home page.

  2. Our helm scripts and instructions are in a separate repo - Download Here

Setup Instructions (Native Installation)

Disclaimer: This is not the recommended way of installing RudderStack. Please use this if you want to know more about the internals.

  1. Install Golang 1.13 or above. Download Here
  2. Install NodeJS 10.6 or above. Download Here
  3. Install PostgreSQL 10 or above and set up the DB. If you are on a linux distribution, you have to switch to postgres user sudo su - postgres before running the below commands.
psql -c "CREATE DATABASE jobsdb"
psql -c "CREATE USER rudder SUPERUSER"
psql "jobsdb" -c "ALTER USER rudder WITH ENCRYPTED PASSWORD 'rudder'";
psql "jobsdb" -c "GRANT ALL PRIVILEGES ON DATABASE jobsdb to rudder";

  1. Go to the dashboard and set up your account. Copy your workspace token from top of the home page

  2. If you have a Github account with SSH key added, then clone the repo with git clone [email protected]:rudderlabs/rudder-server.git. Move to the directory cd rudder-server and update the rudder-transformer with git submodule init && git submodule update

    (Optional) If you don't have SSH enabled Github account or prefer HTTPS, then clone the repo with git clone https://github.com/rudderlabs/rudder-server.git. Move to the directory cd rudder-server and change the rudder-transformer submodule path to HTTPS sed -i.bak 's,[email protected]:rudderlabs/rudder-transformer.git,https://github.com/rudderlabs/rudder-transformer.git,g' .gitmodules. Update the rudder-transformer with git submodule init && git submodule update

  3. Navigate to the transformer directory cd rudder-transformer

  4. Install dependencies npm i and start the destination transformer node destTransformer.js

  5. Navigate back to main directory cd rudder-server. Copy the sample.env to the main directory cp config/sample.env .env

  6. Update the WORKSPACE_TOKEN environment variable with the token fetched in step 4

  7. Run the backend server go run -mod=vendor main.go

  8. Follow (Send Test Events) instructions below to send test event.

Send Test Events

  1. If you already have a Google Analytics account, keep the tracking ID handy. If not, please create one and get the tracking ID. The Google Analytics account needs to have a Web Property (Web+App does't seem to work)
  2. Create one source (Android or iOS) and configure a Google Analytics destination for the same with the above tracking ID
  3. We have bundled a shell script that can generate test events. Get the source “writeKey” from our app dashboard and then run the following command. Run cd scripts; ./generate-event <writeKeyHere> http://localhost:8080/v1/batch. NOTE: writeKey is different from the your_workspace_token in step 2. Former is associated with the source while the latter is for your account.
  4. You can then login to your Google Analytics account and verify that events are delivered. Go to MainPage->RealTime->Events. RealTime view is important as the other dashboard can sometimes take 24-48 hrs to refresh.
  5. You can use our Javascript, Android or iOS SDKs for sending events from your app.

RudderStack Config Generator

Rudderstack has two components control plane and data plane. Data plane reliably delivers your event data. Control plane manages the configuration of your sources and destinations. This configuration can also be read from a file instead of from Control plane, if you don't want to use our hosted control plane.

Config-generator provides the UI to manage the source and destination configurations without needing to signup, etc. All the source and destination configuration stays on your local storage. You can export/import config to a JSON file.

Setup

  1. cd utils/config-gen
  2. npm install
  3. npm start

RudderStack config generator starts on the default port i.e., http://localhost:3000. On a successful setup, you should see the following

image

Export workspace config

After adding the required sources and destinations, export your workspace config. This workspace-config is required by the RudderStack Server. To learn more about adding sources and destinations in RudderStack, refer Adding a Source and Destination in RudderStack

Update the config variables configFromFile and configJSONPath in rudder-server to read workspace config from the exported JSON file.

Start RudderStack with the workspace config file

  • Download the workspace config file on your machine.
  • In docker-compose.yml, uncomment volumes section under backend service. Specify the path to your workspace config.
  • In build/docker.env, set the environment variable RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true

Telemetry

To help us improve RudderStack, we collect performance and diagnostic metrics about how you use it and how it's working. No customer data is present in the metrics.

The metrics collection can be disabled by setting the variable enableDiagnostics to false in config/config.toml

Following are the metrics that are being collected. They are listed in config/config.toml under the Diagnostics section.

  1. enableServerStartMetric: Tracks every time when server starts
  2. enableConfigIdentifyMetric: Tracks when the config is fetched for the first time from control-plane
  3. enableServerStartedMetric: Tracks when the server is ready to accept requests
  4. enableConfigProcessedMetric: Tracks when the config is changed
  5. enableGatewayMetric: Tracks no. of success/failed requests
  6. enableRouterMetric: Tracks no. of success/aborted/retries requests for every router destination
  7. enableBatchRouterMetric: Tracks no. of success/failed requests for every batch router destination
  8. enableDestinationFailuresMetric: Tracks destination failures

RudderStack Architecture

The following is a brief overview of the major components of RudderStack. image

RudderStack Control Plane

The UI to configure the sources, destinations etc. It consists of

Config backend: This is the backend service that handles the sources, destinations and their connections. User management and access based roles are defined here.

Customer webapp: This is the front end application that enables the teams to set up their customer data routing with RudderStack. These will show you high-level data on event deliveries and more stats. It also provides access to custom enterprise features.

RudderStack Data Plane

Data plane is our core engine that receives the events, stores, transforms them and reliably delivers to the destinations. This engine can be customized to your business requirements by a wide variety of configuration options. Eg. You can choose to enable backing up events to an S3 bucket, the maximum size of the event for the server to reject malicious requests. Sticking to defaults will work well for most of the companies but you have the flexibility to customize the data plane.

The data plane uses Postgres as the store for events. We built our streaming framework on top of Postgres – that’s a topic for a future blog post. Reliable delivery and order of the events are the first principles in our design.

RudderStack Destination Transformation

Conversion of events from RudderStack format into destination-specific format is handled by the transformation module. The transformation codes are written in Javascript. I

The following blogs provide an overview of our transformation module

https://rudderlabs.com/transformations-in-rudder-part-1/

https://rudderlabs.com/transformations-in-rudder-part-2/

If you are missing a transformation, please feel free to add it to the repository.

RudderStack User Transformation

RudderStack also supports user-specific transformations for real-time operations like aggregation, sampling, modifying events etc. The following blog describes one real-life use case of the transformation module

https://rudderlabs.com/customer-case-study-casino-game/

Client SDKs

The client SDKs provide APIs collecting events and sending it to the RudderStack Backend.

Coming Soon

  1. More performance benchmarks. On a single m4.2xlarge, RudderStack can process ~3K events/sec. We will evaluate other instance types and publish numbers soon.
  2. More documentation
  3. More destination support
  4. HA support
  5. More SDKs (or Segment compatibility)