Skip to content

feat: Add build data for observability #493

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 25, 2023
Merged

feat: Add build data for observability #493

merged 1 commit into from
Sep 25, 2023

Conversation

jenae-janzen
Copy link
Contributor

@jenae-janzen jenae-janzen commented Sep 25, 2023 •
edited
Loading

Adds build data to surface information about the serverless functions api and netlify/build

Part of https://linear.app/netlify/issue/COM-6/expose-the-ability-to-query-for-functions-using-the-v2-api

@jenae-janzen jenae-janzen requested review from a team as code owners September 25, 2023 13:58
@netlify
Copy link

netlify bot commented Sep 25, 2023 •
edited
Loading

✅ Deploy Preview for open-api ready!

Name Link
🔨 Latest commit 9a3da54
🔍 Latest deploy log https://app.netlify.com/sites/open-api/deploys/6511951943c54d000843c654
😎 Deploy Preview https://deploy-preview-493--open-api.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jenae-janzen jenae-janzen changed the title Add build data Feat: Add build data for observability Sep 25, 2023
@jenae-janzen jenae-janzen changed the title Feat: Add build data for observability feat: Add build data for observability Sep 25, 2023
@linear
Copy link

linear bot commented Sep 25, 2023

COM-6 Expose the ability to query for functions using the v2 API

Currently, the only way to know whether a function is using the v2 API is to query the build logs. This is tedious and error-prone, since build logs is a giant collection without any indices.

However, the function_bundles collection can be queried as well! To make it easy to understand how many v2 functions are being in use, it would be great if we could add a property in the function bundle that shows whether the API is v2 or not.

JWhist
JWhist reviewed Sep 25, 2023
View reviewed changes
go/porcelain/functions_manifest.go
Schedule string `json:"schedule"`
DisplayName string `json:"displayName"`
Generator string `json:"generator"`
BuildData map[string]interface{} `json:"buildData"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the property types subject to change or can the config object be a type of its own?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's subject to change -- we wanted to make it extensible so that when we add more properties in the future we don't have to add them to every repo in the chain

@jenae-janzen jenae-janzen merged commit 9e3ee4f into master Sep 25, 2023
@jenae-janzen jenae-janzen deleted the add-build-data branch September 25, 2023 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JWhist JWhist JWhist approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jenae-janzen @JWhist