aspera-cli 4.27.5 → 4.29.0

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.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +301 -4
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +139 -58
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +10 -7
  13. data/docs/README.md +2551 -772
  14. data/docs/test-mcp-with-ai.md +13 -11
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +34 -22
  19. data/lib/aspera/agent/factory.rb +8 -4
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +8 -5
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +23 -19
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +84 -42
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +102 -48
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +16 -37
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -34
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +49 -4
  50. data/lib/aspera/cli/command_spec.rb +34 -4
  51. data/lib/aspera/cli/completion/ascli.bash +53 -5
  52. data/lib/aspera/cli/completion/ascli.fish +27 -8
  53. data/lib/aspera/cli/completion/ascli.ps1 +63 -0
  54. data/lib/aspera/cli/completion/ascli.zsh +36 -4
  55. data/lib/aspera/cli/completion_actions.rb +594 -0
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +45 -0
  59. data/lib/aspera/cli/extended_value.rb +83 -24
  60. data/lib/aspera/cli/formatter.rb +142 -73
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -11
  63. data/lib/aspera/cli/http.rb +17 -13
  64. data/lib/aspera/cli/info.rb +17 -6
  65. data/lib/aspera/cli/mailer.rb +7 -4
  66. data/lib/aspera/cli/mcp/http_servlet.rb +155 -0
  67. data/lib/aspera/cli/mcp/secrets.rb +146 -0
  68. data/lib/aspera/cli/mcp/tool.rb +232 -0
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +72 -11
  73. data/lib/aspera/cli/options.schema.yaml +856 -81
  74. data/lib/aspera/cli/parser.rb +64 -31
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +250 -44
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +51 -25
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +207 -141
  81. data/lib/aspera/cli/plugins/console.rb +9 -4
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +22 -8
  84. data/lib/aspera/cli/plugins/faspex5.rb +37 -44
  85. data/lib/aspera/cli/plugins/faspio.rb +41 -8
  86. data/lib/aspera/cli/plugins/httpgw.rb +8 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +186 -121
  88. data/lib/aspera/cli/plugins/node.rb +41 -34
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +572 -59
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +66 -12
  93. data/lib/aspera/cli/plugins/shares.rb +288 -48
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +155 -33
  96. data/lib/aspera/cli/preset_manager.rb +72 -16
  97. data/lib/aspera/cli/prompt.rb +7 -2
  98. data/lib/aspera/cli/result.rb +28 -11
  99. data/lib/aspera/cli/runner.rb +193 -80
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +204 -0
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +119 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +32 -40
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +31 -19
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +197 -50
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.html.erb +61 -0
  113. data/lib/aspera/cli/web_secret.rb +222 -0
  114. data/lib/aspera/cli/wizard.rb +58 -45
  115. data/lib/aspera/command_line_builder.rb +35 -5
  116. data/lib/aspera/command_line_converter.rb +4 -1
  117. data/lib/aspera/coverage.rb +103 -33
  118. data/lib/aspera/data_repository.rb +42 -25
  119. data/lib/aspera/dot_container.rb +4 -1
  120. data/lib/aspera/duration.rb +45 -0
  121. data/lib/aspera/environment.rb +106 -33
  122. data/lib/aspera/exec_spec.rb +9 -5
  123. data/lib/aspera/faspex_gw.rb +105 -35
  124. data/lib/aspera/faspex_postproc.rb +193 -47
  125. data/lib/aspera/formatter_interface.rb +4 -2
  126. data/lib/aspera/graphql.rb +5 -1
  127. data/lib/aspera/hash_ext.rb +3 -0
  128. data/lib/aspera/id_generator.rb +6 -3
  129. data/lib/aspera/json_rpc/client.rb +55 -35
  130. data/lib/aspera/json_rpc/version.rb +4 -0
  131. data/lib/aspera/line_logger.rb +4 -1
  132. data/lib/aspera/link_header.rb +4 -1
  133. data/lib/aspera/log.rb +20 -10
  134. data/lib/aspera/markdown.rb +155 -115
  135. data/lib/aspera/mime.rb +9 -0
  136. data/lib/aspera/nagios.rb +9 -5
  137. data/lib/aspera/node_emulator.rb +111 -112
  138. data/lib/aspera/oauth/client/base.rb +163 -0
  139. data/lib/aspera/oauth/{boot.rb → client/boot.rb} +8 -4
  140. data/lib/aspera/oauth/{factory.rb → client/factory.rb} +13 -3
  141. data/lib/aspera/oauth/{generic.rb → client/generic.rb} +5 -1
  142. data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +4 -1
  143. data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +6 -3
  144. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  145. data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +4 -1
  146. data/lib/aspera/oauth/client/web.rb +84 -0
  147. data/lib/aspera/oauth/server/authorize.html.erb +34 -0
  148. data/lib/aspera/oauth/server/pkce.rb +427 -0
  149. data/lib/aspera/orchestrator_workflow_checker.rb +679 -0
  150. data/lib/aspera/persistency_action_once.rb +5 -3
  151. data/lib/aspera/persistency_folder.rb +6 -3
  152. data/lib/aspera/preview/file_types.rb +6 -3
  153. data/lib/aspera/preview/generator.rb +9 -5
  154. data/lib/aspera/preview/options.schema.yaml +3 -3
  155. data/lib/aspera/preview/terminal.rb +11 -6
  156. data/lib/aspera/preview/utils.rb +6 -4
  157. data/lib/aspera/products/connect.rb +5 -2
  158. data/lib/aspera/products/desktop.rb +4 -1
  159. data/lib/aspera/products/other.rb +4 -2
  160. data/lib/aspera/products/transferd.rb +6 -2
  161. data/lib/aspera/products/transferd_service.rb +610 -0
  162. data/lib/aspera/proxy_auto_config.js +2 -2
  163. data/lib/aspera/proxy_auto_config.rb +5 -2
  164. data/lib/aspera/rainbow.rb +30 -1
  165. data/lib/aspera/rest/aspera_errors.rb +55 -60
  166. data/lib/aspera/rest/call_error.rb +3 -0
  167. data/lib/aspera/rest/client.rb +42 -42
  168. data/lib/aspera/rest/error_analyzer.rb +14 -2
  169. data/lib/aspera/rest/list.rb +14 -10
  170. data/lib/aspera/rest/parameters.rb +3 -0
  171. data/lib/aspera/rest/util.rb +13 -4
  172. data/lib/aspera/rest.rb +9 -7
  173. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -11
  174. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4089 -0
  175. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
  176. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  177. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  178. data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
  179. data/lib/aspera/schema/async_tables.yaml +11 -10
  180. data/lib/aspera/schema/documentation.rb +56 -78
  181. data/lib/aspera/schema/reader.rb +46 -11
  182. data/lib/aspera/schema/registry.rb +45 -24
  183. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  184. data/lib/aspera/schema/validator.rb +4 -1
  185. data/lib/aspera/sealed_hash.rb +166 -0
  186. data/lib/aspera/secret/hider.rb +201 -0
  187. data/lib/aspera/secret/reference.rb +150 -0
  188. data/lib/aspera/secret/resolver.rb +212 -0
  189. data/lib/aspera/secret/store/base.rb +153 -0
  190. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  191. data/lib/aspera/secret/store/factory.rb +103 -0
  192. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  193. data/lib/aspera/secret/store/keeper.rb +141 -0
  194. data/lib/aspera/secret/store/macos_security.rb +284 -0
  195. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  196. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  197. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  198. data/lib/aspera/secret/store/secret_service.rb +125 -0
  199. data/lib/aspera/secret/strength.rb +119 -0
  200. data/lib/aspera/servlet_helpers.rb +114 -0
  201. data/lib/aspera/ssh.rb +10 -7
  202. data/lib/aspera/ssl.rb +5 -2
  203. data/lib/aspera/string_ext.rb +3 -0
  204. data/lib/aspera/sync/args.schema.yaml +6 -1
  205. data/lib/aspera/sync/conf.schema.yaml +25 -10
  206. data/lib/aspera/sync/database.rb +3 -0
  207. data/lib/aspera/sync/operations.rb +34 -12
  208. data/lib/aspera/temp_file_manager.rb +85 -22
  209. data/lib/aspera/timer_limiter.rb +3 -0
  210. data/lib/aspera/transfer/error.rb +4 -1
  211. data/lib/aspera/transfer/faux_file.rb +4 -1
  212. data/lib/aspera/transfer/parameters.rb +22 -14
  213. data/lib/aspera/transfer/result.rb +3 -0
  214. data/lib/aspera/transfer/resumer.rb +6 -4
  215. data/lib/aspera/transfer/spec.rb +45 -18
  216. data/lib/aspera/transfer/spec.schema.yaml +8 -5
  217. data/lib/aspera/transfer/units.rb +75 -0
  218. data/lib/aspera/uri_reader.rb +57 -7
  219. data/lib/aspera/web_auth/index.html.erb +20 -0
  220. data/lib/aspera/web_auth/paste.rb +109 -0
  221. data/lib/aspera/web_auth/receiver.rb +50 -0
  222. data/lib/aspera/web_auth/relay.rb +76 -0
  223. data/lib/aspera/web_auth/reply.html.erb +150 -0
  224. data/lib/aspera/web_auth/server.rb +59 -14
  225. data/lib/aspera/web_page.html.erb +262 -0
  226. data/lib/aspera/web_page.rb +66 -0
  227. data/lib/aspera/web_server_simple.rb +82 -13
  228. data/lib/aspera/yaml.rb +5 -1
  229. data/llms.txt +81 -0
  230. data/skills/ascli/SKILL.md +88 -0
  231. data.tar.gz.sig +0 -0
  232. metadata +116 -48
  233. metadata.gz.sig +0 -0
  234. data/lib/aspera/cli/mcp_tool.rb +0 -189
  235. data/lib/aspera/keychain/base.rb +0 -25
  236. data/lib/aspera/keychain/encrypted_hash.rb +0 -188
  237. data/lib/aspera/keychain/factory.rb +0 -59
  238. data/lib/aspera/keychain/hashicorp_vault.rb +0 -74
  239. data/lib/aspera/keychain/macos_security.rb +0 -171
  240. data/lib/aspera/keychain/one_password_api.rb +0 -86
  241. data/lib/aspera/keychain/one_password_base.rb +0 -34
  242. data/lib/aspera/keychain/one_password_cli.rb +0 -98
  243. data/lib/aspera/oauth/base.rb +0 -141
  244. data/lib/aspera/oauth/web.rb +0 -57
  245. data/lib/aspera/oauth.rb +0 -9
  246. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
  247. data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
  248. data/lib/aspera/secret_hider.rb +0 -117
  249. data/lib/aspera/web_auth/index.html +0 -147
