Skip to main content

Git

Standard Edition Required

Execute as SQL style query against a github repo using mergestat-lite.

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: github-check
spec:
schedule: "@every 1m"
github:
- githubToken: <token>
query: SELECT count(*) FROM commits WHERE author_email = 'user@email.com'
FieldDescriptionScheme
githubToken*

Github Personal Access Token

EnvVar

name*

Name of the check, must be unique within the canary

string

query*

Query to be executed. See mergestat-lite for syntax

string

description

Description for the check

string

display

Expression to change the formatting of the display

Expression

icon

Icon for overwriting default icon on the dashboard

Icon

labels

Labels for check

map[string]string

metrics

Metrics to export from

[]Metrics

test

Evaluate whether a check is healthy

Expression

transform

Transform data from a check into multiple individual checks

Expression