- Notifications
You must be signed in to change notification settings - Fork1.4k
Add tail logs option#615
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+97 −13
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -584,6 +584,10 @@ func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (to | ||
| mcp.WithBoolean("return_content", | ||
| mcp.Description("Returns actual log content instead of URLs"), | ||
| ), | ||
| mcp.WithNumber("tail_lines", | ||
| mcp.Description("Number of lines to return from the end of the log"), | ||
| mcp.DefaultNumber(500), | ||
| ), | ||
| ), | ||
| func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { | ||
| owner, err := RequiredParam[string](request, "owner") | ||
| @@ -612,6 +616,14 @@ func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (to | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| tailLines, err := OptionalIntParam(request, "tail_lines") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| // Default to 500 lines if not specified | ||
| if tailLines == 0 { | ||
| tailLines = 500 | ||
| } | ||
| client, err := getClient(ctx) | ||
| if err != nil { | ||
| @@ -628,18 +640,18 @@ func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (to | ||
| if failedOnly && runID > 0 { | ||
| // Handle failed-only mode: get logs for all failed jobs in the workflow run | ||
| return handleFailedJobLogs(ctx, client, owner, repo, int64(runID), returnContent, tailLines) | ||
| } else if jobID > 0 { | ||
| // Handle single job mode | ||
| return handleSingleJobLogs(ctx, client, owner, repo, int64(jobID), returnContent, tailLines) | ||
| } | ||
| return mcp.NewToolResultError("Either job_id must be provided for single job logs, or run_id with failed_only=true for failed job logs"), nil | ||
| } | ||
| } | ||
| // handleFailedJobLogs gets logs for all failed jobs in a workflow run | ||
| func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo string, runID int64, returnContent bool, tailLines int) (*mcp.CallToolResult, error) { | ||
| // First, get all jobs for the workflow run | ||
| jobs, resp, err := client.Actions.ListWorkflowJobs(ctx, owner, repo, runID, &github.ListWorkflowJobsOptions{ | ||
| Filter: "latest", | ||
| @@ -671,7 +683,7 @@ func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo | ||
| // Collect logs for all failed jobs | ||
| var logResults []map[string]any | ||
| for _, job := range failedJobs { | ||
| jobResult, resp, err := getJobLogData(ctx, client, owner, repo, job.GetID(), job.GetName(), returnContent, tailLines) | ||
| if err != nil { | ||
| // Continue with other jobs even if one fails | ||
| jobResult = map[string]any{ | ||
| @@ -704,8 +716,8 @@ func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo | ||
| } | ||
| // handleSingleJobLogs gets logs for a single job | ||
| func handleSingleJobLogs(ctx context.Context, client *github.Client, owner, repo string, jobID int64, returnContent bool, tailLines int) (*mcp.CallToolResult, error) { | ||
| jobResult, resp, err := getJobLogData(ctx, client, owner, repo, jobID, "", returnContent, tailLines) | ||
| if err != nil { | ||
| return ghErrors.NewGitHubAPIErrorResponse(ctx, "failed to get job logs", resp, err), nil | ||
| } | ||
| @@ -719,7 +731,7 @@ func handleSingleJobLogs(ctx context.Context, client *github.Client, owner, repo | ||
| } | ||
| // getJobLogData retrieves log data for a single job, either as URL or content | ||
| func getJobLogData(ctx context.Context, client *github.Client, owner, repo string, jobID int64, jobName string, returnContent bool, tailLines int) (map[string]any, *github.Response, error) { | ||
| // Get the download URL for the job logs | ||
| url, resp, err := client.Actions.GetWorkflowJobLogs(ctx, owner, repo, jobID, 1) | ||
| if err != nil { | ||
| @@ -736,7 +748,7 @@ func getJobLogData(ctx context.Context, client *github.Client, owner, repo strin | ||
| if returnContent { | ||
| // Download and return the actual log content | ||
| content,originalLength,httpResp, err := downloadLogContent(url.String(), tailLines) //nolint:bodyclose // Response body is closed in downloadLogContent, but we need to return httpResp | ||
| if err != nil { | ||
| // To keep the return value consistent wrap the response as a GitHub Response | ||
| ghRes := &github.Response{ | ||
| @@ -746,6 +758,7 @@ func getJobLogData(ctx context.Context, client *github.Client, owner, repo strin | ||
| } | ||
| result["logs_content"] = content | ||
| result["message"] = "Job logs content retrieved successfully" | ||
| result["original_length"] = originalLength | ||
| } else { | ||
| // Return just the URL | ||
| result["logs_url"] = url.String() | ||
| @@ -757,25 +770,46 @@ func getJobLogData(ctx context.Context, client *github.Client, owner, repo strin | ||
| } | ||
| // downloadLogContent downloads the actual log content from a GitHub logs URL | ||
| func downloadLogContent(logURL string, tailLines int) (string, int, *http.Response, error) { | ||
| httpResp, err := http.Get(logURL) //nolint:gosec // URLs are provided by GitHub API and are safe | ||
| if err != nil { | ||
| return "",0,httpResp, fmt.Errorf("failed to download logs: %w", err) | ||
| } | ||
| defer func() { _ = httpResp.Body.Close() }() | ||
| if httpResp.StatusCode != http.StatusOK { | ||
| return "",0,httpResp, fmt.Errorf("failed to download logs: HTTP %d", httpResp.StatusCode) | ||
| } | ||
| content, err := io.ReadAll(httpResp.Body) | ||
| if err != nil { | ||
| return "",0,httpResp, fmt.Errorf("failed to read log content: %w", err) | ||
| } | ||
| // Clean up and format the log content for better readability | ||
| logContent := strings.TrimSpace(string(content)) | ||
| trimmedContent, lineCount := trimContent(logContent, tailLines) | ||
| return trimmedContent, lineCount, httpResp, nil | ||
| } | ||
| // trimContent trims the content to a maximum length and returns the trimmed content and an original length | ||
| func trimContent(content string, tailLines int) (string, int) { | ||
| // Truncate to tail_lines if specified | ||
| lineCount := 0 | ||
| if tailLines > 0 { | ||
| // Count backwards to find the nth newline from the end | ||
| for i := len(content) - 1; i >= 0 && lineCount < tailLines; i-- { | ||
| if content[i] == '\n' { | ||
| lineCount++ | ||
| if lineCount == tailLines { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. It might be worth a comment here explaining that there isn't an exit condition because we want the total line count. | ||
| content = content[i+1:] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return content, lineCount | ||
| } | ||
| // RerunWorkflowRun creates a tool to re-run an entire workflow run | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.