@pipeline-builder/pipeline-events 3.4.92 → 3.4.93
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,43 @@ AWS Lambda handler for [Pipeline Builder](https://mwashburn160.github.io/pipelin
|
|
|
15
15
|
|
|
16
16
|
CodeBuild `Build State` events are skipped: a build project can be shared across pipelines, so there is no clean 1:1 mapping to a pipeline id.
|
|
17
17
|
|
|
18
|
+
## Data forwarded to the platform
|
|
19
|
+
|
|
20
|
+
The Lambda forwards **only pipeline-execution telemetry** — enough to compute
|
|
21
|
+
success rates, stage/action timing, and DORA metrics. It runs **inside your AWS
|
|
22
|
+
account**; the reporting service only ever receives the normalized payload below.
|
|
23
|
+
|
|
24
|
+
### NOT forwarded (stays in your AWS account)
|
|
25
|
+
|
|
26
|
+
- **AWS account number** — explicitly stripped from every event (`delete detail.account`).
|
|
27
|
+
- **The pipeline ARN** (`arn:aws:codepipeline:<region>:<account>:<name>`) — built only as a
|
|
28
|
+
transient handle to look up the pipeline's `PIPELINE_EVENT_ID` tag, then discarded; it is
|
|
29
|
+
never stored or sent.
|
|
30
|
+
- **AWS credentials / IAM** and any account-identifying identifiers.
|
|
31
|
+
|
|
32
|
+
The platform stores no AWS account id anywhere (schemas, JWTs, and APIs are account-id-free
|
|
33
|
+
by design), so there is nothing to mask.
|
|
34
|
+
|
|
35
|
+
### Forwarded payload (per event)
|
|
36
|
+
|
|
37
|
+
`POST /api/reports/events` with a batch of:
|
|
38
|
+
|
|
39
|
+
| Field | Type | Notes |
|
|
40
|
+
|---|---|---|
|
|
41
|
+
| `pipelineId` | string | The **platform** pipeline id (from the `PIPELINE_EVENT_ID` tag) — not the ARN |
|
|
42
|
+
| `eventSource` | `codepipeline` | |
|
|
43
|
+
| `eventType` | `PIPELINE` \| `STAGE` \| `ACTION` | |
|
|
44
|
+
| `status` | enum | The CodePipeline state (`SUCCEEDED`/`FAILED`/…) |
|
|
45
|
+
| `idempotencyKey` | string | Deterministic dedupe key derived from the event's own identity (no PII) |
|
|
46
|
+
| `executionId` | string? | CodePipeline execution GUID |
|
|
47
|
+
| `stageName` / `actionName` | string? | |
|
|
48
|
+
| `errorMessage` | string? | Human-readable failure summary (capped), on failures |
|
|
49
|
+
| `startedAt` / `completedAt` | ISO 8601? | Event timestamps |
|
|
50
|
+
| `durationMs` | number? | |
|
|
51
|
+
| `commitSha` / `commitRef` | string? | Source revision — DORA deploy attribution |
|
|
52
|
+
| `environment` | string? | From the pipeline's `Environment` tag |
|
|
53
|
+
| `detail` | object | The raw CodePipeline event detail **with `account` removed** — carries the execution result (log URL, error code) for drill-down |
|
|
54
|
+
|
|
18
55
|
## Key exports
|
|
19
56
|
|
|
20
57
|
| Export | Purpose |
|