README
¶
Sippy
Sippy (Continuous Integration Private Investigator) analyzes OpenShift Prow CI job and test results. It surfaces release health and regressions through reports such as Component Readiness. Users can filter results by job, test, and configuration variants such as network, upgrade, release, and platform. Sippy also exposes REST APIs for programmatic access to its data and reports.
Sippy Chat has moved to Chai Bot in Slack. Existing /chat links display a transition page.
Typical usage
See DEVELOPMENT.md for information about standing up a local environment.
API
Frontend
See the front end documentation
Database
See database tuning for required PostgreSQL parameter group settings.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sippy
command
|
|
|
sippy-daemon
command
|
|
|
pkg
|
|
|
apis/api
Package api contains types suitable for use with Material UI data tables.
|
Package api contains types suitable for use with Material UI data tables. |
|
apis/sippyprocessing/v1
Package v1 is used to produce a reporting structure for rendering html pages.
|
Package v1 is used to produce a reporting structure for rendering html pages. |
|
apis/workloadmetrics/v1
workloadmetrics package contains types used for processing CPU and memory usage results from the OpenShift perfscale team elasticsearch.
|
workloadmetrics package contains types used for processing CPU and memory usage results from the OpenShift perfscale team elasticsearch. |
|
dataloader/infrafailurebackfill
Package infrafailurebackfill backfills InfraFailure job run labels from BigQuery into PostgreSQL.
|
Package infrafailurebackfill backfills InfraFailure job run labels from BigQuery into PostgreSQL. |
|
db/infrafailure
Package infrafailure records infrastructure-failure job runs and removes their contribution from Sippy's pre-aggregated summary tables.
|
Package infrafailure records infrastructure-failure job runs and removes their contribution from Sippy's pre-aggregated summary tables. |
|
db/loader
These types are used to decode information from ci-search, but we don't want to expose these for anyone else.
|
These types are used to decode information from ci-search, but we don't want to expose these for anyone else. |
|
db/verify
Package verify provides read-only storage adapters and pure comparisons for checking the integrity of Sippy's daily data pipeline.
|
Package verify provides read-only storage adapters and pure comparisons for checking the integrity of Sippy's daily data pipeline. |
|
jiraauth
Package jiraauth provides service-account authentication for Jira SDK and HTTP callers.
|
Package jiraauth provides service-account authentication for Jira SDK and HTTP callers. |
|
sippyserver/workqueue
Package workqueue provides generic infrastructure for River-based asynchronous work queues.
|
Package workqueue provides generic infrastructure for River-based asynchronous work queues. |
|
sippyserver/workqueue/symptomre
Package symptomre implements the asynchronous symptom re-evaluation workflow.
|
Package symptomre implements the asynchronous symptom re-evaluation workflow. |
|
test
|
|
Click to show internal directories.
Click to hide internal directories.