@@ -0,0 +1,217 @@
1
+ # frozen_string_literal: true
2
+
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ # cspell:ignore reuseaddr sourcelist BUFS ERANGE
7
+ require_relative 'management'
8
+
9
+ module Aspera
10
+ module Ascp
11
+ # Error codes of FASP sessions: `errcode` in log lines `Session Start` and `Session Stop` of `ascp`.
12
+ # Not the same numbering as errors of the management port (`Management::ERRORS`): each code maps to one of them.
13
+ # References:
14
+ # `fasp_errno.h` : codes (enum `fasp_errno_e`)
15
+ # `fasp_errno.c` : messages (`fasp_errno2str`)
16
+ # `asmgmt_err.c` : code of management port (`mgmt_fasperr2mgmterr`)
17
+ module SessionErrors
18
+ # Code => name, code of management port (mnemonic in `Management::ERRORS`), category (see CATEGORIES), message
19
+ CODES = {
20
+ 1 => ['bad_version', 'INTERNAL_ERROR', 'configuration', 'Bad version'],
21
+ 2 => ['bad_protocol', 'FASP_PROTO', 'configuration', 'Bad protocol'],
22
+ 3 => ['srcpath_check_failed', 'BAD_PATH', 'path', 'Source path check failed'],
23
+ 4 => ['dstpath_check_failed', 'BAD_PATH', 'path', 'Destination path check failed'],
24
+ 5 => ['incompat_mod_proto_vers', 'FASP_PROTO', 'configuration', 'FASP module protocol versions incompatible'],
25
+ 6 => ['incompat_pipeline_depth', 'INTERNAL_ERROR', 'configuration', 'FASP pipeline depths incompatible'],
26
+ 7 => ['sess_stopped', 'USER_CANCEL', 'aborted', 'Session initiation stopped by application'],
27
+ 8 => ['connect_sock', 'CONNECTION_ERROR', 'udp_setup', 'Unable to connect UDP socket'],
28
+ 9 => ['send_stop', 'CONNECTION_ERROR', 'udp_setup', 'Unable to send STOP message'],
29
+ 10 => ['recv_stop', 'CONNECTION_ERROR', 'udp_setup', 'Unable to recv STOP message'],
30
+ 11 => ['c_noresp', 'CONNECTION_TIMEOUT', 'udp_setup',
31
+ 'Client unable to connect to server (check UDP port and firewall)'],
32
+ 12 => ['s_noresp', 'CONNECTION_TIMEOUT', 'udp_setup',
33
+ 'Server unable to hear from client (check UDP port and firewall)'],
34
+ 13 => ['unconcluded_pmtu_brtt', 'PMTU_BRTT_ERROR', 'udp_setup', 'Unable to conclude a valid pmtu-brtt value'],
35
+ 14 => ['invalid_pmtu_brtt', 'PMTU_BRTT_ERROR', 'udp_setup', 'Unable to receive a valid stop message (pmtu-brtt)'],
36
+ 15 => ['unmatched_tl', 'SOCK_SETUP', 'udp_setup', 'Incompatible timer levels between peers'],
37
+ 16 => ['unconcluded_bw', 'BWMEAS_ERROR', 'udp_setup', 'Unable to conclude a valid bw value'],
38
+ 17 => ['invalid_bw', 'BWMEAS_ERROR', 'udp_setup', 'Unable to receive a valid stop message (bwmeas)'],
39
+ 18 => ['ds_conn_lost', 'CONNECTION_LOST', 'network', 'Connection lost in midst of data session'],
40
+ 19 => ['peer_aborted_sess', 'PEER_ABORTED_SESSION', 'aborted', 'Peer aborted session'],
41
+ 20 => ['ds_proto_magic_mismatch', 'FASP_PROTO', 'network', 'Data session protocol error, magic mismatch'],
42
+ 21 => ['ds_proto_pdutype_invalid', 'FASP_PROTO', 'network', 'Data session protocol error, pdu type invalid'],
43
+ 22 => ['ds_proto_msg_toosmall', 'FASP_PROTO', 'network', 'Data session protocol error, message too small'],
44
+ 23 => ['ds_proto_msg_toobig', 'FASP_PROTO', 'network', 'Data session protocol error, message too big'],
45
+ 24 => ['internal_disk_thread', 'THREAD_SPAWN', 'storage', 'Internal disk thread error'],
46
+ 25 => ['internal_ring', 'INTERNAL_ERROR', 'other', 'Internal ring error'],
47
+ 26 => ['internal_out_of_mem', 'OUT_OF_MEMORY', 'other', 'Internal memory error'],
48
+ 27 => ['sess_other', 'TRANSFER_ERROR', 'other', 'Other Session error'],
49
+ 28 => ['xfer_other', 'SOME_FILE_ERRS', 'files', 'Other Transfer error'],
50
+ 29 => ['sess_internal', 'INTERNAL_ERROR', 'other', 'Session internal error'],
51
+ 30 => ['sess_conn_tmout', 'CONNECTION_TIMEOUT', 'network', 'Session connection timeout'],
52
+ 31 => ['sess_rex_send', 'RCVR_SEND_ERROR', 'network', 'Retransmit request send error'],
53
+ 32 => ['sess_stats_send', 'RCVR_SEND_ERROR', 'network', 'Stats request send error'],
54
+ 33 => ['sess_reception', 'CONNECTION_LOST', 'network', 'Data reception error'],
55
+ 34 => ['xfer_external_abort', 'PEER_ABORTED_SESSION', 'aborted', 'External abort of transfer'],
56
+ 35 => ['xfer_transfer_tmout', 'DATA_TRANSFER_TIMEOUT', 'network', 'Data transfer timeout'],
57
+ 36 => ['sess_transfer_tmout', 'DATA_TRANSFER_TIMEOUT', 'network', 'Session data transfer timeout'],
58
+ 37 => ['xfer_test_internal_abort_err', 'PEER_ABORTED_SESSION', 'other', 'Session internal abort'],
59
+ 38 => ['lic_read', 'LIC_NOLIC', 'license', 'Unable to read license'],
60
+ 39 => ['lic_expired', 'LIC_EXPIRED', 'license', 'License expired'],
61
+ 40 => ['lic_illegal', 'LIC_ILLEGAL', 'license', 'Operation not permitted by license'],
62
+ 41 => ['lic_bw_exceeded', 'LIC_RATE_EXCEEDED', 'license', 'License bandwidth cap exceeded'],
63
+ 42 => ['lic_duplicate', 'LIC_DUP', 'license', 'Duplicate license'],
64
+ 43 => ['sock_addrinfo', 'SOCK_SETUP', 'socket', 'Error getting socket information'],
65
+ 44 => ['sock_set_reuse', 'SOCK_SETUP', 'socket', 'Error setting socket reuseaddr'],
66
+ 45 => ['sock_recvbuf', 'SOCK_SETUP', 'socket', 'Error setting socket recv buffer size'],
67
+ 46 => ['sock_sendbuf', 'SOCK_SETUP', 'socket', 'Error setting socket send buffer size'],
68
+ 47 => ['sock_bind', 'SOCK_SETUP', 'socket', 'Error binding socket to port'],
69
+ 48 => ['sock_create', 'SOCK_SETUP', 'socket', 'Error creating socket'],
70
+ 49 => ['resrc_disk_buf', 'INTERNAL_ERROR', 'storage', 'Out of disk buffers'],
71
+ 50 => ['no_such_file', 'NO_SUCH_FILE', 'storage', 'No such file or directory'],
72
+ 51 => ['no_perms', 'NO_PERMS', 'storage', 'Insufficient permissions'],
73
+ 52 => ['no_space_left', 'NO_SPACE_LEFT', 'storage', 'No space left on disk'],
74
+ 53 => ['not_dir', 'NOT_DIR', 'storage', 'Target must be a directory'],
75
+ 54 => ['is_dir', 'IS_DIR', 'storage', 'Expected regular file'],
76
+ 55 => ['file_table_overflow', 'FILE_TABLE_OVR', 'storage', 'File table overflow'],
77
+ 56 => ['too_many_files', 'TOO_MANY_FILES', 'storage', 'Too many files open'],
78
+ 57 => ['file_too_big', 'FILE_TOO_BIG', 'storage', 'File too big for filesystem'],
79
+ 58 => ['read_only_fs', 'READ_ONLY_FS', 'storage', 'Read only filesystem'],
80
+ 59 => ['disk_read', 'DISK_READ', 'storage', 'Disk read failed'],
81
+ 60 => ['disk_write', 'DISK_WRITE', 'storage', 'Disk write failed'],
82
+ 61 => ['srclist_count_invalid', 'INTERNAL_ERROR', 'path', 'Too many source files specified'],
83
+ 62 => ['srclist_not_specified', 'USAGE', 'path', 'Source file list not specified'],
84
+ 63 => ['srcpath_stat_failed', 'STAT_FAILS', 'path', 'Source path stat failed'],
85
+ 64 => ['dstpath_does_not_preexist', 'NOT_DIR', 'path', 'Destination path must preexist'],
86
+ 65 => ['dstpath_is_not_dir', 'NOT_DIR', 'path', 'Destination path must be a directory'],
87
+ 66 => ['dstpath_dir_create_failed', 'BAD_PATH', 'path', 'Destination directory create failed'],
88
+ 67 => ['untranslated_syserrno', 'INTERNAL_ERROR', 'other', 'Untranslated system errno'],
89
+ 68 => ['user_aborted_sess', 'USER_CANCEL', 'aborted', 'User aborted session'],
90
+ 69 => ['ds_resp_unknown', 'FASP_PROTO', 'other', 'Transfer response unknown'],
91
+ 70 => ['ds_resp_err_other', 'FASP_PROTO', 'other', 'Transfer response other error'],
92
+ 71 => ['ds_resp_err_eexist', 'ALREADY_EXISTS', 'storage', 'File already exists'],
93
+ 72 => ['ds_resp_err_aspx', 'UNAUTHORIZED', 'path', 'File is a .aspx file'],
94
+ 73 => ['mgmt_auth_refused', 'UNAUTHORIZED', 'management', 'Management authorization refused'],
95
+ 74 => ['mgmt_conn_lost', 'CONNECTION_LOST', 'management', 'Management connection lost'],
96
+ 75 => ['mgmt_auth_timeout', 'UNAUTHORIZED', 'management', 'Management authorization timeout'],
97
+ 76 => ['had_file_errors', 'SOME_FILE_ERRS', 'files', 'One or more transfers failed'],
98
+ 77 => ['disallowed_path', 'BAD_PATH', 'path', 'File location is outside \'docroot\' hierarchy'],
99
+ 78 => ['filename_too_long', 'FILEPATH_TOO_LONG', 'path', 'Filename too long'],
100
+ 79 => ['not_regular_file', 'NOT_REGULAR', 'storage', 'Not a regular file'],
101
+ 80 => ['lic_keyinvalid', 'LIC_ILLEGAL', 'license', 'Invalid license key'],
102
+ 81 => ['vlink_init_err', 'VLINK_ERROR', 'configuration', 'virtual link initialization failed'],
103
+ 82 => ['vlink_start_err', 'VLINK_ERROR', 'configuration', 'virtual link failed to start up'],
104
+ 83 => ['file_encryption_err', 'FILE_ENCRYPTION_ERROR', 'storage', 'File encryption error'],
105
+ 84 => ['dstpath_invalid', 'BAD_PATH', 'path', 'Destination path invalid'],
106
+ 85 => ['config_file_not_found', 'BAD_CONFIGURATION', 'configuration', 'Configuration file not found'],
107
+ 86 => ['config_file_invalid', 'BAD_CONFIGURATION', 'configuration', 'Invalid configuration file'],
108
+ 87 => ['file_decryption_pass', 'FILE_DECRYPTION_PASS', 'storage', 'File decryption error, bad passphrase'],
109
+ 88 => ['docroot_invalid', 'BAD_PATH', 'path', 'Destination path create failed, invalid docroot'],
110
+ 89 => ['ssh_auth_failed', 'AUTH', 'authentication', 'SSH authentication failed'],
111
+ 90 => ['user_aborted_xfer', 'USER_CANCEL', 'aborted', 'User aborted transfer'],
112
+ 91 => ['cannot_readlink', 'DISK_READ', 'storage', 'Cannot readlink'],
113
+ 92 => ['cannot_rename_partial', 'CANNOT_RENAME_PARTIAL', 'storage', 'Cannot rename partial file'],
114
+ 93 => ['vlink_stop_err', 'VLINK_ERROR', 'configuration', 'virtual link shutdown failure'],
115
+ 94 => ['mgmt_lic_timeout', 'FASP_PROTO', 'license', 'Management license data timeout'],
116
+ 95 => ['too_many_rms', 'INTERNAL_ERROR', 'configuration', 'Too many rate modules'],
117
+ 96 => ['storage_inaccessible', 'INTERNAL_ERROR', 'storage', 'Storage inaccessible'],
118
+ 97 => ['reading_sourcelist', 'USAGE', 'path', 'Error reading sourcelist from command line'],
119
+ 98 => ['reading_token', 'USAGE', 'authentication', 'Error reading token'],
120
+ 99 => ['allocating_chunked_token', 'USAGE', 'authentication', 'Internal error - failed to allocate space for chunked token'],
121
+ 100 => ['extracting_master_token', 'USAGE', 'authentication', 'Invalid token - failed to extract master'],
122
+ 101 => ['extracting_subchunk_token', 'USAGE', 'authentication',
123
+ 'Invalid token - token only contains subset of file paths submitted'],
124
+ 102 => ['too_many_file_paths', 'USAGE', 'path', 'Too many file paths, increase CMDLINE_MAX_BUFS'],
125
+ 103 => ['reading_file_stdin', 'USAGE', 'path', 'Error reading file list from file/stdin'],
126
+ 104 => ['empty_file_list_from_stdin_or_file', 'USAGE', 'path', 'Empty file list from file/stdin'],
127
+ 105 => ['token_filepath_mismatch', 'USAGE', 'path', 'Token doesn\'t match file-list/file-pair-list'],
128
+ 106 => ['usage', 'USAGE', 'configuration', 'Usage error'],
129
+ 107 => ['conn_insecure', 'INSECURE_CONNECTION', 'authentication', 'Remote host is not who we expected'],
130
+ 108 => ['start_validation', 'START_VALIDATION_FAILED', 'validation', 'Start validation failed'],
131
+ 109 => ['stop_validation', 'STOP_VALIDATION_FAILED', 'validation', 'Stop validation failed'],
132
+ 110 => ['threshold_validation', 'THRESHOLD_VALIDATION_FAILED', 'validation', 'Threshold validation failed'],
133
+ 111 => ['network_down', 'CONNECTION_LOST', 'network', 'Network down'],
134
+ 112 => ['address_not_available', 'CONNECTION_ERROR', 'network', 'Address not available'],
135
+ 113 => ['out_of_range', 'CHUNK_MUST_MATCH_ALIGNMENT', 'configuration', 'Value out of expected range (AS_ERANGE)'],
136
+ 114 => ['invalid_argument', 'USAGE', 'configuration', 'Invalid argument'],
137
+ 115 => ['server_multi_session_not_supported', 'USAGE', 'configuration', 'Server version of multi-session transfer is not supported'],
138
+ 116 => ['client_multi_session_not_supported', 'USAGE', 'configuration', 'Client version of multi-session transfer is not supported'],
139
+ 117 => ['illegal_chars_in_path', 'ILLEGAL_CHARS_IN_PATH', 'path', 'Path contains unsupported characters'],
140
+ 118 => ['inconsistent_source_uri', 'USAGE', 'path', 'All source paths must start with the same URI schema'],
141
+ 119 => ['list_uri_not_allowed', 'USAGE', 'path', 'file-pair-list destination cannot be a URI'],
142
+ 120 => ['persistent_uri_not_allowed', 'USAGE', 'path',
143
+ 'URIs not supported in source or destination management parameters'],
144
+ 121 => ['source_archive_mismatch', 'USAGE', 'path', 'Source and archive paths must start with the same URI schema'],
145
+ 122 => ['server_stdio', 'USAGE', 'path', 'Stdio/stdio-tar schema not supported on server'],
146
+ 123 => ['invalid_docroot_dest_combination', 'USAGE', 'path', 'Destination cannot be URI if docroot defined'],
147
+ 124 => ['token_URI_without_docroot_unsupported', 'USAGE', 'path', 'Token only supported for URIs using docroot'],
148
+ 125 => ['invalid_chunk_size', 'USAGE', 'configuration', 'Invalid chunk size'],
149
+ 126 => ['fasp_session_open', 'CONNECTION_ERROR', 'network', 'FASP session open error'],
150
+ 127 => ['fasp_session_accept', 'CONNECTION_ERROR', 'network', 'FASP session accept error'],
151
+ 128 => ['sess_transfer_error', 'CONNECTION_LOST', 'network', 'FASP session transfer error'],
152
+ 129 => ['upload_inprogress', 'UPLOAD_IN_PROGRESS', 'storage', 'File upload already in progress'],
153
+ 130 => ['validation_session_abort', 'VALIDATION_SESSION_ABORT', 'validation', 'FASP session stopped, validation error(s)'],
154
+ 131 => ['remote_storage_error', 'REMOTE_STORAGE_ERROR', 'storage', 'FASP session remote storage error'],
155
+ 132 => ['lua_session_abort', 'LUA_SCRIPT_ABORTED_SESSION', 'validation', 'Aborted session'],
156
+ 133 => ['auth_setup_incomplete', 'AUTHORIZATION', 'authentication', 'Authorization setup incomplete'],
157
+ 134 => ['ssear_retryable', 'SSEAR_RETRYABLE', 'storage', 'Server-side Encryption At Rest unavailable'],
158
+ 135 => ['ssear_fatal', 'SSEAR_FATAL', 'storage', 'Server-side Encryption At Rest failed'],
159
+ 136 => ['link_loop', 'LINK_LOOP', 'storage', 'Too many levels of symbolic links'],
160
+ 137 => ['cipher_non_compat_fips', 'CIPHER_NON_COMPAT_FIPS', 'configuration', 'Cipher not supported with FIPS mode'],
161
+ 138 => ['peer_requires_fips', 'PEER_REQUIRES_FIPS', 'configuration', 'FIPS support required on client and server'],
162
+ 139 => ['jobqueue_aborted', 'LUA_SCRIPT_ABORTED_SESSION', 'aborted', 'Async job aborted by initiator request'],
163
+ 140 => ['connection_error_http', 'CONNECTION_ERROR_HTTP', 'network', 'Connection lost during http session'],
164
+ 141 => ['min_version_fail', 'MIN_VERSION_CHECK', 'configuration', 'Failed to start due to minimum version check.'],
165
+ 142 => ['max_ascp', 'MAX_ASCP', 'server_limit', 'Failed to start session maximum transfer sessions exceeded'],
166
+ 143 => ['incompatible_resume_option', 'USAGE', 'configuration',
167
+ 'The server configuration is not compatible with the specified resume option']
168
+ }.freeze
169
+ # Category => hint for remediation
170
+ CATEGORIES = {
171
+ 'udp_setup' => 'The UDP session could not be established: check that the FASP UDP port (default 33001) is open in firewalls on both sides.',
172
+ 'network' => 'Network problem during the session: check network stability, packet loss, and UDP session timeouts of firewalls.',
173
+ 'aborted' => 'The session was aborted by the user, the peer or the application.',
174
+ 'license' => 'License problem: check the license, e.g. with `ascp -A`.',
175
+ 'socket' => 'Socket error: check that the UDP port is not used by another process, and the system socket limits.',
176
+ 'storage' => 'Storage error: check free space, permissions and access to the storage.',
177
+ 'path' => 'Path error: check source and destination paths, and docroot and restrictions of the transfer user.',
178
+ 'authentication' => 'Authentication failure: check credentials, SSH keys or token.',
179
+ 'management' => 'The management connection with the application that controls ascp (e.g. Node API) failed.',
180
+ 'files' => 'Some files failed: see the list of transferred files for the error of each file.',
181
+ 'validation' => 'A validation of the transfer (e.g. a script on the server) refused it.',
182
+ 'configuration' => 'Incompatible versions or configuration of peers: check versions and configuration.',
183
+ 'server_limit' => 'The server refused the session: maximum number of concurrent ascp processes reached.'
184
+ }.freeze
185
+ # Category of codes without a specific cause, and of unknown codes
186
+ OTHER = 'other'
187
+
188
+ class << self
189
+ # @param code [Integer] error code
190
+ # @return [String] category of error code, see CATEGORIES
191
+ def category(code)
192
+ CODES.dig(code, 2) || OTHER
193
+ end
194
+
195
+ # @param category [String] category of error
196
+ # @return [String, nil] hint for remediation
197
+ def hint(category)
198
+ CATEGORIES[category]
199
+ end
200
+
201
+ # @param code [Integer] error code
202
+ # @return [Boolean, nil] true if a new attempt may succeed, as for the code of management port, nil if unknown
203
+ def retryable(code)
204
+ management = CODES.dig(code, 1) or return
205
+ Management.error_by_mnemonic(management)&.fetch(:r)
206
+ end
207
+
208
+ # @return [Array<Hash>] information on all error codes
209
+ def list
210
+ CODES.map do |code, (name, management, category, message)|
211
+ {'code' => code, 'name' => name, 'message' => message, 'category' => category, 'management' => management, 'retry' => retryable(code)}
212
+ end
213
+ end
214
+ end
215
+ end
216
+ end
217
+ end
data/lib/aspera/assert.rb CHANGED
@@ -1,5 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
3
6
  module Aspera
