Skip to content

chore: update helm-charts doc for env var reference fixes for Datadog - #6019

Merged
akshaydeo merged 1 commit into
devfrom
08-10-chore_update_helm-charts_doc_for_env_var_reference_fixes_for_datadog
Aug 11, 2026
Merged

chore: update helm-charts doc for env var reference fixes for Datadog#6019
akshaydeo merged 1 commit into
devfrom
08-10-chore_update_helm-charts_doc_for_env_var_reference_fixes_for_datadog

Conversation

@roroghost17

@roroghost17 roroghost17 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents env.VAR_NAME substitution support for the Datadog plugin's service-identity fields (service_name, ml_app, env, version). These fields already supported environment variable references at runtime; this PR makes that capability visible through inline comments in values.yaml and descriptions in both values.schema.json and transports/config.schema.json.

Changes

  • Added env.VAR_NAME guidance to values.yaml comments for service_name, env, version, and ml_app Datadog config fields
  • Added or updated description fields in values.schema.json for service_name, env, and version to document env-reference support (matching the existing pattern already used for agent_addr, dogstatsd_host, etc.)
  • Updated transports/config.schema.json descriptions for service_name, ml_app, env, and version to note the env. prefix capability
  • Added an Upcoming changelog entry in README.md describing the documentation addition

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

No behavioral changes were made. To validate:

  1. Confirm Helm schema validation still passes with existing and new values.yaml configurations.
  2. Set a Datadog plugin field using the env.VAR_NAME pattern (e.g. service_name: "env.BIFROST_DD_SERVICE") and verify the value resolves correctly at runtime as it did before this change.
helm lint helm-charts/bifrost
helm template bifrost helm-charts/bifrost --values helm-charts/bifrost/values.yaml

Breaking changes

  • Yes
  • No

Related issues

N/A

Security considerations

No security implications. No new secrets, auth flows, or PII handling introduced.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 2713c267-7d56-4066-971c-d10feebf46d2

📥 Commits

Reviewing files that changed from the base of the PR and between b451ab4 and 8f3f6b0.

📒 Files selected for processing (2)
  • helm-charts/bifrost/README.md
  • transports/config.schema.json
🚧 Files skipped from review as they are similar to previous changes (2)
  • transports/config.schema.json
  • helm-charts/bifrost/README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Documented support for using env.VAR_NAME references in Datadog plugin service-identity fields.
    • Updated configuration guidance for service_name, ml_app, env, and version.
    • Added an upcoming changelog entry describing this capability.

Walkthrough

The PR updates Datadog schema descriptions for service_name, ml_app, env, and version. It also adds a Helm changelog entry for environment-variable references in these fields.

Changes

Datadog environment references

Layer / File(s) Summary
Configuration and changelog documentation
transports/config.schema.json, helm-charts/bifrost/README.md
The Datadog schema documents env. prefix support for service identity fields. The Helm changelog records the same configuration behavior.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • maximhq/bifrost#5938: Updates the same Datadog schema fields for env.VAR_NAME support.
  • maximhq/bifrost#6020: Documents env.VAR_NAME substitution for the same Datadog fields in another documentation file.

Suggested reviewers: akshaydeo, bearts

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the Datadog environment-variable documentation update in the Helm chart.
Description check ✅ Passed The description explains the purpose, changes, affected areas, validation steps, and impact, with only non-applicable template sections omitted.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 08-10-chore_update_helm-charts_doc_for_env_var_reference_fixes_for_datadog

Comment @coderabbitai help to get the list of available commands.

@CLAassistant

CLAassistant commented Aug 10, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor Author

