• This repository has been archived on 27/Mar/2021
  • Stars
    star
    843
  • Rank 49,319 (Top 2 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 8 years ago
  • Updated over 2 years ago

Reviews

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

Repository Details

The Heroic Time Series Database

DEPRECATION NOTICE

This repo is no longer actively maintained. While it should continue to work and there are no major known bugs, we will not be improving Heroic or releasing new versions.

Heroic Heroic

Build Status Codecov License

A scalable time series database based on Bigtable, Cassandra, and Elasticsearch. Go to https://spotify.github.io/heroic/ for documentation.

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

Install

Docker

Docker images are available on Docker Hub.

$ docker run -p 8080:8080 -p 9091:9091 spotify/heroic

Heroic will now be reachable at http://localhost:8080/status.

In production it's advised to use a tagged version.

Configuration

For help on how to write a configuration file, see the Configuration Section of the official documentation.

Heroic has been tested with the following services:

Developing

Building from source

In order to compile Heroic, you'll need:

  • A Java 11 JDK
  • Maven 3
  • Gradle

The project is built using Gradle:

# full build, runs all tests and builds the shaded jar
./gradlew build

# only compile
./gradlew assemble

# build a single module
./gradlew heroic-metric-bigtable:build

The heroic-dist module can be used to produce a shaded jar that contains all required dependencies:

./gradlew heroic-dist:shadowJar

After building, the entry point of the service is com.spotify.heroic.HeroicService. The following is an example of how this can be run:

./gradlew heroic-dist:runShadow <config>

which is the equivalent of doing:

java -jar $PWD/heroic-dist/build/libs/heroic-dist-0.0.1-SNAPSHOT-shaded.jar <config>

Building with Docker

$ docker build -t heroic:latest .

This is a multi-stage build and will first build Heroic via a ./gradlew clean build and then copy the resulting shaded jar into the runtime container.

Running heroic via docker can be done:

$ docker run -d -p 8080:8080 -p 9091:9091 -v /path/to/config.yml:/heroic.yml spotify/heroic:latest

Logging

Logging is captured using SLF4J, and forwarded to Log4j.

To configure logging, define the -Dlog4j.configurationFile=<path> parameter. You can use docs/log4j2-file.xml as a base.

Testing

We run tests with Gradle:

# run unit tests
./gradlew test

# run integration tests
./gradlew integrationTest

or to run a more comprehensive set of checks:

./gradlew check

This will run:

It is strongly recommended that you run the full test suite before setting up a pull request, otherwise it will be rejected by Travis.

Full Cluster Tests

Full cluster tests are defined in heroic-dist/src/test/java.

This way, they have access to all the modules and parts of Heroic.

The JVM RPC module is specifically designed to allow for rapid execution of integration tests. It allows multiple cores to be defined and communicate with each other in the same JVM instance.

Code Coverage

Coverage

There's an ongoing project to improve test coverage. Clicking the above graph will bring you to codecov.io, where you can find areas to focus on.

Bypassing Validation

To bypass automatic formatting and checkstyle validation you can use the following stanza:

// @formatter:off
final List<String> list = ImmutableList.of(
   "Welcome to...",
   "... The Wild West"
);
// @formatter:on

To bypass a FindBugs error, you should use the @SupressFBWarnings annotation.

@SupressFBWarnings(value="FINDBUGS_ERROR_CODE", justification="I Know Better Than FindBugs")
public class IKnowBetterThanFindbugs() {
    // ...
}

Module Orientation

The Heroic project is split into a couple of modules.

The most critical one is heroic-component. It contains interfaces, value objects, and the basic set of dependencies necessary to glue different components together.

Submodules include metric, suggest, metadata, and aggregation. The first three contain various implementations of the given backend type, while the latter provides aggregation methods.

heroic-core contains the com.spotify.heroic.HeroicCore class which is the central building block for setting up a Heroic instance.

heroic-elasticsearch-utils is a collection of utilities for interacting with Elasticsearch. This is separate since we have more than one backend that needs to talk with elasticsearch.

Finally there is heroic-dist, a small project that depends on all module. Here is where everything is bound together into a distribution โ€” a shaded jar. It also provides the entry-point for services, namely com.spotify.heroic.HeroicService or through an interactive shell com.spotify.heroic.HeroicShell. The shell can either be run standalone or connected to an existing Heroic instance for administration.

Contributing

Guidelines for contributing can be found here.

More Repositories

1

luigi

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.
Python
16,893
star
2

annoy

Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk
C++
12,131
star
3

docker-gc

INACTIVE: Docker garbage collection of containers and images
Shell
5,068
star
4

pedalboard

๐ŸŽ› ๐Ÿ”Š A Python library for working with audio.
C++
4,573
star
5

chartify

Python library that makes it easy for data scientists to create charts.
Python
3,404
star
6

dockerfile-maven

MATURE: A set of Maven tools for dealing with Dockerfiles
Java
2,717
star
7

docker-maven-plugin

INACTIVE: A maven plugin for Docker
Java
2,652
star
8

basic-pitch

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection
Python
2,502
star
9

scio

A Scala API for Apache Beam and Google Cloud Dataflow.
Scala
2,485
star
10

helios

Docker container orchestration platform
Java
2,097
star
11

web-api-examples

Basic examples to authenticate and fetch data using the Spotify Web API
HTML
1,871
star
12

HubFramework

DEPRECATED โ€“ Spotifyโ€™s component-driven UI framework for iOS
Objective-C
1,864
star
13

apollo

Java libraries for writing composable microservices
Java
1,648
star
14

dh-virtualenv

Python virtualenvs in Debian packages
Python
1,584
star
15

docker-client

INACTIVE: A simple docker client for the JVM
Java
1,428
star
16

docker-kafka

Kafka (and Zookeeper) in Docker
Shell
1,398
star
17

SPTPersistentCache

Everyone tries to implement a cache at some point in their iOS appโ€™s lifecycle, and this is ours.
Objective-C
1,244
star
18

mobius

A functional reactive framework for managing state evolution and side-effects.
Java
1,184
star
19

ruler

Gradle plugin which helps you analyze the size of your Android apps.
Kotlin
1,075
star
20

XCMetrics

XCMetrics is the easiest way to collect Xcode build metrics and improve developer productivity.
Swift
1,052
star
21

sparkey

Simple constant key/value storage library, for read-heavy systems with infrequent large bulk inserts.
C
1,019
star
22

web-api

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web API โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
RAML
981
star
23

echoprint-codegen

Codegen for Echoprint
C++
948
star
24

snakebite

A pure python HDFS client
Python
859
star
25

klio

Smarter data pipelines for audio.
Python
813
star
26

XCRemoteCache

Swift
802
star
27

voyager

๐Ÿ›ฐ๏ธ Voyager is an approximate nearest-neighbor search library for Python and Java with a focus on ease of use, simplicity, and deployability.
C++
791
star
28

SPTDataLoader

The HTTP library used by the Spotify iOS client
Objective-C
623
star
29

apps-tutorial

A Spotify App that contains working examples of the use of Spotify Apps API
621
star
30

ios-sdk

Spotify SDK for iOS
Objective-C
590
star
31

postgresql-metrics

Tool that extracts and provides metrics on your PostgreSQL database
Python
580
star
32

JniHelpers

Tools for writing great JNI code
C++
578
star
33

reactochart

๐Ÿ“ˆ React chart component library ๐Ÿ“‰
JavaScript
544
star
34

Mobius.swift

A functional reactive framework for managing state evolution and side-effects [Swift implementation]
Swift
523
star
35

dockerfile-mode

An emacs mode for handling Dockerfiles
Emacs Lisp
505
star
36

threaddump-analyzer

A JVM threaddump analyzer
JavaScript
478
star
37

featran

A Scala feature transformation library for data science and machine learning
Scala
467
star
38

android-sdk

Spotify SDK for Android
HTML
434
star
39

echoprint-server

Server for the Echoprint audio fingerprint system
Java
396
star
40

web-scripts

A collection of base configs and CLI wrappers used to speed up development @ Spotify.
TypeScript
380
star
41

completable-futures

Utilities for working with futures in Java 8
Java
374
star
42

SpotifyLogin

Swift framework for authenticating with the Spotify API
Swift
344
star
43

ratatool

A tool for data sampling, data generation, and data diffing
Scala
332
star
44

fmt-maven-plugin

Opinionated Maven Plugin that formats your Java code.
Java
294
star
45

trickle

A small library for composing asynchronous code
Java
285
star
46

big-data-rosetta-code

Code snippets for solving common big data problems in various platforms. Inspired by Rosetta Code
Scala
283
star
47

pythonflow

๐Ÿ Dataflow programming for python.
Python
279
star
48

coordinator

A visual interface for turning an SVG into XY coรถrdinates.
HTML
278
star
49

styx

"The path to execution", Styx is a service that schedules batch data processing jobs in Docker containers on Kubernetes.
Java
267
star
50

cstar

Apache Cassandra cluster orchestration tool for the command line
Python
252
star
51

netty-zmtp

A Netty implementation of ZMTP, the ZeroMQ Message Transport Protocol.
Java
243
star
52

ios-style

Guidelines for iOS development in use at Spotify
241
star
53

cassandra-reaper

Software to run automated repairs of cassandra
234
star
54

docker-cassandra

Cassandra in Docker with fast startup
Shell
218
star
55

confidence

Python
217
star
56

terraform-gke-kubeflow-cluster

Terraform module for creating GKE clusters to run Kubeflow
HCL
209
star
57

linux

Spotify's Linux kernel for Debian-based systems
C
203
star
58

git-test

test your commits
Shell
200
star
59

dns-java

DNS wrapper library that provides SRV lookup functionality
Java
200
star
60

SPStackedNav

[DEPRECATED] Navigation controller which represents its content in stacks of panes, rather than one at a time
Objective-C
197
star
61

quickstart

A CommonJS module resolver, loader and compiler for node.js and browsers.
JavaScript
193
star
62

spotify-json

Fast and nice to use C++ JSON library.
C++
186
star
63

dbeam

DBeam exports SQL tables into Avro files using JDBC and Apache Beam
Java
179
star
64

flink-on-k8s-operator

Kubernetes operator for managing the lifecycle of Apache Flink and Beam applications.
Go
174
star
65

basic-pitch-ts

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection.
TypeScript
167
star
66

spotify-web-api-ts-sdk

A Typescript SDK for the Spotify Web API with types for returned data.
TypeScript
167
star
67

bazel-tools

Tools for dealing with very large Bazel-managed repositories
Java
163
star
68

lingon

A user friendly tool for building single-page JavaScript applications
JavaScript
161
star
69

dataenum

Algebraic data types in Java.
Java
157
star
70

async-google-pubsub-client

[SUNSET] Async Google Pubsub Client
Java
156
star
71

magnolify

A collection of Magnolia add-on modules
Scala
154
star
72

gcp-audit

A tool for auditing security properties of GCP projects.
Python
154
star
73

spark-bigquery

Google BigQuery support for Spark, SQL, and DataFrames
Scala
154
star
74

flo

A lightweight workflow definition library
Java
146
star
75

folsom

An asynchronous memcache client for Java
Java
142
star
76

zoltar

Common library for serving TensorFlow, XGBoost and scikit-learn models in production.
Java
142
star
77

missinglink

Build time tool for detecting link problems in java projects
Java
140
star
78

should-up

Remove most of the "should" noise from your tests
JavaScript
139
star
79

android-auth

Spotify authentication and authorization for Android. Part of the Spotify Android SDK.
HTML
138
star
80

proto-registry

An implementation of the Protobuf Registry API
TypeScript
137
star
81

futures-extra

Java library for working with Guava futures
Java
134
star
82

annoy-java

Approximate nearest neighbors in Java
Java
134
star
83

spydra

Ephemeral Hadoop clusters using Google Compute Platform
Java
132
star
84

docker-stress

Simple docker stress test and monitoring tools
Python
124
star
85

spotify-tensorflow

Provides Spotify-specific TensorFlow helpers
Python
120
star
86

crtauth

a public key backed client/server authentication system
Python
119
star
87

redux-location-state

Utilities for reading & writing Redux store state to & from the URL
JavaScript
117
star
88

sparkey-java

Java implementation of the Sparkey key value store
Java
113
star
89

rspec-dns

Easily test your DNS with RSpec
Ruby
108
star
90

web-playback-sdk

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web Playback SDK โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
108
star
91

ffwd-ruby

An event and metrics fast-forwarding agent.
Ruby
106
star
92

spotify-web-playback-sdk-example

React based example app that creates a new player in Spotify Connect to play music from in the browse using Spotify Web Playback SDK.
JavaScript
105
star
93

gimme

Creating time bound IAM Conditions with ease and flair
Python
103
star
94

realbook

Easier audio-based machine learning with TensorFlow.
Python
100
star
95

super-smash-brogp

Sends and withdraws BGP prefixes for fun.
Python
98
star
96

github-java-client

A Java client to Github API
Java
98
star
97

noether

Scala Aggregators used for ML Model metrics monitoring
Scala
91
star
98

lighthouse-audit-service

TypeScript
89
star
99

python-graphwalker

Python re-implementation of the graphwalker testing tool
Python
89
star
100

spotify-js-challenge

JavaScript
86
star