4
7
  # Generic error in gem
5
8
  class Error < StandardError
@@ -30,6 +33,7 @@ module Aspera
30
33
  # @return [nil]
31
34
  def report_error(type, message)
32
35
  if type.is_a?(Symbol)
36
+ require_relative 'log'
33
37
  Log.log.send(type, message)
34
38
  else
35
39
  raise type, message
@@ -1,8 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/agent/factory'
4
- require 'aspera/schema/registry'
5
- require 'aspera/schema/reader'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../agent/factory'
7
+ require_relative '../schema/registry'
8
+ require_relative '../schema/reader'
9
+ require_relative '../schema/documentation'
10
+ require_relative '../ascp/session_errors'
6
11
 
7
12
  module Aspera
8
13
  module Cli
@@ -44,21 +49,8 @@ module Aspera
44
49
  end
45
50
  end
46
51
 
47
- # Install the transfer SDK (ascp + transferd) from a URL or using the default source.
48
- # Version defaults to `Info::SDK_VERSION`; pass `LATEST` as argument to install the latest available version.
49
- # @param version [String, nil] version to install; nil means use the default SDK version
50
- # @return [Result::Status] installation result message
51
- def install_transfer_sdk(version: nil)
52
- asked_version = version.nil? ? Info::SDK_VERSION : version
53
- asked_version = nil if asked_version.eql?(SpecialValues::LATEST)
54
- sdk_url = options.get_option(:sdk_url, mandatory: true)
55
- sdk_url = nil if sdk_url.eql?(SpecialValues::DEF)
56
- name, ver, folder = Ascp::Installation.instance.install_sdk(url: sdk_url, version: asked_version)
57
- return Result::Status.new("Installed #{name} version #{ver} in #{folder}")
58
- end
59
-
60
52
  def action_ascp_info(**)
