mattcasters commented on code in PR #9197: URL: https://github.com/apache/hop/pull/9197#discussion_r4435537280
########## docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc: ########## @@ -61,3 +61,18 @@ This field can be set empty when connections without password are allowed. * Critical |Message|The message to get logged. |=== + +== Result + +What this action passes on to the next action. See xref:workflow/action-results.adoc[Action results] for how results travel through a workflow. + +[options="header", width="90%", cols="1,3"] +|=== +|Result|Value +|True|The passive check was sent to the NSCA server, with 0 errors. The action sends the check and closes the connection without waiting for an answer. +|False|The number of errors is 1. *Host name/IP address* or *Message* is empty, the host name can't be resolved, the server refuses the connection, or the server doesn't send its first packet within *Response timeout*. Review Comment: **[suggestion]** This reads as the full failure list, but it skips a timeout the options table already documents. `NagiosPassiveCheckSender` applies *Connection timeout* to the TCP connect, before it waits *Response timeout* for the server's first packet. A host that drops the handshake, rather than refusing it, still fails the action with 1 error. A numeric port outside 0–65535 also fails (`InetSocketAddress` rejects it); only a non-numeric port is replaced by 5667. **Suggestion:** Add the connection timeout and an out-of-range port to the false row. ########## docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc: ########## @@ -32,17 +32,32 @@ The `Send SNMP trap` action sends alert messages to a remote SNMP-enabled device |Action name|The name of the workflow action. 2+|Server |Server name / IP address|The server host. -|Server port|The server port. +|Server port|The server port (default 162). A value that is not a number is replaced by 162. |OID|The object identifier. |Test connection|Can be used to test the connection. 2+|Advanced -|Target type|Type of target: Community or User. -|Community string|A user id or password that allows access to a router's or other device's statistics. +|Target type|Type of target: Community (SNMP V1) or User (SNMP V3). See the WARNING under <<Result>>. +|Community string|A user id or password that allows access to a router's or other device's statistics (default `public`). |User|The username to connect to the server |Passphrase|The password to connect to the server -|Engine ID| +|Engine ID|The context engine ID of the SNMP V3 trap (optional). |Retry|Number of retries. |Timeout|Timeout in milliseconds 2+|Message |Message|The message to send. |=== + +== Result + +What this action passes on to the next action. See xref:workflow/action-results.adoc[Action results] for how results travel through a workflow. + +[options="header", width="90%", cols="1,3"] +|=== +|Result|Value +|True|The trap was sent, with 0 errors. The action doesn't wait for an answer, so it is also true when nothing listens on *Server port*. An empty *Server name / IP address* sends the trap to the local machine, and an empty *OID* or *Message* is sent as it is. +|False|The number of errors is 1. *Server name / IP address* can't be resolved, or *OID* is not a valid object identifier (for example `abc`). Review Comment: **[suggestion]** A numeric *Server port* outside 0–65535 is not a successful fire-and-forget send, and it is not rewritten to 162. `UdpAddress.isValid()` is false, so `execute` throws and the action is false with 1 error. Only a value that is not a number becomes 162. **Suggestion:** Mention an out-of-range port in this false row. ########## docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteexecutioninfo.adoc: ########## @@ -49,3 +49,21 @@ Place it in a workflow that you run on a schedule when a location should not kee |=== An execution with no start date is deleted together with the ones that are old enough. Children of a deleted execution are removed with it. + +== Result + +What this action passes on to the next action. See xref:workflow/action-results.adoc[Action results] for how results travel through a workflow. + +[options="header", width="90%", cols="1,3"] +|=== +|Result|Value +|True|The executions were deleted, with 0 errors. No execution to delete, or a root folder that doesn't exist yet, is also true. The result is not used for hops: see the WARNING. +|False|The number of errors is 1. *Execution information location* is empty or doesn't exist, *Older than* is empty, 0, negative or not a number while *Delete all executions in this location* is unchecked, or an execution can't be deleted (for example a read-only folder). +|Result files|Passed on unchanged. +|Result rows|Passed on unchanged. +|Lines deleted|The number of executions deleted. A File location counts each run once, with everything it ran (child pipelines, actions, transforms). A Caching file location counts the workflow and each pipeline it ran separately. When the action is false, the value of the previous action is passed on. +|=== + +WARNING: A success or failure hop from this action is never followed, whatever the result: only an unconditional hop is. The result and the metrics are still passed on to the next action. + +NOTE: A Caching file location only deletes the executions of the project the workflow runs in. A File location deletes the executions of every project that writes to it. Review Comment: **[bug]** This note says a caching-file location deletes only the executions of the project the workflow runs in. `selectedForDelete` drops a file only when both project ids are non-empty and different (`matchesActiveProject` / `excludedProject`). An execution whose stored project id is empty is deleted anyway, and a workflow that itself has no `HOP_PROJECT_ID` deletes every execution in the folder. **Suggestion:** State that a missing project id, on the execution or on the workflow, is not a filter. The file-location half of the note is accurate. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
