Add ability to retrieve and tail app function logs #490
Conversation
|
|
||
| const accountId = getAccountId(options); | ||
|
|
||
| trackCommandUsage('logs', { latest }, accountId); |
There was a problem hiding this comment.
One thing that I need to figure out is how we want to track the two, which may require a backend change to support additional event attributes.
There was a problem hiding this comment.
What about adding appPath and functionName to the tracking object along with latest?
There was a problem hiding this comment.
What about adding appPath and functionName to the tracking object along with latest?
I think the backend needs to support any event attributes that we add.
| spinner, | ||
| tailCall, | ||
| fetchLatest, | ||
| }); |
There was a problem hiding this comment.
One thing that I am not sure about is whether the indirection and passing in of functions is easy enough to follow.
There was a problem hiding this comment.
I think it's clear from the function name.
| accountId, | ||
| accountName: options.portal, |
There was a problem hiding this comment.
If we do want to show the account name instead of the id, we do need to incorporate something like this in the new code. That said, I think the way to handle that is to get the account config using the id so that it works consistently even in cases where the defaultPortal is used. We also should be consistent across all commands in terms of how we refer to an account in the output.
| spinner, | ||
| tailCall, | ||
| fetchLatest, | ||
| }); |
There was a problem hiding this comment.
I think it's clear from the function name.
|
|
||
| const accountId = getAccountId(options); | ||
|
|
||
| trackCommandUsage('logs', { latest }, accountId); |
There was a problem hiding this comment.
What about adding appPath and functionName to the tracking object along with latest?
packages/cli/lib/serverlessLogs.js
Outdated
| const readline = require('readline'); | ||
|
|
||
| const { outputLogs } = require('@hubspot/cli-lib/lib/logs'); | ||
| const { | ||
| logServerlessFunctionApiErrorInstance, | ||
| ApiErrorContext, | ||
| } = require('@hubspot/cli-lib/errorHandlers'); | ||
| const { base64EncodeString } = require('@hubspot/cli-lib/lib/encoding'); | ||
|
|
||
| const TAIL_DELAY = 5000; | ||
|
|
||
| const handleKeypressToExit = exit => { | ||
| readline.emitKeypressEvents(process.stdin); | ||
| process.stdin.setRawMode(true); | ||
| process.stdin.on('keypress', (str, key) => { | ||
| if (key && ((key.ctrl && key.name == 'c') || key.name === 'escape')) { | ||
| exit(); | ||
| } | ||
| }); | ||
| }; | ||
|
|
||
| const tailLogs = async ({ | ||
| accountId, | ||
| compact, | ||
| spinner, | ||
| fetchLatest, | ||
| tailCall, | ||
| }) => { | ||
| let initialAfter; | ||
|
|
||
| spinner.start(); | ||
|
|
||
| try { | ||
| const latestLog = await fetchLatest(); | ||
| initialAfter = base64EncodeString(latestLog.id); | ||
| } catch (e) { | ||
| // A 404 means no latest log exists(never executed) | ||
| if (e.statusCode !== 404) { | ||
| await logServerlessFunctionApiErrorInstance( | ||
| accountId, | ||
| e, | ||
| new ApiErrorContext({ accountId }) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| const tail = async after => { | ||
| const latestLog = await tailCall(after); | ||
|
|
||
| if (latestLog.results.length) { | ||
| spinner.clear(); | ||
| outputLogs(latestLog, { | ||
| compact, | ||
| }); | ||
| } | ||
|
|
||
| setTimeout(() => { | ||
| tail(latestLog.paging.next.after); | ||
| }, TAIL_DELAY); | ||
| }; | ||
|
|
||
| handleKeypressToExit(() => { | ||
| spinner.stop(); | ||
| process.exit(); | ||
| }); | ||
| tail(initialAfter); | ||
| }; | ||
|
|
||
| module.exports = { | ||
| tailLogs, | ||
| }; |
Not sure why this test started producing `undefined` in the ObjectTypeId column.
|
@miketalley I made an adjustment to fix situations where a function or endpoint hasn't been executed so there weren't any logs. This also improves situations where a fetching the latest log fails due to some intermittent error. |
| @@ -8,9 +9,16 @@ const full = require('./fixtures/schema/full.json'); | |||
| const multiple = require('./fixtures/schema/multiple.json'); | |||
|
|
|||
| describe('cli-lib/schema', () => { | |||
| const originalChalkLevel = chalk.level; | |||
| beforeEach(() => { | |||
| chalk.level = 0; | |||
There was a problem hiding this comment.
@drewjenkins due to an upgrade of chalk, you're approach of monkey patching process.env.FORCE_COLOR stopped working. I switched to a more targeted approach using https://github.com/chalk/chalk#chalklevel.
|
I think that I am going to leave changes to how endpoints work for later. I also will work on adding usage tracking, which will require a backend change first. |
Description and Context
This PR adds support for accessing serverless app function logs through expanding the
hs logscommand. The new options will remain undocumented for now.An example of the format is
hs logs --appFunction=weatherCard --app=/hello-world-appTODO
yargssupports having option work as both a positional and option. If so, add--endpointso that there is symmetryWho to Notify
@miketalley