61
- SecretHider.instance.add_secret_keys(DataRepository::ELEMENTS)
53
+ Secret::Hider.instance.add_secret_keys(DataRepository::ELEMENTS)
62
54
  data = Ascp::Installation.instance.ascp_info
63
55
  data['ts'] = transfer.user_transfer_spec
64
56
  DataRepository::ELEMENTS.each_with_object(data) { |i, h| h[i.to_s] = DataRepository.instance.item(i) }
@@ -72,7 +64,9 @@ module Aspera
72
64
  Result::SingleObject.new(schema)
73
65
  end
74
66
 
75
- def action_ascp_errors(**)
67
+ # @param kind [Symbol] `management`: codes of the management port, `session`: codes of sessions, as `errcode` in logs
68
+ def action_ascp_errors(kind: :management, **)
69
+ return Result::ObjectList.new(Ascp::SessionErrors.list) if kind.eql?(:session)
76
70
  error_data = []
77
71
  Ascp::Management::ERRORS.each_pair do |code, prop|
78
72
  error_data.push(code: code, mnemonic: prop[:c], retry: prop[:r], info: prop[:a])
@@ -101,33 +95,18 @@ module Aspera
101
95
  def action_agents_show(agent_name:, **)
102
96
  names = Agent::Factory::ALL[agent_name]
