euchch/circleci-insights-prometheus-exporter

Prometheus Exporter for CircleCI Insight API - POC for CVS

circleci-insights-prometheus-exporter

Prometheus Exporter for CircleCI Insight API

How to run

Local

$ go run main.go

Binary

Get the binary file from Releases and run it.

Docker

$ docker run chaspy/circleci-insights-prometheus-exporter:v0.3.0

Metrics

Get summary metrics for a project's workflows

• circleci_custom_workflow_insights_total_runs
• circleci_custom_workflow_insights_successful_runs
• circleci_custom_workflow_insights_failed_runs
• circleci_custom_workflow_insights_success_rate
• circleci_custom_workflow_insights_throughput
• circleci_custom_workflow_insights_duration_metrics_min
• circleci_custom_workflow_insights_duration_metrics_max
• circleci_custom_workflow_insights_duration_metrics_median
• circleci_custom_workflow_insights_duration_metrics_p95
• circleci_custom_workflow_insights_duration_metrics_standard_deviation

These metrics are from getProjectWorkflowRuns API

These metrics have "workflow", "repo" and "branch" tags.

Get summary metrics for a project workflow's jobs.

• circleci_custom_job_insights_success_rate
• circleci_custom_job_insights_duration_metrics_min
• circleci_custom_job_insights_duration_metrics_max
• circleci_custom_job_insights_duration_metrics_median
• circleci_custom_job_insights_duration_metrics_p95
• circleci_custom_job_insights_duration_metrics_standard_deviation

These metrics are from getProjectWorkflowJobMetrics

These metrics have "job", "workflow", "repo" and "branch" tags.

Environment Variable

name	required	default	description
CIRCLECI_TOKEN	yes	-	CircleCI API Token
CIRCLECI_API_INTERVAL	no	300(sec)	Interval second for calling the API
GITHUB_REPOSITORY	yes	-	Comma-separated repository names. i.e. "chaspy/chaspy.me,chaspy/dotfiles"
GITHUB_BRANCH	yes	-	Comma-separated branch names. i.e. "master,develop"

Datadog Autodiscovery

If you use Datadog, you can use Kubernetes Integration Autodiscovery feature.