{"id":50094823,"url":"https://github.com/redis-developer/cae-otel-ci-visibility","last_synced_at":"2026-05-23T02:35:51.634Z","repository":{"id":310480513,"uuid":"1039947039","full_name":"redis-developer/cae-otel-ci-visibility","owner":"redis-developer","description":"GitHub Action to collect OpenTelemetry metrics for CI visibility","archived":false,"fork":false,"pushed_at":"2026-03-17T10:04:14.000Z","size":5272,"stargazers_count":5,"open_issues_count":9,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-03-18T01:03:40.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redis-developer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-18T08:19:57.000Z","updated_at":"2026-03-17T10:04:17.000Z","dependencies_parsed_at":"2025-08-18T12:26:38.527Z","dependency_job_id":"f178ca6e-b73e-41d0-af53-d3bcd92ff7ee","html_url":"https://github.com/redis-developer/cae-otel-ci-visibility","commit_stats":null,"previous_names":["redis-developer/cae-otel-ci-visibility"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/redis-developer/cae-otel-ci-visibility","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis-developer%2Fcae-otel-ci-visibility","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis-developer%2Fcae-otel-ci-visibility/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis-developer%2Fcae-otel-ci-visibility/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis-developer%2Fcae-otel-ci-visibility/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redis-developer","download_url":"https://codeload.github.com/redis-developer/cae-otel-ci-visibility/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis-developer%2Fcae-otel-ci-visibility/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33380804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T01:21:08.577Z","status":"online","status_checked_at":"2026-05-23T02:00:05.530Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-23T02:35:50.502Z","updated_at":"2026-05-23T02:35:51.626Z","avatar_url":"https://github.com/redis-developer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenTelemetry CI Visibility Action\n\nExtracts test metrics from JUnit XML files and sends them to OTLP endpoints with\nminimal cardinality for efficient storage and querying.\n\n## What it does\n\n- Reads JUnit XML files from a directory\n- Parses test results and durations\n- Generates low-cardinality OpenTelemetry metrics optimized for performance\n  regression detection\n- Ships metrics to OTLP-compatible backends (Prometheus, Mimir, Grafana Cloud,\n  etc.)\n\n## Usage\n\n```yaml\n- uses: redis-developer/cae-otel-ci-visibility@v2\n  with:\n    junit-xml-folder: './test-results'\n    otlp-endpoint: 'https://otlp.example.com/v1/metrics'\n    otlp-headers: 'authorization=Bearer ${{ secrets.OTLP_TOKEN }}'\n```\n\n## Inputs\n\n| Input               | Required | Default | Description                                  |\n| ------------------- | -------- | ------- | -------------------------------------------- |\n| `junit-xml-folder`  | yes      | -       | Path to directory containing JUnit XML files |\n| `otlp-endpoint`     | yes      | -       | OTLP metrics endpoint URL                    |\n| `otlp-headers`      | no       | -       | OTLP headers (key=value,key2=value2 or JSON) |\n| `metrics-namespace` | no       | `cae`   | Namespace prefix for metrics                 |\n| `metrics-version`   | no       | `v13`   | Version identifier for metrics schema        |\n\n## Metrics\n\nGenerates a single, low-cardinality metric optimized for performance regression\ndetection:\n\n### `{namespace}_{version}_test_duration_seconds`\n\nA gauge metric recording individual test execution duration.\n\n**Labels:**\n\n| Label                         | Description                          | Cardinality |\n| ----------------------------- | ------------------------------------ | ----------- |\n| `test.id`                     | Unique test identifier (see below)   | Medium      |\n| `vcs.repository.name`         | Repository (e.g., `owner/repo`)      | Low         |\n| `vcs.repository.ref.name`     | Branch name (e.g., `main`, `master`) | Low         |\n| `vcs.repository.ref.revision` | Commit SHA                           | High        |\n\n**Total: 4 labels** - optimized to avoid Mimir/Prometheus query size limits.\n\n### Test ID Format\n\nThe `test.id` label combines suite, class, and test name into a human-readable\nidentifier with a hash suffix for uniqueness:\n\n```\nFormat: {ClassName}.{testMethodName}_{hash}\n\nExamples:\n- UserServiceTest.testLogin_a7f3b2\n- PaymentProcessor.testRefun_c4d8e1\n```\n\nThis provides:\n\n- **Human readability** - Identify the test at a glance in dashboards\n- **Uniqueness** - 6-char hash suffix handles collisions\n- **Determinism** - Same test always generates the same ID\n\n## Dashboard Integration\n\nExample Prometheus/Grafana queries for regression detection:\n\n```promql\n# Baseline: average duration on default branch over 7 days\navg by (test_id, vcs_repository_name) (\n  avg_over_time(\n    cae_v13_test_duration_seconds{\n      vcs_repository_ref_name=\"main\"\n    }[7d]\n  )\n)\n\n# Current: latest test duration\nmax by (test_id, vcs_repository_name) (\n  last_over_time(\n    cae_v13_test_duration_seconds{\n      vcs_repository_ref_name=\"main\"\n    }[1h]\n  )\n)\n\n# Regression detection: current \u003e 5x baseline\nmax by (test_id, vcs_repository_name) (\n  last_over_time(cae_v13_test_duration_seconds{vcs_repository_ref_name=\"main\"}[1h])\n)\n\u003e 5 * avg by (test_id, vcs_repository_name) (\n  avg_over_time(cae_v13_test_duration_seconds{vcs_repository_ref_name=\"main\"}[7d])\n)\n```\n\n## Automatic Context\n\nThe action automatically extracts from GitHub context:\n\n- Repository name (`owner/repo`)\n- Branch name\n- Commit SHA\n\nNo manual configuration needed for these values.\n\n## Requirements\n\n- JUnit XML files\n- OTLP-compatible metrics backend\n- Node.js 24+ runtime (provided by GitHub Actions)\n\n## Migration from v1 (v12 metrics)\n\nv2 uses a simplified, low-cardinality label set. Key changes:\n\n| v1 (v12)                          | v2 (v13)                     |\n| --------------------------------- | ---------------------------- |\n| `service_name` input required     | Auto-derived from repository |\n| `service_namespace` required      | Removed                      |\n| `deployment_environment` required | Removed                      |\n| `test_name` label                 | Folded into `test_id`        |\n| `test_class_name` label           | Folded into `test_id`        |\n| `test_suite_name` label           | Folded into `test_id`        |\n| `ci_run_id` label                 | Removed                      |\n| `ci_job_id` label                 | Removed                      |\n| 14+ labels                        | 4 labels                     |\n\nUpdate your dashboard queries to use `test_id` instead of separate\nname/class/suite labels.\n\n## Notes\n\n- Processes all `.xml` files in the specified directory\n- Combines multiple XML files into a single report\n- Handles malformed XML gracefully\n- No outputs - metrics are the deliverable\n\nBuilt for engineers who want observability without ceremony.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis-developer%2Fcae-otel-ci-visibility","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredis-developer%2Fcae-otel-ci-visibility","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis-developer%2Fcae-otel-ci-visibility/lists"}