ALOps PXM¶

Ships pipeline telemetry (YAML, task timeline, errors, warnings) to Hodor's PXM backend so the product can be improved based on real-world usage.

Property	Value
Task name (Azure DevOps)	`ALOpsPXM@3`
Action name (GitHub)	`alops-pxm`
Version	`3.0.0`
Category	Utility
OS requirement	Both
Preview	yes

Place this task last in your pipeline with condition: always() (Azure DevOps) or if: always() (GitHub Actions) so it captures the outcome of the whole run, including failures.

Set pxm_dry_run to true on first install to validate the payload locally — the task will print the JSON to the log without transmitting.

Inputs¶

behavior¶

Name	Type	Required	Default	Platform	Description
`pxm_dry_run`	PickList	no	`false`	Both	When 'true', the task prints the payload to the log and does NOT transmit. Use this on first install to validate. Options: `false`, `true`.
`pxm_include_yaml`	PickList	no	`true`	Both	Capture the resolved pipeline YAML and include it in the payload (gzipped, base64-encoded). Disable to ship metadata only. Options: `true`, `false`.
`pxm_max_payload_kb`	Text	no	`1024`	Both	Hard cap on the YAML portion of the payload (KB before gzip). Larger YAML is truncated.

transport¶

Name	Type	Required	Default	Platform	Description
`pxm_endpoint`	Text	no	(empty)	Both	Override the default Hodor PXM endpoint. Leave empty to use the default.
`pxm_auth_token`	Text	no	(empty)	Both	Bearer token issued by Hodor for your tenant. Leave empty to send unauthenticated (the backend may refuse).

Outputs¶

Name	Description
`pxm_event_id`	Opaque identifier for the emitted PXM event.
`pxm_payload_size_bytes`	Compressed payload size in bytes (after gzip).
`pxm_transmitted`	True if the payload was sent; false if dry-run or transport failure.
`pxm_status_code`	HTTP status code returned by the PXM backend (0 if not transmitted).

Usage¶

Azure DevOpsGitHub Actions

- task: ALOpsPXM@3
  displayName: 'ALOps PXM'
  inputs:
    pxm_dry_run: false                    # When 'true', the task prints the payload to the log and does NOT transmit. Use this on first install to validate. $(pxm_dry_run)
    pxm_include_yaml: true                # Capture the resolved pipeline YAML and include it in the payload (gzipped, base64-encoded). Disable to ship metadata only. $(pxm_include_yaml)
    pxm_max_payload_kb: 1024              # Hard cap on the YAML portion of the payload (KB before gzip). Larger YAML is truncated. $(pxm_max_payload_kb)
    pxm_endpoint:                         # Override the default Hodor PXM endpoint. Leave empty to use the default. $(pxm_endpoint)
    pxm_auth_token:                       # Bearer token issued by Hodor for your tenant. Leave empty to send unauthenticated (the backend may refuse). $(pxm_auth_token)

- name: ALOps PXM
  uses: HodorNV/ALOps-V3/alops-pxm@v3   <!-- TODO: confirm action repo path -->
  with:
    pxm_dry_run: 'false'
    pxm_include_yaml: 'true'
    pxm_max_payload_kb: '1024'
    pxm_endpoint: ''
    pxm_auth_token: ''