103
97
  schema_key = AGENT_SCHEMA_KEY[agent_name]
104
- agent_info = {
98
+ Result::SingleObject.new({
105
99
  'name' => agent_name.to_s,
106
100
  'short' => names[:short].to_s,
107
101
  'description' => schema_key ? Schema::Registry.instance.reader(schema_key).current['description'].to_s : '(no configurable parameters)'
108
- }
109
- if schema_key
110
- properties = Schema::Registry.instance.reader(schema_key).current['properties'] || {}
111
- rows = properties.map do |pname, pdef|
112
- row = {'parameter' => pname, 'type' => pdef['type'].to_s, 'description' => pdef['description'].to_s}
113
- row['required'] = (Schema::Registry.instance.reader(schema_key).current['required'] || []).include?(pname) ? 'yes' : 'no'
114
- row['default'] = pdef.key?('default') ? pdef['default'].inspect : ''
115
- row['enum'] = pdef.key?('enum') ? pdef['enum'].join(', ') : ''
116
- row
117
- end
118
- return Result::ObjectList.new(rows, fields: %w[parameter required type default enum description])
119
- end
120
- Result::SingleObject.new(agent_info)
102
+ })
121
103
  end
122
104
 
123
105
  def action_agents_parameters(agent_name:, **)
124
106
  schema_key = AGENT_SCHEMA_KEY[agent_name]
