• This repository has been archived on 14/Jun/2022
  • Stars
    star
    209
  • Rank 188,325 (Top 4 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 7 years ago
  • Updated almost 2 years ago

Reviews

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

Repository Details

WIP: A dashboard for CI

Zeus

This project is under development.

Zeus is a frontend and analytics provider for CI solutions. It is inspired by the work done at Dropbox on Changes.

User Guide

Currently Zeus publicly supports GitHub.com as well as easy integration with Travis CI.

To add a new project:

  1. Add a repository (via settings).
  2. Go to the repository's settings and generate a new Hook.
  3. Bind ZEUS_HOOK_BASE as a secret environment variable in Travis.
  4. Update your .travis.yml to include the Zeus webhook.
  5. (Optional) Update your .travis.yml to include artifact upload.
  6. (Optional, not yet recommended) Update your .travis.yml to disable Travis' native email notifications.

Once you've added a project Zeus will automatically update with details from any builds you've run.

Some quick caveats:

  • The project is still pretty early on, and may break/change without warning.
  • travis-ci.com and GitHub Enterprise are not yet supported.
  • Notifications will only be triggered for users which have authenticated against Zeus.

If you want to use Zeus with a build system that's not currently supported, see the details on "Hooks" in the documentation.

Supported Artifact Types

While you can upload any kind of Artifact to zeus (e.g. .html output), the platform has knowledge of certain types and will grant additional functionality if they're present.

The recommended way to support artifacts is to configure a post-build step (on both failure and success) to do something similar to the following:

npm install -g @zeus-ci/cli
$(npm bin -g)/zeus upload -t "application/x-junit+xml" jest.junit.xml
$(npm bin -g)/zeus upload -t "application/x-cobertura+xml" coverage.xml

Code Coverage

  • application/x-clover+xml
  • application/x-cobertura+xml

xUnit

  • application/x-bitten+xml
  • application/x-junit+xml
  • application/x-xunit+xml

Style Checks

  • application/x-checkstyle+xml
  • text/x-pep8
  • text/x-pycodestyle
  • test/x-pylint

Webpack Stats

Webpack stats can be generated with:

webpack --profile --json > webpack-stats.json

They should be submitted with the application/x-webpack-stats+json type.

Contributing

Requirements

  • Python 3.8
  • Node (and Volta)
  • Postgres 9.4+

Note: If you're using pyenv for Python and macOS Mojave and having issues installing 3.7.1, take a look here:

pyenv/pyenv#1219

Setup

# install poetry
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/0.12.10/get-poetry.py | python

# load dependencies
make

# initialize config
poetry run zeus init

Note, before running any future Python commands (including zeus), you'll need to activate the environment:

poetry shell

You can also setup direnv to automatically activate the environment.

Once dependencies are resolved, bootstrap the database (see Makefile for details):

make db

Finally, launch the webserver:

zeus devserver

# or alternatively, with workers:
zeus devserver --workers

Getting some data

$ zeus repos add https://github.com/getsentry/zeus.git

Once you've authenticated, give yourself access to the repository:

$ zeus repos access add https://github.com/getsentry/zeus.git [[email protected]]

Additionally, you can generate some mock data:

$ zeus mocks load-all

Layout

zeus
β”œβ”€β”€ setup.py                // server dependencies
β”œβ”€β”€ zeus                    // server code
|   β”œβ”€β”€ artifacts           // artifact handlers
|   β”œβ”€β”€ api
|   |   β”œβ”€β”€ resources       // api endpoints/resources
|   |   └── schemas         // api serializer/schemas
|   β”œβ”€β”€ cli                 // command line utilities
|   β”œβ”€β”€ models              // database schema
|   β”œβ”€β”€ storage             // file storage implementations
|   β”œβ”€β”€ tasks               // async task definitions
|   β”œβ”€β”€ vcs                 // version control system implementations
|   └── web                 // server-rendered web views
β”œβ”€β”€ templates               // server-rendered templates
β”œβ”€β”€ public                  // general static assets
β”œβ”€β”€ package.json            // web client dependencies
└── webapp                  // web client
    β”œβ”€β”€ actions             // redux actions
    β”œβ”€β”€ components          // react components
    β”œβ”€β”€ reducers            // redux reducers
    β”œβ”€β”€ routes.js           // routes (react-router)
    └── pages.js            // react components (pages)

Data Model

  • Most models contain a GUID (UUID) primary key.
  • Some generalized models (such as ItemStat) are keyed by GUID, and do not contain backrefs or constraints.
  • Access is controlled at the repository level, and is generally enforced if you use the {ModelClass}.query utilities.
  • Refs are unresolved (pointers to shas). They are often resolved asynchronously. Models containing a sha will also often contain a parallel ref field.
zeus
β”œβ”€β”€ ApiToken
|   └── ApiTokenRepositoryAccess
β”œβ”€β”€ Hook
β”œβ”€β”€ Repository
|   β”œβ”€β”€ RepositoryAccess
|   β”œβ”€β”€ ItemOption
|   β”œβ”€β”€ Build
|   |   β”œβ”€β”€ ItemStat
|   |   β”œβ”€β”€ Source
|   |   β”œβ”€β”€ FileCoverage
|   |   └── Job
|   |       β”œβ”€β”€ Artifact
|   |       β”œβ”€β”€ ItemStat
|   |       └── TestCase
|   |           β”œβ”€β”€ Artifact
|   |           └── ItemStat
|   β”œβ”€β”€ ChangeRequest
|   |   └── Revision
|   └── Source
|       β”œβ”€β”€ Author
|       β”œβ”€β”€ Patch
|       └── Revision
|           └── Author
└── User
    β”œβ”€β”€ Email
    └── Identity

Hooks

A subset of APIs are exposed using simple hook credentials. These credentials are coupled to a provider (e.g. travis-ci) and a single repository.

To create a new hook:

zeus hooks add https://github.com/getsentry/zeus.git travis-ci

Using the subpath, you'll be able to access several endpoints:

  • {prefix}/builds/{build-external-id}
  • {prefix}/builds/{build-external-id}/jobs/{job-external-id}
  • {prefix}/builds/{build-external-id}/jobs/{job-external-id}/artifacts

The prefix will be generated for you as part of the new hook, and is made up of the Hook's GUID and it's signature:

http://example.com/hooks/{hook-id}/{hook-signature}/{path}

Each endpoint takes an external ID, which is used as a unique query parameter. The constraints are coupled to the parent object. For example, to create or patch a build:

POST http://example.com/hooks/{hook-id}/{hook-signature}/builds/abc

This will look for a Build object with the following characteristics:

  • provider={Hook.provider}
  • external_id=abc
  • repository_id={Hook.repository_id}

If a match is found, it will be updated with the given API parameters. If it isn't found, it will be created. All of these operations are treated like a standard UPSERT (UPDATE IF EXISTS or INSERT).

The process for publishing data generally looks like this:

  1. if applicable, upsert a change request and its source association
  2. upsert the build's basic parameters
  3. upsert the detailed job parameters
  4. publish artifacts

These actions can be also performed manually (without using the native webhooks) with zeus-cli (recommended) or curl.

Updating data with zeus-cli

More information (installation instructions, documentation) about zeus-cli can be found on its project's page: https://github.com/getsentry/zeus-cli

zeus-cli is a command line tool that facilitates interaction with Zeus API for actions such as updating jobs or uploading artifacts.

The following command creates a build and a job for a given git revision:

zeus job update -b $MY_BUILD_ID -j $MY_JOB_ID  --ref=$MY_REF_ID

And here's how you upload an artifact:

zeus upload -b $MY_BUILD_ID -j $MY_JOB_ID -t 'text/xml+coverage' coverage.xml

Updating data with curl

Here's an example of how you can publish job details without the native webhooks with curl from Travis:

#!/bin/bash -eu
if [[ "$TRAVIS_PULL_REQUEST" != "false" ]]; then
    BUILD_LABEL="PR #${TRAVIS_PULL_REQUEST}"
else
    BUILD_LABEL=""
fi

# ensure the build exists
curl $ZEUS_HOOK_BASE/builds/$TRAVIS_BUILD_NUMBER \
    -X POST \
    -H 'Content-Type: application/json' \
    -d "{\"label\": \"${BUILD_LABEL}\", \"ref\": \"$TRAVIS_COMMIT\", \"url\": \"https://travis-ci.org/${TRAVIS_REPO_SLUG}/builds/${TRAVIS_BUILD_ID}\"}"

# upsert current job details
curl $ZEUS_HOOK_BASE/builds/$TRAVIS_BUILD_NUMBER/jobs/$TRAVIS_JOB_NUMBER \
    -X POST \
    -H 'Content-Type: application/json' \
    -d "{\"status\": \"$1\", \"result\": \"$2\", \"url\": \"https://travis-ci.org/${TRAVIS_REPO_SLUG}/jobs/${TRAVIS_JOB_ID}\", \"allow_failure\": ${TRAVIS_ALLOW_FAILURE}}"

From there you can submit artifacts using zeus-cli and its standard mechanisms.

More Repositories

1

sentry

Developer-first error tracking and performance monitoring
Python
38,989
star
2

sentry-javascript

Official Sentry SDKs for JavaScript
TypeScript
7,952
star
3

self-hosted

Sentry, feature-complete and packaged up for low-volume deployments and proofs-of-concept
Shell
7,663
star
4

responses

A utility for mocking out the Python Requests library.
Python
4,127
star
5

sentry-php

The official PHP SDK for Sentry (sentry.io)
PHP
1,817
star
6

raven-python

Raven is the legacy Python client for Sentry (getsentry.com) β€” replaced by sentry-python
Python
1,678
star
7

sentry-react-native

Official Sentry SDK for React Native
TypeScript
1,566
star
8

sentry-python

The official Python SDK for Sentry.io
Python
1,533
star
9

sentry-laravel

The official Laravel SDK for Sentry (sentry.io)
PHP
1,157
star
10

sentry-java

A Sentry SDK for Java, Android and other JVM languages.
Kotlin
1,154
star
11

sentry-ruby

Sentry SDK for Ruby
Ruby
927
star
12

sentry-go

The official Go SDK for Sentry (sentry.io)
Go
917
star
13

sentry-cli

A command line utility to work with Sentry.
Rust
833
star
14

sentry-cocoa

The official Sentry SDK for iOS, tvOS, macOS, watchOS.
Objective-C
803
star
15

milksnake

A setuptools/wheel/cffi extension to embed a binary data in wheels
Python
764
star
16

sentry-symfony

The official Symfony SDK for Sentry (sentry.io)
PHP
687
star
17

sentry-webpack-plugin

Repo moved to https://github.com/getsentry/sentry-javascript-bundler-plugins. Please open any issues/PRs there.
JavaScript
662
star
18

freight

Freight is a service which aims to make application deployments better.
Python
610
star
19

sentry-elixir

The official Elixir SDK for Sentry (sentry.io)
Elixir
597
star
20

sentry-dotnet

Sentry SDK for .NET
C#
576
star
21

raven-go

Sentry client in Go
Go
560
star
22

sentry-rust

Official Sentry SDK for Rust
Rust
515
star
23

raven-node

A standalone (Node.js) client for Sentry
JavaScript
457
star
24

symbolic

Stack trace symbolication library written in Rust
Rust
440
star
25

action-release

GitHub Action for creating a release on Sentry
TypeScript
424
star
26

sentry-kubernetes

Kubernetes event reporter for Sentry
Python
408
star
27

sentry-native

Sentry SDK for C, C++ and native applications.
C
397
star
28

pdb

A parser for Microsoft PDB (Program Database) debugging information
Rust
385
star
29

symbolicator

Native Symbolication as a Service
Rust
357
star
30

spotlight

Your Universal Debug Toolbar
TypeScript
356
star
31

docker-sentry

Docker Official Image packaging for Sentry
Python
348
star
32

sentry-docs

Sentry's documentation (and tools to build it)
MDX
331
star
33

rb

Routing and connection management for Redis in Python
Python
300
star
34

sentry-php-sdk

This is a meta package to ship sentry-php with a recommend http client.
298
star
35

snuba

Search the seas for your lost treasure.
Python
272
star
36

relay

Sentry event forwarding and ingestion service.
Rust
246
star
37

raven-csharp

Superseded by: https://github.com/getsentry/sentry-dotnet
C#
232
star
38

sentry-electron

The official Sentry SDK for Electron
TypeScript
217
star
39

sentry-plugins

Official plugins for Sentry server
Python
212
star
40

sentry-unity

Development of Sentry SDK for Unity
C#
208
star
41

sentry-wizard

Sentry Project Setup Wizard
TypeScript
192
star
42

rust-sourcemap

A library for rust that implements basic sourcemap handling
Rust
188
star
43

action-github-app-token

Gets a GitHub auth token for a GitHub App installation
TypeScript
184
star
44

sentry-android-gradle-plugin

Gradle plugin for Sentry Android. Upload proguard, debug files, and more.
Kotlin
142
star
45

sentry-fastlane-plugin

Official fastlane plugin for Sentry
Ruby
136
star
46

sentry-slack

DEPRECATED Slack integration for Sentry
Python
135
star
47

sentry-javascript-bundler-plugins

JavaScript Bundler Plugins for Sentry
TypeScript
133
star
48

action-git-diff-suggestions

This GitHub Action will take the current git changes and apply them as GitHub code review suggestions
TypeScript
122
star
49

examples

Collection of all different kinds of Sentry SDKs and integrations
C#
119
star
50

craft

The universal Sentry release CLI πŸš€
TypeScript
118
star
51

sentry-capacitor

The official Sentry SDK for Capacitor
TypeScript
117
star
52

sentry-kotlin-multiplatform

Sentry SDK for Kotlin Multiplatform
Kotlin
104
star
53

sentry-clj

Sentry SDK for Clojure
Clojure
103
star
54

raven-objc

This SDK is deprecated. Use https://github.com/getsentry/sentry-cocoa
Objective-C
98
star
55

sentry-jira

A Plugin for sentry that lets you create JIRA issues
Python
95
star
56

raven-aiohttp

An aiohttp transport for raven-python
Python
90
star
57

sentry-android

MOVED: https://github.com/getsentry/sentry-java
87
star
58

sentry-unreal

Unreal Engine
C++
84
star
59

pytest-responses

py.test integration for responses
Python
83
star
60

sentry-github

A Sentry extension which integrates with GitHub.
Python
79
star
61

libsourcemap

DEPRECATED: Implements efficient sourcemap processing for Python in Rust
Rust
78
star
62

sentry-rrweb

Moved to: https://github.com/getsentry/sentry-javascript/tree/master/packages/replay#sentry-session-replay
TypeScript
73
star
63

sentry-cordova

The official Sentry SDK for Cordova
TypeScript
68
star
64

sentry-dart-plugin

A Dart Build Plugin that uploads debug symbols for Android, iOS/macOS and source maps for Web to Sentry via sentry-cli
Dart
66
star
65

sourcemaps.io

Web-based Source Map validator
TypeScript
58
star
66

breakpad-tools

Prebuilt tools and examples to work with Breakpad's minidumps
Makefile
56
star
67

dotnet-assembly-alias

Tool to rename .NET assemblies and references
C#
53
star
68

sentry-webhooks

An extension for Sentry which allows creation various web hooks.
Python
52
star
69

sentry-netlify-build-plugin

The Sentry Netlify build plugin automatically notifies Sentry of new releases being deployed to your site.
JavaScript
46
star
70

sentry-mobile-release-health-app

Sentry Mobile App
Dart
44
star
71

sentry-xamarin

Sentry for Xamarin Native and Xamarin.Forms
C#
44
star
72

develop

TypeScript
43
star
73

babel-gettext-extractor

A fork of babel-gettext-plugin that works with older versions of node and supports comment and location extraction
JavaScript
43
star
74

raven-swift

This SDK is deprecated. Use https://github.com/getsentry/sentry-cocoa
40
star
75

pytest-sentry

Track flaky tests in Sentry
Python
39
star
76

sentry-auth-github

GitHub SSO provider for Sentry
Python
39
star
77

arroyo

A library to build streaming applications that consume from and produce to Kafka.
Python
39
star
78

action-visual-snapshot

Save and compare your visual snapshots
TypeScript
38
star
79

sentry-fullstory

The Sentry-FullStory integration seamlessly integrates the Sentry and FullStory platforms.
TypeScript
37
star
80

sentry-phabricator

A Sentry extension which integrates with Phabricator
Python
36
star
81

platformicons

A platform and framework icon font.
TypeScript
36
star
82

sentry-auth-google

Google Apps SSO provider for Sentry
Python
34
star
83

integration-platform-example

An example kanban application which explores the ways developers can build apps on Sentry's integration platform
TypeScript
32
star
84

unity

Unity SDK UPM package
Objective-C
31
star
85

vanguard

TypeScript
29
star
86

profiling-node

The code for this repo now lives in https://github.com/getsentry/sentry-javascript/tree/develop/packages/profiling-node
TypeScript
29
star
87

symbol-collector

Clients and Server to collect system symbols.
C#
29
star
88

sentry-vscode

VSCode editor integration for Sentry
TypeScript
28
star
89

probot-report

Probot app that sends periodic reminder emails for outstanding PR reviews
JavaScript
28
star
90

hackweek-coda

A queue thing with a sprinkle of Italian
Python
27
star
91

sentry-replay

Moved to http://github.com/getsentry/sentry-javascript
TypeScript
27
star
92

perl-raven

A perl sentry client
Perl
26
star
93

sentry_airflow

Airflow integration with Sentry (https://sentry.io)
Python
26
star
94

cloud-run-typescript-template

Template for Google Cloud Run (typescript)
JavaScript
24
star
95

symsynd

C++
23
star
96

sentry-relay-attic

A relay server for Sentry (https://getsentry.com)
Rust
23
star
97

freight-cli

A command line interface to Freight
Python
22
star
98

xds

xDS service for Envoy
Go
22
star
99

atlas

A map to your company
Python
22
star
100

gib-potato

More Potato, more awesome πŸ₯”
PHP
21
star