fix(app): #1536 fix logging format to work with pino-pretty #1593

mohit-nagaraj · 2024-10-17T14:04:46Z

Summary

This PR introduces a new --output-json flag for the RunAppsGetLogs function in the DigitalOcean CLI (doctl). When this flag is used, the logs are outputted in JSON format without the service name and timestamp prefix.

Changes Made

Added --output-json flag to the RunAppsGetLogs function.
Modified the log processing logic to remove the service name and timestamp prefix when the --output-json flag is used.

Closes #1536

andrewsomething

Thanks for this great contribution @mohit-nagaraj! I do have some feedback:

For your new flag to work as expected, it needs to be registered with the command. You can see how that was done with other flags for the logs command here:

doctl/commands/apps.go

Lines 167 to 188 in 7f7a3c0

    
           	logs := CmdBuilder( 
        
           		cmd, 
        
           		RunAppsGetLogs, 
        
           		"logs <app id> <component name (defaults to all components)>", 
        
           		"Retrieves logs", 
        
           		`Retrieves component logs for a deployment of an app. 
        
           Three types of logs are supported and can be specified with the --`+doctl.ArgAppLogType+` flag: 
        
           - build 
        
           - deploy 
        
           - run 
        
           - run_restarted  
        
           For more information about logs, see [How to View Logs](https://www.digitalocean.com/docs/app-platform/how-to/view-logs/). 
        
           `, 
        
           		Writer, 
        
           		aliasOpt("l"), 
        
           	) 
        
           	AddStringFlag(logs, doctl.ArgAppDeployment, "", "", "Retrieves logs for a specific deployment ID. Defaults to current deployment.") 
        
           	AddStringFlag(logs, doctl.ArgAppLogType, "", strings.ToLower(string(godo.AppLogTypeRun)), "Retrieves logs for a specific log type. Defaults to run logs.") 
        
           	AddBoolFlag(logs, doctl.ArgAppLogFollow, "f", false, "Returns logs as they are emitted by the app.") 
        
           	AddIntFlag(logs, doctl.ArgAppLogTail, "", -1, "Specifies the number of lines to show from the end of the log.")

That is also where you add the information that shows in the help output.

I also think output-json might not be the best name for this flag. The output is only in JSON if your application logs in JSON. If you log in plain text, using the output-json would still produce plain text. Maybe something like no-prefix as it removes the prefixes from the logs? We could provide a hint in the help text that it useful for JSON structured logs.

mohit-nagaraj · 2024-10-18T16:27:08Z

Sure got it fixing them

mohit-nagaraj · 2024-10-20T11:14:02Z

Hey I updated code as specified, Could you re-review them will implement any of the changes you say

andrewsomething

👍 LGTM! Thanks again for the great contribution!

output formatting

8769d3e

andrewsomething requested changes Oct 17, 2024

View reviewed changes

Merge branch 'main' into main

5bec4ca

register flag

368ef25

mohit-nagaraj requested a review from andrewsomething October 20, 2024 11:12

mohit-nagaraj and others added 2 commits October 20, 2024 20:14

Small fix

dc5a34c

Add integration test.

0086a7f

andrewsomething approved these changes Oct 21, 2024

View reviewed changes

andrewsomething merged commit 0626468 into digitalocean:main Oct 21, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(app): #1536 fix logging format to work with pino-pretty #1593

fix(app): #1536 fix logging format to work with pino-pretty #1593

mohit-nagaraj commented Oct 17, 2024 •

edited

Loading

andrewsomething left a comment

mohit-nagaraj commented Oct 18, 2024

mohit-nagaraj commented Oct 20, 2024

andrewsomething left a comment

	logs := CmdBuilder(
	cmd,
	RunAppsGetLogs,
	"logs <app id> <component name (defaults to all components)>",
	"Retrieves logs",
	`Retrieves component logs for a deployment of an app.

	Three types of logs are supported and can be specified with the --`+doctl.ArgAppLogType+` flag:
	- build
	- deploy
	- run
	- run_restarted

	For more information about logs, see [How to View Logs](https://www.digitalocean.com/docs/app-platform/how-to/view-logs/).
	`,
	Writer,
	aliasOpt("l"),
	)
	AddStringFlag(logs, doctl.ArgAppDeployment, "", "", "Retrieves logs for a specific deployment ID. Defaults to current deployment.")
	AddStringFlag(logs, doctl.ArgAppLogType, "", strings.ToLower(string(godo.AppLogTypeRun)), "Retrieves logs for a specific log type. Defaults to run logs.")
	AddBoolFlag(logs, doctl.ArgAppLogFollow, "f", false, "Returns logs as they are emitted by the app.")
	AddIntFlag(logs, doctl.ArgAppLogTail, "", -1, "Specifies the number of lines to show from the end of the log.")

fix(app): #1536 fix logging format to work with pino-pretty #1593

fix(app): #1536 fix logging format to work with pino-pretty #1593

Conversation

mohit-nagaraj commented Oct 17, 2024 • edited Loading

Summary

Changes Made

andrewsomething left a comment

Choose a reason for hiding this comment

mohit-nagaraj commented Oct 18, 2024

mohit-nagaraj commented Oct 20, 2024

andrewsomething left a comment

Choose a reason for hiding this comment

mohit-nagaraj commented Oct 17, 2024 •

edited

Loading