Skip to content

Commit 003d707

Browse files
committed
update readme.md
1 parent a062dcb commit 003d707

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,34 @@ Extracts test metrics from JUnit XML files and ships them to OTLP endpoints.
77
- Reads JUnit XML files from a directory
88
- Parses test results (passed/failed/skipped/errors)
99
- Generates OpenTelemetry metrics with proper semantic conventions
10-
- Ships metrics to OTLP-compatible backends
10+
- Ships metrics to OTLP-compatible backends. HTTP only for now, gRPC support
11+
coming soon.
1112

1213
## Usage
1314

1415
```yaml
15-
- uses: your-org/otel-ci-visibility@v1
16+
- uses: redis-developer/cae-otel-ci-visibility@v1
1617
with:
1718
junit-xml-folder: './test-results'
1819
service-name: 'my-service'
1920
service-namespace: 'my-team'
21+
service-version: 'v1.2.3'
2022
deployment-environment: 'ci'
2123
otlp-endpoint: 'https://otlp.example.com/v1/metrics'
2224
otlp-headers: 'authorization=Bearer ${{ secrets.OTLP_TOKEN }}'
2325
```
2426
2527
## Inputs
2628
27-
| Input | Required | Default | Description |
28-
| ------------------------ | -------- | --------------- | -------------------------------------------- |
29-
| `junit-xml-folder` | yes | - | Path to directory containing JUnit XML files |
30-
| `service-name` | yes | - | OpenTelemetry service name |
31-
| `service-namespace` | yes | - | OpenTelemetry service namespace |
32-
| `deployment-environment` | yes | `staging` | Deployment environment |
33-
| `otlp-endpoint` | yes | - | OTLP metrics endpoint URL |
34-
| `service-version` | no | git SHA | Service version |
35-
| `otlp-headers` | no | - | OTLP headers (key=value,key2=value2 or JSON) |
36-
| `otlp-protocol` | no | `http/protobuf` | OTLP protocol |
29+
| Input | Required | Default | Description |
30+
| ------------------------ | -------- | --------- | -------------------------------------------- |
31+
| `junit-xml-folder` | yes | - | Path to directory containing JUnit XML files |
32+
| `service-name` | yes | - | OpenTelemetry service name |
33+
| `service-namespace` | yes | - | OpenTelemetry service namespace |
34+
| `deployment-environment` | yes | `staging` | Deployment environment |
35+
| `otlp-endpoint` | yes | - | OTLP metrics endpoint URL |
36+
| `service-version` | no | git SHA | Service version |
37+
| `otlp-headers` | no | - | OTLP headers (key=value,key2=value2 or JSON) |
3738

3839
## Metrics
3940

@@ -50,7 +51,7 @@ All metrics include proper OpenTelemetry semantic conventions and CI context.
5051

5152
## Requirements
5253

53-
- JUnit XML files in standard format
54+
- JUnit XML files
5455
- OTLP-compatible metrics backend
5556
- Node.js 24+ runtime
5657

0 commit comments

Comments
 (0)