Improve strace output with better default options and detailed log headers

Author: cole-rgb

.github/workflows/test.yml

@@ -55,7 +55,7 @@ jobs:
         with:
           action-ref: "actions/hello-world-javascript-action@main"
           enable-strace: "true"
-          strace-options: "-f -e trace=open,close,network,write"
+          strace-options: "-f -v -s 256 -e trace=file,process,network,signal,ipc,desc,memory"
           input-who-to-greet: "Strace"
 
       - name: Check strace output

README.md

@@ -28,7 +28,7 @@ jobs:
 |-------|-------------|----------|---------|
 | `action-ref` | Reference to the nested action (e.g., owner/repo@ref) | Yes | |
 | `enable-strace` | Enable strace instrumentation | No | `true` |
-| `strace-options` | Options to pass to strace | No | `-f -e trace=network,write,open` |
+| `strace-options` | Options to pass to strace | No | `-f -v -s 256 -e trace=file,process,network,signal,ipc,desc,memory` |
 | `input-*` | Any input with the prefix `input-` will be passed to the nested action | No | |
 | `extra-args` | Extra arguments to pass to the nested action (deprecated, use `input-*` instead) | No | |
 
@@ -43,7 +43,7 @@ To pass inputs to the nested action, prefix them with `input-`. For example:
 
 | Output | Description |
 |--------|-------------|
-| `strace-log` | Path to the strace output log file (if strace was enabled and successful) |
+| `strace-log` | Path to the strace output log file. The filename includes timestamp and action name for easy identification. |
 
 ## Features
 
@@ -111,11 +111,12 @@ To pass inputs to the nested action, prefix them with `input-`. For example:
 ```yaml
 - name: Run with Strace
   id: strace-action
-  uses: testifysec/action-wrapper@v2
+  uses: testifysec/action-wrapper@v2.1.2
   with:
     action-ref: "actions/hello-world-javascript-action@main"
     enable-strace: "true"
-    strace-options: "-f -e trace=network,write,open,close -o /tmp/trace.log"
+    # Comprehensive tracing with improved verbosity
+    strace-options: "-f -v -s 256 -e trace=file,process,network,signal,ipc,desc,memory"
     input-who-to-greet: "World"  # Passed to the nested action as who-to-greet
 
 - name: Upload Strace Results
@@ -125,6 +126,12 @@ To pass inputs to the nested action, prefix them with `input-`. For example:
     path: ${{ steps.strace-action.outputs.strace-log }}
 ```
 
+The strace log will include a helpful header with:
+- Action reference
+- Timestamp
+- Command executed
+- Strace options used
+
 ### Disabling Strace
 
 ```yaml

action.yml

@@ -8,7 +8,7 @@ inputs:
     description: "Extra arguments to pass to the nested action (deprecated, use input-* instead)"
     required: false
   strace-options:
-    description: "Options to pass to strace (default: '-f -e trace=network,write,open')"
+    description: "Options to pass to strace (default: '-f -v -s 256 -e trace=file,process,network,signal,ipc,desc,memory')"
     required: false
   enable-strace:
     description: "Enable strace instrumentation (default: true)"

index.js

@@ -48,7 +48,9 @@ async function run() {
     // Get inputs
     const actionRef = core.getInput("action-ref");
     const extraArgs = core.getInput("extra-args") || "";
-    const straceOptions = core.getInput("strace-options") || "-f -e trace=network,write,open";
+    // Improved default strace options for better insights
+    const defaultStraceOptions = "-f -v -s 256 -e trace=file,process,network,signal,ipc,desc,memory";
+    const straceOptions = core.getInput("strace-options") || defaultStraceOptions;
     const enableStrace = core.getInput("enable-strace").toLowerCase() === "true";
 
     // Parse action-ref (expects format: owner/repo@ref)
@@ -223,8 +225,13 @@ async function processAction(actionDir, extraArgs) {
       // Parse strace options into an array
       const straceOptionsList = straceOptions.split(/\s+/).filter(Boolean);
 
-      // Create output file for strace results
-      const stracelLogFile = path.join(process.env.GITHUB_WORKSPACE || '.', 'strace-output.log');
+      // Create output file for strace results with timestamp and action name
+      const repoName = repo.split("/")[1];
+      const timestamp = new Date().toISOString().replace(/:/g, '-');
+      const stracelLogFile = path.join(
+        process.env.GITHUB_WORKSPACE || '.', 
+        `strace-${repoName}-${timestamp}.log`
+      );
 
       // Add output file option if not already specified
       if (!straceOptionsList.includes('-o') && !straceOptionsList.includes('--output')) {
@@ -259,6 +266,36 @@ async function processAction(actionDir, extraArgs) {
       const cp = await exec.getExecOutput("strace", [...straceOptionsList, "node", entryFile, ...args], options);
       core.debug(`Strace process completed with exit code: ${cp.exitCode}`);
 
+      // Add helpful headers to the strace log file
+      if (fs.existsSync(stracelLogFile)) {
+        // Create a temporary file for the header
+        const headerFile = `${stracelLogFile}.header`;
+        const header = `
+#=============================================================================
+# Strace log for GitHub Action: ${actionRef}
+# Date: ${new Date().toISOString()}
+# Command: node ${entryFile} ${args.join(" ")}
+# Options: ${straceOptions}
+#=============================================================================
+
+`;
+        fs.writeFileSync(headerFile, header);
+        
+        // Concatenate the header and the original strace output
+        const originalContent = fs.readFileSync(stracelLogFile);
+        fs.writeFileSync(stracelLogFile, Buffer.concat([
+          Buffer.from(header),
+          originalContent
+        ]));
+        
+        try {
+          // Delete the temporary header file
+          fs.unlinkSync(headerFile);
+        } catch (error) {
+          // Ignore any errors while deleting the temporary file
+        }
+      }
+      
       // Export the strace log path as an output
       core.setOutput("strace-log", stracelLogFile);