StackStorm / StackStorm/st2

Enhance Payload when a Sensor Fails

Open
#5,021 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

There seems to be a lack of overall information when it comes to getting payloads from core.st2.sensor.process_exit. It seems like there could be more information about what exactly caused the process to stop. Possibly from a user or an exception. It seems like it may be too difficult to tell just from that which maybe isn't a bad thing but I suppose getting some information from the trigger's payload would be effective as well.

{ "id": "[SensorName]", "timestamp": 1297101661, "exit_code": 1 }

That is currently what it looks like but maybe we could have some other fields like message, exception, or such to help better identify what has gone wrong? I understand logs can be written to determine these things and custom triggers so I am unsure the traction of this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names the core.st2.sensor.process_exit entry point and shows its current payload shape; start by locating where that payload is assembled. Clarify which failure context should be exposed and how it should be represented, then define completion around reliably distinguishing why a sensor process stopped.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.