Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
lucleray
approved these changes
Sep 29, 2025
There was a problem hiding this comment.
Additional Comments:
packages/otel/src/types.ts (line 70):
The documentation is missing the newly added vercel.project_id attribute that was implemented in sdk.ts.
View Details
📝 Patch Details
diff --git a/packages/otel/src/types.ts b/packages/otel/src/types.ts
index 1f3b2c5..0984dd9 100644
--- a/packages/otel/src/types.ts
+++ b/packages/otel/src/types.ts
@@ -68,6 +68,7 @@ export interface Configuration {
* - `vercel.host` - the Vercel deployment host for the Git SHA (`VERCEL_URL` environment variable).
* - `vercel.branch_host` - the Vercel deployment host for the branch (`VERCEL_BRANCH_URL` environment variable).
* - `vercel.deployment_id` - the Vercel deployment ID (`VERCEL_DEPLOYMENT_ID` environment variable).
+ * - `vercel.project_id` - the Vercel project ID (`VERCEL_PROJECT_ID` environment variable).
*
* Any additional attributes will be merged with the default attributes.
*/
Analysis
Missing documentation for vercel.project_id attribute in types.ts
What fails: The Configuration.attributes JSDoc in packages/otel/src/types.ts lists all automatically added Vercel resource attributes except vercel.project_id, which is implemented in sdk.ts line 147
How to reproduce:
- Check
sdk.tsline 147:"vercel.project_id": process.env.VERCEL_PROJECT_ID || undefined, - Check
types.tslines 63-71: documentation listsvercel.deployment_idbut notvercel.project_id
Result: Developer documentation is incomplete - users won't know that vercel.project_id is automatically added
Expected: Documentation should include vercel.project_id entry per Vercel system environment variables showing it as official variable
This reverts commit 537257d.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add
vercel.project_idresource attributePort to v1: #171