@roroghost17
roroghost17 marked this pull request as ready for review August 10, 2026 11:27
@roroghost17
roroghost17 requested a review from a team as a code owner August 10, 2026 11:27
@coderabbitai
coderabbitai Bot requested review from BearTS and akshaydeo August 10, 2026 11:28

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@transports/config.schema.json`:
- Around line 2656-2661: Update the descriptions for the service_name, ml_app,
env, and version schema properties to explicitly document the accepted
environment-variable reference syntax as env.VAR_NAME, using consistent wording
and balanced punctuation. Preserve their existing types and defaults, and update
the corresponding Helm documentation to match the schema wording.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 8b1cdf6c-fd4b-4763-9de3-28517859056c

📥 Commits

Reviewing files that changed from the base of the PR and between c90f9c3 and f2606c7.

📒 Files selected for processing (4)
  • helm-charts/bifrost/README.md
  • helm-charts/bifrost/values.schema.json
  • helm-charts/bifrost/values.yaml
  • transports/config.schema.json

Comment thread transports/config.schema.json
@roroghost17
roroghost17 force-pushed the 08-10-chore_update_helm-charts_doc_for_env_var_reference_fixes_for_datadog branch from f2606c7 to 8f3f6b0 Compare August 11, 2026 06:24
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

akshaydeo commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Merge activity

  • Aug 11, 6:58 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Aug 11, 6:58 AM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo merged commit 94d47bf into dev Aug 11, 2026
14 of 15 checks passed
@akshaydeo
akshaydeo deleted the 08-10-chore_update_helm-charts_doc_for_env_var_reference_fixes_for_datadog branch August 11, 2026 06:58
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
…#6019)

## Summary

Documents `env.VAR_NAME` substitution support for the Datadog plugin's service-identity fields (`service_name`, `ml_app`, `env`, `version`). These fields already supported environment variable references at runtime; this PR makes that capability visible through inline comments in `values.yaml` and descriptions in both `values.schema.json` and `transports/config.schema.json`.

## Changes

- Added `env.VAR_NAME` guidance to `values.yaml` comments for `service_name`, `env`, `version`, and `ml_app` Datadog config fields
- Added or updated `description` fields in `values.schema.json` for `service_name`, `env`, and `version` to document env-reference support (matching the existing pattern already used for `agent_addr`, `dogstatsd_host`, etc.)
- Updated `transports/config.schema.json` descriptions for `service_name`, `ml_app`, `env`, and `version` to note the `env.` prefix capability
- Added an `Upcoming` changelog entry in `README.md` describing the documentation addition

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [x] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

No behavioral changes were made. To validate:

1. Confirm Helm schema validation still passes with existing and new `values.yaml` configurations.
2. Set a Datadog plugin field using the `env.VAR_NAME` pattern (e.g. `service_name: "env.BIFROST_DD_SERVICE"`) and verify the value resolves correctly at runtime as it did before this change.

```sh
helm lint helm-charts/bifrost
helm template bifrost helm-charts/bifrost --values helm-charts/bifrost/values.yaml
```

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

No security implications. No new secrets, auth flows, or PII handling introduced.

## Checklist

- [x] I read `docs/contributing/README.md` and followed the guidelines
- [x] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [x] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 13, 2026
…#6019)

## Summary

Documents `env.VAR_NAME` substitution support for the Datadog plugin's service-identity fields (`service_name`, `ml_app`, `env`, `version`). These fields already supported environment variable references at runtime; this PR makes that capability visible through inline comments in `values.yaml` and descriptions in both `values.schema.json` and `transports/config.schema.json`.

## Changes

- Added `env.VAR_NAME` guidance to `values.yaml` comments for `service_name`, `env`, `version`, and `ml_app` Datadog config fields
- Added or updated `description` fields in `values.schema.json` for `service_name`, `env`, and `version` to document env-reference support (matching the existing pattern already used for `agent_addr`, `dogstatsd_host`, etc.)
- Updated `transports/config.schema.json` descriptions for `service_name`, `ml_app`, `env`, and `version` to note the `env.` prefix capability
- Added an `Upcoming` changelog entry in `README.md` describing the documentation addition

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [x] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

No behavioral changes were made. To validate:

1. Confirm Helm schema validation still passes with existing and new `values.yaml` configurations.
2. Set a Datadog plugin field using the `env.VAR_NAME` pattern (e.g. `service_name: "env.BIFROST_DD_SERVICE"`) and verify the value resolves correctly at runtime as it did before this change.

```sh
helm lint helm-charts/bifrost
helm template bifrost helm-charts/bifrost --values helm-charts/bifrost/values.yaml
```

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

No security implications. No new secrets, auth flows, or PII handling introduced.

## Checklist

- [x] I read `docs/contributing/README.md` and followed the guidelines
- [x] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [x] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
@akshaydeo akshaydeo mentioned this pull request Aug 13, 2026
akshaydeo added a commit that referenced this pull request Aug 13, 2026
## ✨ Features

- **MCP Per-User OAuth** - MCP clients can hold per-user OAuth
credentials and per-user headers, configurable from `config.json` as
well as the UI, with a documented shared vs per-identity token lookup
contract and VK/Users filters on the OAuth Grants and MCP Auth Sessions
sidebars
- **Token Exchange IDP Credentials** - New `use_idp_credentials` on
`token_exchange` reuses SSO login app credentials for providers that
require it, such as Microsoft Entra ID; `client_id` becomes optional
when it is set (#6068, #6069)
- **Bedrock VPC Endpoints** - AWS Bedrock keys can target VPC endpoints
(#6064)
- **Per-Request Flat-Fee Pricing** - New `cost_per_request` field flows
through datasheet sync, the cost engine, custom overrides and the UI
override form (#6079)
- **Pricing Overrides in the Model Catalog** - `/api/models/details`
exposes resolved pricing overrides, and catalog rows resolve overrides
server-side (#6055, #6056)
- **MCP Tool Discovery Persistence** - Discovered MCP tools persist and
resync uniformly across all client types through a hash-gated core
callback, surviving restarts and propagating across a cluster
- **W3C Trace ID Propagation** - Requests carry a W3C trace ID on the
context (#5945)
- **Cancellable Log Cost Recalculation** - Log cost recalculation tasks
can be cancelled from the backend (#5801)
- **Separate OTEL Metrics Pipeline** - The OTEL collector supports a
metrics tab independent of traces, plus separate headers for traces and
metrics (#5939, #5940)
- **Roots-Only Log Filter** - New `roots_only` filter collapses fallback
chains into their root entry with child aggregates (#5737)
- **MCP Log Redaction and Plugin Logs** - MCP tool logs carry redaction
mappings and plugin logs (#5744, #5746)
- **User Agent and App Attribution in Logs** - Logs and MCP tool logs
record user agent, app, source, decision, app key and device ID
- **S3 Log Export Metadata** - Additional metadata is written alongside
S3 log exports (#6070)
- **Matview Maintenance Off Switch** - `matview_refresh_interval`
accepts `"off"` to disable logstore matview maintenance entirely (thanks
[@jeremym-tanium](https://github.com/jeremym-tanium)!) (#5693)
- **Video Request Info in Logs UI** - Video requests surface their
details in the logs UI (#5946)
- **Shell Rewriter Hook** - The UI handler exposes a `ShellRewriter`
hook for pre-hydration HTML rewriting (#5807)
- **Auth Skip Path** - Adds a context path letting trusted internal
callers bypass auth resolution

## 🐞 Fixed

- **Path Normalization Auth Bypass** - Fixed a path normalization flaw
that allowed auth to be bypassed (#5763)
- **Minimal Reasoning Effort on GPT-5 Models** - `reasoning_effort:
"minimal"` is preserved for GPT-5-family OpenAI models instead of being
downgraded to `low` (thanks [@jitokim](https://github.com/jitokim)!)
(#6046)
- **Gemini Truncated Response Finish Reason** - Truncated Gemini
responses report `MAX_TOKENS` instead of `OTHER` (thanks
[@AdityaPainuli](https://github.com/AdityaPainuli)!) (#5979)
- **Null Tool-Call Function Name on Streaming** - Streaming continuation
deltas no longer materialize an absent tool-call function name as `null`
(thanks [@AdityaPainuli](https://github.com/AdityaPainuli)!) (#5966)
- **Bedrock Document Uploads** - Fixed Bedrock file handling in
inference so office and PDF documents sent as OpenAI `type: "file"` are
accepted (#5947)
- **xAI Usage Cost** - Fixed USD cost ticks for xAI usage (#5950)
- **Anthropic Encrypted Reasoning** - Added an Anthropic error branch
when stripping encrypted reasoning content
- **MCP Reconnect and Lock Ordering** - Broke a lock-order inversion in
`ConnectionCheckerManager`, rebuilt ephemeral clients across the whole
connect+init retry, preserved last-known tool maps across close-first
reconnects, bound connect attempts to entry identity, deduped background
reconnects and gated SSE `OnConnectionLost` on connection identity
- **MCP OAuth Session Correctness** - Restricted `Reauthorize` to shared
OAuth clients, rejected inactive tokens in `ValidateToken`, made the
OAuth flow claim atomic against concurrent reauth, stopped dropping
stored scopes on decode failure, and closed a verify-headers
double-submit race that also dropped TLS, timeout and per-user-header
fields
- **Session Stickiness Reconciliation** - `needs_session_stickiness` is
pinned across `config.json` reconciliation, so an unrelated file edit
can no longer silently revert a client to per-call
- **Credential Cache Cancellation** - `headerCredentialCache.Fill` and
`userTokenCache.Fill` propagate context so a cancelled request unblocks
instead of waiting on an unrelated leader; LRU entries carry a version
so a rejected stale `Get` cannot evict a concurrently-updated value
- **Governance List-Models Call** - Budgets and rate limits no longer
trigger a list-models call (#6051)
- **Realtime Response Create Input** - Guarded `response.create` input
(#6050)
- **HTTP Server Timeouts** - Configured bounded `http.Server` timeouts
and a request-body limit
- **MCP Client State Badges** - State badges render with spaces instead
of underscores, and the state filter bucket was renamed from
`disconnected` to `unstable`
- **Entra OBO Scope** - `offline_access` is combined with
`<audience>/.default` for Entra OBO instead of replacing it (#6078)

## 🔧 Maintenance

- **Governance Route Families** - Editions can override governance route
families (#5839)
- **Dependency Upgrades** - Dependabot updates across all modules, plus
module path fixes (#6040, #5864)
- **Documentation** - config.schema.json doc fixes and Datadog env var
reference fixes in the helm chart docs (#5938, #6019)

## 🗄️ Database Migrations

**configstore:**

- **add_mcp_client_pending_oauth_config_json_column** - Adds
`pending_oauth_config_json` to `config_mcp_clients`. Reversible: drops
the added column.
- **merge_oauth_token_tables** - Consolidates `oauth_tokens` and
`oauth_user_tokens` into `mcp_oauth_tokens`. **Non-reversible**:
rollback deliberately leaves `mcp_oauth_tokens` in place, because every
OAuth read and write targets it from this migration onward and dropping
it would destroy any token created or refreshed since, forcing every
holder to re-authorize.
- **create_mcp_oauth_flows_table** - Creates `mcp_oauth_flows` to track
in-flight OAuth flows. Reversible: drops the new table.
- **drop_oauth_config_pkce_columns** - Drops CSRF state, PKCE verifier
and `expires_at` from the OAuth config table now that they live on
`mcp_oauth_flows`. **Non-reversible**: forward-only, the dropped values
were per-flow ephemeral and re-adding empty columns would restore
nothing.
- **drop_oauth_config_token_id_column** - Drops `token_id`.
**Non-reversible**: forward-only, it was a pure FK shortcut now
reachable via `(oauth_config_id, auth_mode)`.
- **add_mcp_admin_auth_mode_indexes** - Adds admin partial unique
indexes on `mcp_oauth_tokens` and `mcp_per_user_header_credentials`.
Reversible: drops both indexes.
- **add_mcp_client_token_exchange_json_column** - Adds
`token_exchange_json` to `config_mcp_clients`. Reversible: drops the
added column.
- **add_needs_session_stickiness_column** - Adds
`needs_session_stickiness` to `config_mcp_clients`. Reversible: drops
the added column.
- **add_bedrock_endpoints_columns** - Adds Bedrock VPC endpoint columns
to the keys table. Reversible: drops the added columns.
- **add_cost_per_request_pricing_column** - Adds `cost_per_request` to
model pricing. Reversible: drops the added column.

**logstore:**

- **logs_add_guardrail_debug_column** - Adds `guardrail_debug` to logs.
Reversible: drops the added column.
- **mcp_tool_logs_add_redaction_mapping_column** - Adds the redaction
mapping column to MCP tool logs. **Non-reversible**: rollback is a no-op
because dropping the column would permanently destroy reveal data for
already-redacted MCP logs.
- **logs_add_user_agent_column** - Adds user agent and app columns,
their indexes, and a `UserAgentMapping` table. Reversible: drops the
indexes and the mapping table.
- **mcp_tool_logs_add_user_agent_column** - Adds user agent and app
columns plus indexes to MCP tool logs. Reversible: drops both indexes
and the `app` column.
- **mcp_tool_logs_add_endpoint_columns** - Adds `source`, `decision`,
`app_key` and `device_id` to MCP tool logs. Reversible: drops all four
columns.
- **mcp_tool_logs_add_plugin_logs_column** - Adds `plugin_logs` to MCP
tool logs. Reversible: drops the added column.
- **logs_recreate_matviews_with_user_agent_column** and
**logs_recreate_matviews_with_app_column** - Recreate the log
materialized views to include the new columns. Rollback is a no-op
because `ensureMatViews` recreates them on next startup.

<Warning>
**High-throughput deployments: run the logstore migrations during a
low-activity window.**

Every logstore migration above alters `logs` or `mcp_tool_logs`, the two
highest-insert tables in Bifrost, and several also build indexes on
them. On a busy instance the index builds hold locks that block
concurrent log inserts for the duration of the build, and the matview
recreations rebuild against the full table. Schedule the upgrade for a
low-traffic period, or expect elevated log-write latency and possible
request-path backpressure while the migrations run.
</Warning>

<Warning>
`merge_oauth_token_tables`, `drop_oauth_config_pkce_columns` and
`drop_oauth_config_token_id_column` transform or remove existing OAuth
state and cannot be rolled back. Take a database backup before
upgrading, and do not roll the binary back past this release once the
migration has run.
</Warning>

## 🐙 Closed GitHub Issues

- [#123](#123) - Files API
Support
- [#5472](#5472) - [Bug]:
Bedrock rejects office/PDF document uploads via OpenAI `type:"file"` -
"The PDF specified was not valid"
- [#5900](#5900) - [Bug]:
Streaming continuation chunks materialize omitted tool-call metadata as
null
- [#5978](#5978) - [Bug]:
Gemini egress reports truncated responses as FinishReason OTHER,
IncompleteDetails switch matches a string that never occurs
- [#6044](#6044) - [Bug]:
normalizeOpenAIReasoningEffort maps 'minimal' to 'low' for ALL OpenAI
models, even ones that natively support 'minimal'
akshaydeo pushed a commit that referenced this pull request Aug 14, 2026
…#6019)

## Summary

Documents `env.VAR_NAME` substitution support for the Datadog plugin's service-identity fields (`service_name`, `ml_app`, `env`, `version`). These fields already supported environment variable references at runtime; this PR makes that capability visible through inline comments in `values.yaml` and descriptions in both `values.schema.json` and `transports/config.schema.json`.

## Changes

- Added `env.VAR_NAME` guidance to `values.yaml` comments for `service_name`, `env`, `version`, and `ml_app` Datadog config fields
- Added or updated `description` fields in `values.schema.json` for `service_name`, `env`, and `version` to document env-reference support (matching the existing pattern already used for `agent_addr`, `dogstatsd_host`, etc.)
- Updated `transports/config.schema.json` descriptions for `service_name`, `ml_app`, `env`, and `version` to note the `env.` prefix capability
- Added an `Upcoming` changelog entry in `README.md` describing the documentation addition

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [x] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

No behavioral changes were made. To validate:

1. Confirm Helm schema validation still passes with existing and new `values.yaml` configurations.
2. Set a Datadog plugin field using the `env.VAR_NAME` pattern (e.g. `service_name: "env.BIFROST_DD_SERVICE"`) and verify the value resolves correctly at runtime as it did before this change.

```sh
helm lint helm-charts/bifrost
helm template bifrost helm-charts/bifrost --values helm-charts/bifrost/values.yaml
```

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

No security implications. No new secrets, auth flows, or PII handling introduced.

## Checklist

- [x] I read `docs/contributing/README.md` and followed the guidelines
- [x] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [x] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akshaydeo pushed a commit that referenced this pull request Aug 19, 2026
…#6019)

## Summary

Documents `env.VAR_NAME` substitution support for the Datadog plugin's service-identity fields (`service_name`, `ml_app`, `env`, `version`). These fields already supported environment variable references at runtime; this PR makes that capability visible through inline comments in `values.yaml` and descriptions in both `values.schema.json` and `transports/config.schema.json`.

## Changes

- Added `env.VAR_NAME` guidance to `values.yaml` comments for `service_name`, `env`, `version`, and `ml_app` Datadog config fields
- Added or updated `description` fields in `values.schema.json` for `service_name`, `env`, and `version` to document env-reference support (matching the existing pattern already used for `agent_addr`, `dogstatsd_host`, etc.)
- Updated `transports/config.schema.json` descriptions for `service_name`, `ml_app`, `env`, and `version` to note the `env.` prefix capability
- Added an `Upcoming` changelog entry in `README.md` describing the documentation addition

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [x] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

No behavioral changes were made. To validate:

1. Confirm Helm schema validation still passes with existing and new `values.yaml` configurations.
2. Set a Datadog plugin field using the `env.VAR_NAME` pattern (e.g. `service_name: "env.BIFROST_DD_SERVICE"`) and verify the value resolves correctly at runtime as it did before this change.

```sh
helm lint helm-charts/bifrost
helm template bifrost helm-charts/bifrost --values helm-charts/bifrost/values.yaml
```

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

No security implications. No new secrets, auth flows, or PII handling introduced.

## Checklist

- [x] I read `docs/contributing/README.md` and followed the guidelines
- [x] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [x] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants