• Stars
    star
    1,560
  • Rank 29,997 (Top 0.6 %)
  • Language
    CoffeeScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A web platform for constructing dashboards.

Cyclotron

πŸ“» News and updates

Cyclotron is no longer being maintained. The tech stack is over a decade old and has not aged well, so it basically needs a complete rewrite to modernize it. Feel free to fork and continue development.

About

Cyclotron is a browser-based platform for creating dashboards. It provides standard boilerplate and plumbing, allowing non-programmers to easily create and edit dashboards using customizable components. It has a built-in dashboard editor, and hosts the dashboards directly.

Dashboards are defined declaratively as a JSON document, which contains all the properties required to render the Dashboard.

Contents

Key Concepts

  • Dashboard: a series of Pages, as well as Data Sources, Scripts, Styles, and other configurations; stored as a JSON document, it contains all the properties required to render itself

  • Page: one or more Widgets combined in various sizes and layout; one Page is displayed at a time

  • Widget: reusable component that displays on the Dashboard; different types are available

  • Data Source: reusable component that retrieves data for use by Widgets; different types are available

Features

  • Declarative definition of Dashboards, requiring no HTML or JavaScript (although it's optionally available)

  • Included Widgets: Annotation Chart, Chart, Header, HTML, iFrame, Image, Javascript, JSON, Number, QRCode, Stoplight, Table, Treemap, Youtube

  • Included Data Sources: CyclotronData, Elasticsearch, Graphite, InfluxDB, Javascript, JSON, Prometheus, Splunk

  • Built-in data loading, filtering, and sorting

  • LDAP/Active Directory Integration

  • Permissions for viewing and editing Dashboards

  • Built-in analytics for Dashboards

  • Mobile support

  • REST API access

Should I Use Cyclotron?

Cyclotron is best thought of as an alternative to custom, light-weight websites that visualize data. It provides the web hosting, page layout, data loading, and assorted widgetsβ€”all without writing code. In contrast, building a comparable website from scratch would require provisioning a server/VM, choosing the appropriate web frameworks and libraries, and writing the code for the site. Cyclotron simplifies this process dramatically, making it ideal for rapid prototyping.

However, Cyclotron has a limited set of built-in Widgets and Data Sources. The HTML and JavaScript Widgets do allow for a wide degree of customization, but require some web development. Cyclotron lacks built-in interactivity, so it may not be ideal for building highly interactive websites. Additionally, it is designed for building full-screen dashboards, not reports.

In regards to data, Cyclotron does not store or cache any data for Dashboards. Dashboards can load external data through various Data Sources, but it is done on-the-fly when Dashboards are viewed. Cyclotron can do filtering/sorting and custom transformations, but this should not be considered a replacement for ETL jobs. In this regard, Cyclotron is ideal as a front-end for an existing database or web service.

Requirements

  • Node.js
    • Requires >= 6.x to run cyclotron-site tests
    • Requires >= 0.10 to run
  • MongoDB (2.6+)
  • (Optional) Any web server--Nginx, Apache, IIS, etc

Node.js and MongoDB are available on Linux, OS X, and Windows, so it should be possible to run Cyclotron on any of these platforms, although the specific steps may vary.

MongoDB 2.6 or above is required to use all functionality of the service.

Installation

These installation instructions are primarily intended for development and testing purposes. Refer to the Deployment section for more details on server deployment.

Start by cloning this git repository locally onto your computer. If you don't have git installed, GitHub has a nice guide: Set Up Git. On Windows, GitHub for Windows is an easy way to install git.

Alternatively, download a ZIP archive of the repository contents and extract it.

MongoDB

Install MongoDB according to the installation instructions for your system. Cyclotron automatically creates the MongoDB database on startup MongoDB server, so no other configuration needs to be done.

MongoDB does not have to be installed on the same system as the Cyclotron website or service, as long as the connection property is updated accordingly. Replica sets and authentication are also supported.

Ensure MongoDB is running before continuing:

mongod --config /usr/local/etc/mongod.conf

Node.js

Install the latest stable version of Node.js for your system. This should install npm as well.

Packages may be available separately for your system, depending on the OS and package manager.

REST API

The cyclotron-svc/ folder contains the REST API for Cyclotron, which interfaces with MongoDB.

  1. Open the cyclotron-svc/ folder in the shell

  2. Install dependencies using npm:

     npm install
    

    Windows: this may need to be run as an Administrator. Open the Node.js Command Prompt as an Administrator and run the command there.

    Windows/OSX/Linux: node-gyp may require certain dependencies to be installed. See platform-specific instructions here.

  3. Create a configuration file at cyclotron-svc/config/config.js. A sample configuration file sample.config.js is provided:

     cp config/sample.config.js config/config.js
    

    The sample config defaults to using a local MongoDB instance, with authentication disabled. If using a remote MongoDB server or cluster, update the mongodb property accordingly.

    If using Active Directory or LDAP, ensure that the property enableAuth is set to true, and that all the ldap properties are filled in correctly, including the service account username and password used to validate logins.

  4. Start the service in node:

     node app.js
    
  5. To verify the service is running, open the API documentation in a browser at http://localhost:8077

For more information on the REST API and its configuration, please refer to cyclotron-svc/README.md.

Website

The cyclotron-site/ folder contains the website for Cyclotron.

  1. Open the cyclotron-site/ folder in the shell

  2. Install all dependencies using npm:

     npm install
    

    Windows: this may need to be run as an Administrator. Open the Node.js Command Prompt as an Administrator and run the command there.

  3. Install Gulp globally. This is the build system for the website, and only has to be done once.

     npm install --global gulp
    

    Windows/Linux/OSX: this may need to be run as an Administrator or with sudo privileges.

  4. Build and run the service:

     gulp server
    

    This compiles the website into the _public folder and starts a local development web server. The website should automatically open: http://localhost:8080.

    "unable to connect to github.com": this may be due to a firewall blocking the git:// protocol. Run this:

     git config --global url."https://".insteadOf git://
    

    Windows: Git must be in the PATH to successfully build the website; if using GitHub for Windows, just open the Git Shell which automatically adds it.

  5. Update the configuration file at _public/js/conf/configService.js as needed. Gulp automatically populates this file from sample.configService.js if it does not exist.

    The sample config defaults to using a local cyclotron-svc instance, with authentication disabled. If authentication has been enabled in the REST API, it must be enabled in this config as well.

For more information on the Cyclotron website, please refer to cyclotron-site/README.md.

Docker

A Dockerfile and docker-compose.yml example can be found here: https://github.com/baumandm/cyclotron-docker.

Deployment

For specific details on deployment, please refer to cyclotron-site/README.md and cyclotron-svc/README.md.

Extending Cyclotron

More information on extending Cyclotron is available in EXTENDING.md

Contributing

We gladly accept contributions to Cyclotron in the form of issues, feature requests, and pull requests! Check out CONTRIBUTING.md for more information.

Licensing

Copyright Β© 2015-2021 Expedia, Inc.

Cyclotron is licensed under the MIT license; refer to LICENSE for the complete text.

Cyclotron has a dependency on Highcharts, a commercial JavaScript charting library. Highcharts offers both a commercial license as well as a free non-commercial license. Please review the licensing options and terms before using this software, as the Cyclotron license neither provides nor implies a license for Highcharts.

The only feature depending on Highcharts is the Chart widget, so both can be removed if necessary.

More Repositories

1

graphql-kotlin

Libraries for running GraphQL in Kotlin
Kotlin
1,732
star
2

waggle-dance

Hive federation service. Enables disparate tables to be concurrently accessed across multiple Hive deployments.
Java
266
star
3

styx

Programmable, asynchronous, event-based reverse proxy for JVM.
Java
253
star
4

adaptive-alerting

Anomaly detection for streaming time series, featuring automated model selection.
Java
202
star
5

jenkins-spock

Unit-test Jenkins pipeline code with Spock
Groovy
187
star
6

bull

BULL - Bean Utils Light Library
Java
185
star
7

c3vis

Visualize the resource utilisation of Amazon ECS clusters
JavaScript
165
star
8

jarviz

Jarviz is dependency analysis and visualization tool designed for Java applications
Java
133
star
9

stream-registry

Stream Discovery and Stream Orchestration
Java
122
star
10

flyte

Flyte binds together the tools you use into easily defined, automated workflows
Go
88
star
11

circus-train

Circus Train is a dataset replication tool that copies Hive tables between clusters and clouds.
Java
86
star
12

kubernetes-sidecar-injector

Kuberbetes mutating webhook that injects a sidecar container to a pod
Go
76
star
13

expediagroup.github.io

The Expedia Group Open Source portal, a website for discovering EG open source projects.
JavaScript
64
star
14

mittens

Warm-up routine for http applications over REST and gRPC
Go
64
star
15

avro-compatibility

A user friendly API for checking for and reporting on Avro schema incompatibilities.
Java
59
star
16

graphql-component

Composeable graphql components
JavaScript
55
star
17

heat

Heat Test Framework
Java
45
star
18

beekeeper

Service for automatically managing and cleaning up unreferenced data
Java
45
star
19

pitchfork

Convert tracing data between Zipkin and Haystack formats
Java
44
star
20

container-startup-autoscaler

A Kubernetes controller that modifies the CPU and/or memory resources of containers depending on whether they're starting up, according to the startup/post-startup settings you supply.
Go
37
star
21

apiary

Apiary provides modules which can be combined to create a federated cloud data lake
36
star
22

github-helpers

A collection of Github Actions that simplify and standardize common CI/CD workflow tasks.
TypeScript
35
star
23

pino-rotating-file

[DEPRECATED] A pino log transport for splitting logs into separate, automatically rotating files.
JavaScript
33
star
24

javro

JSON Schema to Avro Mapper
JavaScript
29
star
25

rhapsody

Reactive Streams framework with support for at-least-once processing
Java
29
star
26

vsync

Sync Secrets between HashiCorp vaults
Go
29
star
27

kube-graffiti

Paint your kubernetes objects with 'mutating' webhooks
Go
26
star
28

hiveberg

Demonstration of a Hive Input Format for Iceberg
Java
26
star
29

plunger

A unit testing framework for the Cascading data processing platform.
Java
25
star
30

beeju

JUnit integration for testing the Apache Hive Metastore and HiveServer2 Thrift APIs
Java
24
star
31

react-event-tracking

React shared context utilities for analytic event tracking.
JavaScript
23
star
32

expediagroup.github.io-old

Expedia Group OSS Portal
HTML
22
star
33

shunting-yard

Shunting Yard is a real-time data replication tool that copies data between Hive Metastores.
Java
20
star
34

jasvorno

A library for strong, schema based conversion between 'natural' JSON documents and Avro
Java
18
star
35

apiary-data-lake

Terraform scripts for deploying Apiary Data Lake
HCL
18
star
36

datasqueeze

Hadoop utility to compact small files
Java
18
star
37

hello-streams

hello-streams :: Introducing the stream-first mindset
Java
17
star
38

map-maker

Map maker is a command line tool and library for easily generating maps from structured data.
Jupyter Notebook
15
star
39

spinnaker-pipeline-trigger

Pipeline trigger for Spinnaker utilizing SNS
TypeScript
15
star
40

corc

An ORC File Scheme for the Cascading data processing platform.
Java
14
star
41

steerage

[DEPRECATED] Hapi server configuration and composition using confidence, topo, and shortstop.
JavaScript
14
star
42

fpsmeter

Optimized javascript utility for measuring frames per second in a browser environment. Useful for observing end-user client run-time performance without adversly impacting performance.
JavaScript
14
star
43

insights-explorer

Insights Explorer is a tool to catalogue and present analytical & research work.
TypeScript
13
star
44

molten

Molten is an opinionated library providing reactive tooling to simplify building production-ready integration solutions using Reactor.
Java
13
star
45

service-client

[DEPRECATED] A general purpose http client built with extensibility in mind. It also features lifecycle hooks, dynamic hostname resolution, and circuit breaking.
JavaScript
12
star
46

github-webhook-proxy

Request forwarder for GitHub webhooks from github.com to internal enterprise destinations, designed for use in Github Enterprise Cloud.
TypeScript
10
star
47

apiary-extensions

Extensions available for use in Apiary
Java
10
star
48

drone-fly

A service which allows Hive Metastore Listeners to be deployed outside of the Hive Metastore Service
Java
10
star
49

secrets-injector

Go
9
star
50

neaps

a simulator to forecast the end of agile project basing on historical data and using montecarlo simulations
JavaScript
9
star
51

cypress-codegen

A Cypress plugin which automatically adds and enables IntelliSense for your custom commands!
TypeScript
9
star
52

circus-train-bigquery

Circus Train plugin which replicates BigQuery tables to Hive
Java
8
star
53

quibble

Data validator tool to allows testers, developers and analysts to define and execute test-cases involving data. Quibble is able to compare data from one or more data platforms, assert on the outcome and produce generated report output on any anomalies in data.
Java
8
star
54

dr-shadow

Dr Shadow is a library developed by Egencia (part of Expedia Group) that enables shadow traffic (ie. mirroring). It is a valuable tool for having good hygiene for service operations (ie. testing, resiliency, performance).
Java
6
star
55

flyte-client

A Go library designed to make the writing of flyte packs simple
Go
6
star
56

catalyst-server

[DEPRECATED] Configuration and composition management for Hapi.js applications.
JavaScript
6
star
57

comparadise

A visual comparison tool for reviewing visual changes on frontend PRs.
TypeScript
6
star
58

hello-cloud

hello world example for Multicloud applications
HTML
6
star
59

two-tower-lodging-candidate-generation

Python
6
star
60

aws-adfs-login

Library for user login (client side) using AWS ADFS (Active Directory Federation Service)
Go
5
star
61

apiary-federation

Terraform scripts for deploying Apiary Data Lake federation
HCL
5
star
62

apiary-metastore-docker

Docker image for Apiary Data Lake metastore
Shell
5
star
63

apiary-ranger-docker

Docker image for Apiary Data Lake Ranger
Shell
4
star
64

flyte-jira

An Atlassian Jira integration pack for Flyte
Go
4
star
65

pkdd22-challenge-expediagroup

Expedia Group ECML/PKDD 2022 challenge
Python
4
star
66

kafka-consumer-sns-sqs

Kafka Consumer for AWS SNS/SQS
Python
4
star
67

catalyst-render

[DEPRECATED] A hapi js plugin that works with catalyst-server to provide server-side rendering with react inside a handlebars template
JavaScript
4
star
68

nimbuild

A suite of build tools that enable ultra fast web bundling at run-time.
JavaScript
4
star
69

circus-train-datasqueeze

Circus Train ⨉ DataSqueeze
Java
4
star
70

data-highway

Java
4
star
71

expediagroup-python-sdk

Open World SDK for Python
Python
4
star
72

flyte-bamboo

An Atlassian Bamboo integration pack for Flyte
Go
4
star
73

apiary-lifecycle

Terraform deployment scripts for Beekeeper
HCL
4
star
74

housekeeping

Common functionality for managing and cleaning up orphaned paths
Java
3
star
75

icf

Independent connectivity forum API and tools
3
star
76

expediagroup-java-sdk

Expedia Group Java SDK Home
Kotlin
3
star
77

hcommon-hive-metastore

General purpose libraries for interacting with the HiveMetaStore
Java
3
star
78

flyte-shell

Run shell scripts in your Flyte flows with this integration pack
Go
3
star
79

apiary-authorization

Authorization for Apiary Data Lake
HCL
3
star
80

package-json-validator

A Github Action for validating package.json conventions.
TypeScript
3
star
81

flyte-serf

A Hashicorp Serf integration pack for Flyte
Go
3
star
82

network-plugin

The Network plugin allows developers to proxy requests and view the request and responses in IntelliJ.
Kotlin
3
star
83

rapid-java-sdk

ExpediaGroup - Rapid Java SDK Home
Kotlin
3
star
84

a11y-tools

Client side A11y tools for trapping and tracking user focus.
JavaScript
2
star
85

flyte-ldap

An LDAP integration pack for Flyte
Go
2
star
86

new-project

This repository contains a template you can use to seed a repository for a new open source project.
2
star
87

expediagroup-nodejs-sdk

Expedia Group SDK for Node.js
TypeScript
2
star
88

apiary-drone-fly

Terraform scripts for deploying Drone Fly
HCL
2
star
89

expediagroup-java-sdk-parent

2
star
90

parsec

Parsec is a data processing engine for interpreted queries.
Clojure
2
star
91

dropwizard-resilience4j-bundle

Integration of Resilience4J into Dropwizard
Java
2
star
92

renovate-config-catalyst

[DEPRECATED] Renovate shared configuration for catalyst projects
2
star
93

flyte-slack

A Slack integration pack for Flyte
Go
2
star
94

openworld-sdk-java-generators

Mustache
2
star
95

overwhelm

Operator for complex application deployment on Kubernetes
Go
2
star
96

flyte-graphite

A graphite integration pack for Flyte
Go
2
star
97

graphql-kotlin-codegen

A graphql-codegen plugin that enables type generation for GraphQL Kotlin services, promoting schema-first development.
TypeScript
2
star
98

helm-charts

Expedia Group Helm Charts
Mustache
1
star
99

determination

[DEPRECATED] Configuration resolver using confidence and shortstop.
JavaScript
1
star
100

dr-squid

Dr Squid is a downstream services and databases mocking tool primarily used for chaos testing and gathering performance metrics for Java Spring service
Java
1
star