125
107
  return Result::Nothing.new if schema_key.nil?
126
- properties = Schema::Registry.instance.reader(schema_key).current['properties'] || {}
127
- rows = properties.map do |pname, pdef|
128
- {'name' => pname, 'type' => pdef['type'].to_s, 'description' => pdef['description'].to_s}
129
- end
130
- Result::ObjectList.new(rows, fields: %w[name type description])
108
+ builder = Schema::Documentation.new(TerminalFormatter, Schema::Registry.instance.reader(schema_key)).build
109
+ Result::ObjectList.new(builder.rows, fields: builder.columns)
131
110
  end
132
111
  end
133
112
  end
@@ -0,0 +1,176 @@
1
+ # frozen_string_literal: true
2
+
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../schema/registry'
7
+ require_relative '../assert'
8
+ require_relative '../log'
9
+
10
+ module Aspera
11
+ module Cli
12
+ # Mixin for Config plugin: commands of `ascp logs`, analysis of `ascp` log files (sessions, statistics and diagnostics)
13
+ module AscpLogsActions
14
+ LOG_FILES = [{name: :paths, description: 'Log files (gzip supported), `-` for standard input, or folders with log files', multiple: true, complete: :file}].freeze
15
+ # Command => description, and default fields
16
+ LISTS = {
17
+ sessions: ['Sessions, with diagnostics', %w[pid session user direction peer status error error_category start transmitted_bytes average_rate loss_rate diagnostics]],
18
+ diagnostics: ['Diagnostics of sessions: id, severity, message', nil],
19
+ multi_sessions: ['Multi-session transfers: sessions with the same transfer identifier', nil],
20
+ snapshots: ['Aggregate rates (bps) per period', nil],
21
+ snapshot_sessions: ['Rates (bps) of sessions per period', nil],
22
+ peers: ['Sessions and errors by peer address', nil],
23
+ transfers: ['Transferred files', %w[session peer start path size status error]],
24
+ licenses: ['Licenses of local and peer systems', nil],
25
+ overdrives: ['Sessions with loss due to overdriving of network or storage, by peer', nil]
26
+ }.freeze
27
+ # Kind of record of log lines => description, and default fields
28
+ RECORDS = {
29
+ samples: ['Periodic statistics of sessions: `Receiver bl` or `Sender bl` line, with its `DS Qs` line', %w[time pid side rate.t rate.c rate.n prog.t prog.e]],
30
+ sessions: ['Sessions: `Session Start`, `Params`, `Stop` and `Statistics` lines, with license, MTU and rate lines of the process', %w[uuid pid start stop op status errstr user peer targetrate effective_rate]],
31
+ transfers: ['Files: `Transfer Start` and `Transfer Stop` lines', %w[uuid start stop op status file size rate]]
32
+ }.freeze
33
+ RECORD_KIND = {name: :kind, description: RECORDS.map { |kind, (description, _)| "#{kind}: #{description}" }.join(', '), allowed: RECORDS.keys}.freeze
34
+ # Default values of option `ascp_logs` (see schema `AscpLogsOptions`)
35
+ DEFAULTS = {'period' => 1, 'zero_bytes' => false, 'mtu' => nil, 'resolve' => false, 'thresholds' => {}, 'timezone' => nil, 'health_minutes' => 60, 'remote_max_size' => 268_435_456}.freeze
36
+ private_constant :LOG_FILES, :LISTS, :RECORDS, :RECORD_KIND, :DEFAULTS
37
+ # When a plugin class includes AscpLogsActions, register the :ascp_logs option
38
+ # in that class's DSL registry so Base#initialize auto-declares it,
39
+ # and add the class-level DSL methods of ClassMethods.
40
+ class << self
41
+ def included(base)
42
+ base.option(:ascp_logs, description: 'Ascp: log analysis (dot-notation: period, zero_bytes, mtu, resolve, thresholds, timezone, health_minutes, remote_max_size)', schema: Schema::Registry::ASCP_LOGS_OPTIONS)
43
+ base.extend(ClassMethods)
44
+ end
45
+ end
46
+
47
+ # Class-level DSL methods added to the plugin class that includes AscpLogsActions.
48
+ module ClassMethods
49
+ # DSL class method: declare the `logs` node and its commands.
50
+ # @param parent [Symbol, Array<Symbol>] path relative to current scope, e.g. :logs
51
+ # @param arguments [Array<Hash>] argument that gives the log files (default: local files)
52
+ def ascp_logs_commands(parent, arguments: LOG_FILES)
53
+ commands_under(parent, description: 'Analyze ascp log files') do
54
+ command(:summary, description: 'Statistics and findings', arguments: arguments, action: :action_ascp_logs_summary)
55
+ command(:health, description: 'Health check for monitoring', arguments: arguments, action: :action_ascp_logs_health)
56
+ LISTS.each do |name, (description, fields)|
57
+ command(name, description: description, arguments: arguments, action: ->(paths:, **) { Result::ObjectList.new(analyze_ascp_logs(paths).public_send(name), fields: fields) })
58
+ end
59
+ command(:records, description: 'Log lines parsed into records, with the field names of the log', arguments: [RECORD_KIND] + arguments, action: :action_ascp_logs_records)
60
+ command(:fields, description: 'Description of the fields of records', arguments: [RECORD_KIND], action: :action_ascp_logs_fields)
61
+ end
62
+ end
63
+ end
64
+
65
+ def action_ascp_logs_summary(paths:, **)
66
+ Result::SingleObject.new(analyze_ascp_logs(paths).summary)
67
+ end
68
+
69
+ # Health check for monitoring. Reports failed sessions and low efficiency sessions over the last N minutes.
70
+ # @param paths [Array<String>] Log files or folders
71
+ # @param now [Time, Integer, nil] Current reference time (can be injected for testing)
72
+ # @return [Aspera::Cli::Result::ObjectList] Nagios status list
73
+ def action_ascp_logs_health(paths:, now: nil, **)
74
+ require_relative '../nagios'
75
+ analyzer = analyze_ascp_logs(paths)
76
+ params = ascp_logs_params
77
+ health_minutes = params['health_minutes'].to_i
78
+
79
+ ref_time = now ? now.to_i : Time.now.to_i
80
+
81
+ failed_count = 0
82
+ low_efficiency_count = 0
83
+
84
+ analyzer.log_files.each do |log_file|
85
+ windows_log = log_file.path.match?(/\w:/)
86
+ log_file.sessions.each do |s|
87
+ start_time = s[:start]
88
+ next unless start_time && start_time >= (ref_time - health_minutes * 60) && start_time <= ref_time
89
+
90
+ s.report(windows_log: windows_log)
91
+ failed_count += 1 if s[:status] == 'failed'
92
+ low_efficiency_count += 1 if s.diagnostics.any? { |d| d['id'] == 'low_efficiency' }
93
+ end
94
+ end
95
+
96
+ nagios = Nagios.new
97
+ msg = "#{failed_count} failed, #{low_efficiency_count} low efficiency in last #{health_minutes} min"
98
+ if failed_count.positive?
99
+ nagios.add_critical('ascp logs', msg)
100
+ elsif low_efficiency_count.positive?
101
+ nagios.add_warning('ascp logs', msg)
102
+ else
103
+ nagios.add_ok('ascp logs', msg)
104
+ end
105
+
106
+ Result::ObjectList.new(nagios.status_list)
107
+ end
108
+
109
+ def action_ascp_logs_records(kind:, paths:, **)
110
+ require_relative '../ascp/log_analyzer'
111
+ ascp_logs_files(paths) do |files|
112
+ check_ascp_logs_paths(files)
113
+ Result::ObjectList.new(Ascp::LogAnalyzer::Records.list(kind, files, timezone: ascp_logs_params['timezone']), fields: RECORDS[kind].last)
114
+ end
115
+ rescue ParameterError => e
116
+ raise BadArgument, e.message
117
+ end
118
+
119
+ def action_ascp_logs_fields(kind:, **)
120
+ require_relative '../ascp/log_analyzer'
121
+ require_relative '../schema/documentation'
122
+ builder = Schema::Documentation.new(TerminalFormatter, Schema::Registry.instance.reader(Ascp::LogAnalyzer::Records::SCHEMAS[kind])).build
123
+ Result::ObjectList.new(builder.rows, fields: builder.columns)
124
+ end
125
+
126
+ private
127
+
128
+ # @param paths [Array<String>] log files or folders
129
+ # @return [Aspera::Ascp::LogAnalyzer]
130
+ def analyze_ascp_logs(paths)
131
+ require_relative '../ascp/log_analyzer'
132
+ params = ascp_logs_params
133
+ user_thresholds = (params['thresholds'] || {}).transform_keys(&:to_s)
134
+ analyzer = Ascp::LogAnalyzer.new(
135
+ period: params['period'] * 60,
136
+ zero_bytes: params['zero_bytes'],
137
+ mtu: params['mtu'],
138
+ resolve: params['resolve'],
139
+ thresholds: user_thresholds,
140
+ timezone: params['timezone']
141
+ )
142
+ ascp_logs_files(paths) do |files|
143
+ check_ascp_logs_paths(files)
144
+ files.each do |path|
145
+ Log.log.debug { "Analyzing: #{path}" }
146
+ analyzer.add(path)
147
+ end
148
+ end
149
+ analyzer.warnings.each { |warning| Log.log.warn(warning) }
150
+ analyzer
151
+ rescue ParameterError => e
152
+ raise BadArgument, e.message
153
+ end
154
+
155
+ # Local log files or folders to analyze, for the paths given as arguments.
156
+ # A plugin that gets logs elsewhere (e.g. `server logs`) redefines this method: files exist only during the block.
157
+ # @param paths [Array<String>] arguments of the command
158
+ # @yieldparam files [Array<String>] local log files or folders
159
+ def ascp_logs_files(paths)
160
+ yield(paths)
161
+ end
162
+
163
+ # @return [Hash] value of option `ascp_logs`, with defaults
164
+ def ascp_logs_params
165
+ DEFAULTS.merge((options.get_option(:ascp_logs) || {}).transform_keys(&:to_s))
166
+ end
167
+
168
+ # Standard input (`-`) is read by the analyzer
169
+ def check_ascp_logs_paths(paths)
170
+ paths.each do |path|
171
+ Aspera.assert(path == Ascp::LogAnalyzer::STDIN_PATH || File.exist?(path), type: BadArgument) { "No such file or folder: #{path}" }
172
+ end
173
+ end
174
+ end
175
+ end
176
+ end
@@ -1,7 +1,10 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/log'
4
- require 'aspera/secret_hider'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../log'
7
+ require_relative '../secret/hider'
5
8
  require 'json'
6
9
  require 'securerandom'
7
10
 
@@ -63,7 +66,7 @@ module Aspera
63
66
  # Keys whose name starts with '_' are in-process references (e.g. '_agent_ref'), and secrets (e.g. agent `password`)
64
67
  # are not written on disk: they are intentionally excluded from the JSON serialization — at every nesting level.
65
68
  # @param job_id [String] the ascli-generated UUID
66
- # @param data [Hash] fields to store (will be JSON-serialised)
69
+ # @param data [Hash] fields to store (will be JSON-serialized)
67
70
  def write(job_id, data)
68
71
  Aspera.assert_type(job_id, String) { 'job_id' }
69
72
  Aspera.assert_type(data, Hash) { 'data' }
@@ -113,7 +116,7 @@ module Aspera
113
116
  case value
114
117
  when Hash
115
118
  value.each_with_object({}) do |(k, v), h|
116
- h[k] = persistable(v) unless k.to_s.start_with?('_') || SecretHider.instance.secret?(k, v)
119
+ h[k] = persistable(v) unless k.to_s.start_with?('_') || Secret::Hider.instance.secret?(k, v)
117
120
  end
118
121
  when Array
119
122
  value.map { |v| persistable(v) }