Repository navigation
docs(AIC-3692): say which project id attribute the telemetry resource carries - #239
Merged
Merged
Conversation
… carries The client README and agents.md listed service.name and deployment.environment as the resource attributes init_client() sets, but not launchdarkly.project_id. State that it is the resolved SDK key, and that it replaced highlight.project_id, so anyone matching on the old name knows to switch. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… note The README never named highlight.project_id, so the note only needs the current attribute. The changelog's breaking-change entry from #229 covers the rename. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
aknight-ld
approved these changes
Oct 28, 2026
jeffdupont
added a commit
to launchdarkly/js-ai-sdk
that referenced
this pull request
Oct 28, 2026
… carries (#185) ## What Part of AIC-3692. #176 renamed the telemetry resource's project id attribute from `highlight.project_id` to `launchdarkly.project_id`, but the docs never named either one. The client README and `agents.md` listed `service.name` and `deployment.environment` as what `initClient()` sets, and stopped there. The README note and the `agents.md` bullet say `initClient()` sets `launchdarkly.project_id` to the resolved SDK key, not the project's ID. Neither mentions `highlight.project_id`: no customer-facing doc ever named it, and the changelog's breaking-change entry from #176 covers the rename. Docs only: `packages/client/README.md` and `packages/client/agents.md`. No code, API report or link changes. The Python SDK gets the same note in launchdarkly/python-ai-sdk#239. ## Checks - The added lines contain no links, no URLs and no references to the private spec. - Every statement matches `lifecycle.ts` on `main` and the tests #176 changed in `lifecycle.test.ts`. - Committed through the GitHub API, so Biome wasn't run locally. CI covers it. 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > Documents what **`initClient()`** already puts on the OTel resource after the rename from `highlight.project_id` to **`launchdarkly.project_id`**. > > **`packages/client/README.md`** and **`agents.md`** now state that **`launchdarkly.project_id`** is set to the **resolved SDK key**, not the LaunchDarkly project ID, and that this attribute is **not configurable** via env or options (unlike `service.name` and `deployment.environment`). No runtime or API changes. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit f84b945. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
What
Part of AIC-3692. #229 renamed the telemetry resource's project id attribute from
highlight.project_idtolaunchdarkly.project_id, but the docs never named either one. The client README andagents.mdlistedservice.nameanddeployment.environmentas whatinit_client()sets, and stopped there.The README note says
init_client()setslaunchdarkly.project_idto the resolved SDK key, not the project's ID. It doesn't mentionhighlight.project_id: no customer-facing doc ever named it, and the changelog's breaking-change entry from #229 covers the rename. Theagents.mdbullet says the same thing.Docs only:
packages/client/README.mdandpackages/client/agents.md. No code, API report or link changes.Checks
lifecycle.pyonmainand the tests fix(client)!: stamp launchdarkly.project_id on the telemetry resource #229 added (test_stamps_launchdarkly_project_id,test_stamps_no_highlight_project_id).🤖 Generated with Claude Code
Note
Overview
Documents what
init_client()already stamps on the OTel resource after #229 renamed the attribute tolaunchdarkly.project_id.The client README adds a short note that this attribute is the resolved SDK key, not the LaunchDarkly project ID.
agents.mdadds a matching contributor bullet under OTel env vars, marked as not configurable.Docs-only; behavior is unchanged and aligned with
lifecycle.pyand existing lifecycle tests.Reviewed by Cursor Bugbot for commit fa3759b. Bugbot is set up for automated code reviews on this repo. Configure here.