Update project logs #591

anthmatic · 2021-11-09T18:18:44Z

Description and Context

Updates hs project logs to work with both endpoint and appFunction logs

To retrieve endpoint logs:
hs project logs --function=endpoint/name

To retrieve appFunction logs
hs project logs --function=appFunctionName --appPath=app

Testing

Commands to run:

Endpoint logs:
hs project logs --function=endpoint/name
Tail Endpoint logs:
hs project logs --function=endpoint/name -follow

App function logs:
hs project logs --function=appFunctionName --appPath=app
Tail app function logs:
hs project logs --function=appFunctionName --appPath=app --follow

Screenshots

TODO

Who to Notify

markhazlewood · 2021-11-16T15:59:54Z

Couple comments/questions about the params:

--functionName - Propose we shorten this to just --function. In general including "name" in the label for something is redundant unless there's another common way to identify it. In this case I think function is clear enough.
--appPath - What exactly is this a path to? Is this still using the DFS tree path of the app.json file? If so, I'm not sure that's the best identifier since in the current workflow we don't surface the DFS file tree. Can we just provide a unique name and use --app instead?

anthmatic · 2021-11-16T18:17:36Z

Changing to --function makes sense to me.

--appPath refers to the path to the app within your project. Using https://github.com/HubSpot/getting-started-project-template as an example, the value for this option would be app

brandenrodgers · 2021-12-02T19:48:44Z

packages/cli/commands/logs.js

@@ -77,7 +77,7 @@ const endpointLog = async (accountId, options) => {
 };

 exports.command = 'logs [endpoint]';
-exports.describe = 'get logs for a function';


Does this logs command only work for project functions now?

kemmerle · 2021-12-02T19:55:42Z

packages/cli/commands/project/logs.js

 const { getProjectConfig } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { tailLogs } = require('../../lib/serverlessLogs');

 const handleLogsError = (e, accountId, projectName, appPath, functionName) => {
  if (e.statusCode === 404) {
    logger.error(
-      `No logs were found for the function name '${functionName}' in the app path '${appPath}' within the project '${projectName}' in account ${accountId}.`
+      appPath
+        ? `No logs were found for the function name '${functionName}' in the app path '${appPath}' within the project '${projectName}' in account ${accountId}.`


Is there any way to rephrase this? It's four prepositional phrases in a row, I'm getting a little lost. Perhaps we could consult Erin.

miketalley

miketalley · 2021-12-02T19:58:54Z

packages/cli/commands/logs.js

@@ -77,7 +77,7 @@ const endpointLog = async (accountId, options) => {
 };

 exports.command = 'logs [endpoint]';
-exports.describe = 'get logs for a function';
+exports.describe = 'get logs for a function within a project';


Is this only used to get logs for functions within a project? What about functions outside of projects?

miketalley · 2021-12-02T20:03:13Z

packages/cli/commands/project/logs.js

+      appPath: {
+        describe: 'Path to app folder, relative to project',
+        type: 'string',
+      },
      projectName: {


Should this be required? I get a TypeError when running hs project logs and only specifying --functionName...

Fixed on https://github.com/HubSpot/hubspot-cli/pull/591/files#diff-0caa64de5ff3fe3c960557dd2d69784fef280690b5c63e004cef47b0e4e7bdacR121

anthmatic · 2021-12-03T19:53:18Z

packages/cli-lib/lang/en.lyaml

+              noAppFunctionLogs: "No logs were found for the function name \"{{ functionName }}\" in the app path \"{{ appPath }}\" within the project \"{{ projectName }}\" in account {{ accountId }}."
+              noEndpointLogs: "No logs were found for the function name \"{{ functionName }}\" within the project \"{{ projectName }}\" in account {{ accountId }}."


@erincouse was hoping to get your feedback on these errors. They're shown when no logs are found

cc @kemmerle

anthmatic added 3 commits November 9, 2021 11:20

refactor option handling

7ae38e2

include endpoint results

6ada60f

rework error handling

d264b87

anthmatic mentioned this pull request Nov 9, 2021

Update hs project logs #589

Closed

update error message

4dfe1f6

anthmatic added 4 commits November 16, 2021 16:12

functionName -> function

bf6d7d9

clean up name and remove extra request

c13d1e4

update description

8cc5497

Merge branch 'master' into project-logs-v2

42f0c62

anthmatic marked this pull request as ready for review November 19, 2021 17:21

anthmatic requested review from miketalley and brandenrodgers November 19, 2021 20:51

brandenrodgers reviewed Dec 2, 2021

View reviewed changes

kemmerle reviewed Dec 2, 2021

View reviewed changes

miketalley reviewed Dec 2, 2021

View reviewed changes

anthmatic added 5 commits December 3, 2021 14:17

encode project name in request url

9f0d52c

revert accidental description change

8aecaa5

make sure project config exists

2efdd3c

Merge branch 'master' into project-logs-v2

d384024

fix no log found errors

45eff4c

anthmatic commented Dec 3, 2021

View reviewed changes

brandenrodgers approved these changes Dec 3, 2021

View reviewed changes

anthmatic merged commit 08c336c into master Dec 7, 2021

anthmatic deleted the project-logs-v2 branch December 7, 2021 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update project logs #591

Update project logs #591

Uh oh!

anthmatic commented Nov 9, 2021 •

edited

Loading

Uh oh!

markhazlewood commented Nov 16, 2021

Uh oh!

anthmatic commented Nov 16, 2021

Uh oh!

brandenrodgers Dec 2, 2021

Uh oh!

kemmerle Dec 2, 2021

Uh oh!

miketalley left a comment •

edited

Loading

Uh oh!

miketalley Dec 2, 2021

Uh oh!

miketalley Dec 2, 2021

Uh oh!

anthmatic Dec 3, 2021

Uh oh!

anthmatic Dec 3, 2021

Uh oh!

Uh oh!

		noAppFunctionLogs: "No logs were found for the function name \"{{ functionName }}\" in the app path \"{{ appPath }}\" within the project \"{{ projectName }}\" in account {{ accountId }}."
		noEndpointLogs: "No logs were found for the function name \"{{ functionName }}\" within the project \"{{ projectName }}\" in account {{ accountId }}."

Update project logs #591

Update project logs #591

Uh oh!

Conversation

anthmatic commented Nov 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description and Context

Testing

Screenshots

TODO

Who to Notify

Uh oh!

markhazlewood commented Nov 16, 2021

Uh oh!

anthmatic commented Nov 16, 2021

Uh oh!

brandenrodgers Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

kemmerle Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

miketalley left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miketalley Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

miketalley Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

anthmatic Dec 3, 2021

Choose a reason for hiding this comment

Uh oh!

anthmatic Dec 3, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anthmatic commented Nov 9, 2021 •

edited

Loading

miketalley left a comment •

edited

Loading