Add fleet reserved variable validation by MichelLosier · Pull Request #1134 · elastic/package-spec

MichelLosier · 2026-04-08T22:50:31Z

What does this PR do?

Adds validation around the inclusion of use_apm, and data_stream.dataset variable overrides, which fleet already injects automatically if not present.
use_apm
- is of type bool
- is used only on otelcol inputs of streams that are traces or dynamic_signal_types
data_stream.dataset
- is of type text

Where we do injection in fleet, but defer to existing declarations:

https://github.com/elastic/kibana/blob/main/x-pack/platform/plugins/shared/fleet/common/services/policy_template.ts#L212-L221

Why is it important?

While already allowing integrations to decide on the default value of these special handled variables, these validations make sure that the expected variable types and constraints are observed.

Checklist

I have added test packages to test/packages that prove my change is effective.
I have added an entry in spec/changelog.yml.

Related issues

Closes: [Change Proposal] Support providing a default value for use_apm variable in integration type packages #1100

MichelLosier · 2026-04-09T21:01:45Z

test integrations

coderabbitai · 2026-04-09T21:06:21Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 937c5d04-73e9-4add-b0e0-483ccbc32eae

📥 Commits

Reviewing files that changed from the base of the PR and between 7f1d76c and f38767f.

📒 Files selected for processing (7)

code/go/internal/validator/semantic/validate_fleet_reserved_vars.go
code/go/internal/validator/spec.go
spec/changelog.yml
test/packages/bad_input_fleet_reserved_vars/manifest.yml
test/packages/bad_integration_fleet_reserved_vars/manifest.yml
test/packages/good_input_fleet_reserved_vars/manifest.yml
test/packages/good_integration_fleet_reserved_vars/manifest.yml

✅ Files skipped from review due to trivial changes (5)

spec/changelog.yml
test/packages/good_input_fleet_reserved_vars/manifest.yml
test/packages/good_integration_fleet_reserved_vars/manifest.yml
test/packages/bad_integration_fleet_reserved_vars/manifest.yml
test/packages/bad_input_fleet_reserved_vars/manifest.yml

📝 Walkthrough

Walkthrough

A new semantic validator ValidateFleetReservedVars was added and wired into the spec validation pipeline (gated for pkg types integration/input and version >= 3.6.1). It reads package manifests (including data-stream manifests), normalizes streams, and validates Fleet-reserved variables: use_apm must appear only on otelcol inputs, be declared as type bool, and is permitted only for traces streams unless dynamic_signal_types: true; data_stream.dataset must be type text. Tests and package fixtures for valid and invalid cases were added.

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	PR implements validation for Fleet-reserved variables (use_apm, data_stream.dataset) with type enforcement and eligibility constraints, matching issue `#1100` requirements.
Out of Scope Changes check	✅ Passed	All changes are scoped to reserved variable validation: semantic validator implementation, comprehensive test coverage, integration test fixtures, and changelog updates.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

🛠️ Update Documentation: Commit on current branch
🛠️ Update Documentation: Create PR

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@code/go/internal/validator/spec.go`:
- Line 233: The semantic validator registration for ValidateFleetReservedVars is
currently unconditional; update its entry in the validator registrations list
(the slice containing {fn: semantic.ValidateFleetReservedVars}) to include the
package types it applies to (e.g., types.Integration or the appropriate types
enum) via a types field and add the since field with the spec version when this
validator was introduced (e.g., "vX.Y.Z"), so the rule is only enforced for the
intended package type(s) and for specs at or after that version.

🪄 Autofix (Beta)

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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4c6725de-024d-40e3-b069-bd15b3c09c76

📥 Commits

Reviewing files that changed from the base of the PR and between 06b46cb and 7f1d76c.

📒 Files selected for processing (29)

code/go/internal/validator/semantic/validate_fleet_reserved_vars.go
code/go/internal/validator/semantic/validate_fleet_reserved_vars_test.go
code/go/internal/validator/spec.go
code/go/pkg/validator/validator_test.go
test/packages/bad_input_fleet_reserved_vars/agent/input/input.yml.hbs
test/packages/bad_input_fleet_reserved_vars/changelog.yml
test/packages/bad_input_fleet_reserved_vars/docs/README.md
test/packages/bad_input_fleet_reserved_vars/manifest.yml
test/packages/bad_integration_fleet_reserved_vars/LICENSE.txt
test/packages/bad_integration_fleet_reserved_vars/changelog.yml
test/packages/bad_integration_fleet_reserved_vars/data_stream/sample/agent/stream/stream.yml.hbs
test/packages/bad_integration_fleet_reserved_vars/data_stream/sample/fields/base-fields.yml
test/packages/bad_integration_fleet_reserved_vars/data_stream/sample/manifest.yml
test/packages/bad_integration_fleet_reserved_vars/docs/README.md
test/packages/bad_integration_fleet_reserved_vars/manifest.yml
test/packages/good_input_fleet_reserved_vars/agent/input/input.yml.hbs
test/packages/good_input_fleet_reserved_vars/changelog.yml
test/packages/good_input_fleet_reserved_vars/docs/README.md
test/packages/good_input_fleet_reserved_vars/manifest.yml
test/packages/good_integration_fleet_reserved_vars/LICENSE.txt
test/packages/good_integration_fleet_reserved_vars/changelog.yml
test/packages/good_integration_fleet_reserved_vars/data_stream/log/agent/stream/stream.yml.hbs
test/packages/good_integration_fleet_reserved_vars/data_stream/log/fields/base-fields.yml
test/packages/good_integration_fleet_reserved_vars/data_stream/log/manifest.yml
test/packages/good_integration_fleet_reserved_vars/data_stream/otel/agent/stream/stream.yml.hbs
test/packages/good_integration_fleet_reserved_vars/data_stream/otel/fields/base-fields.yml
test/packages/good_integration_fleet_reserved_vars/data_stream/otel/manifest.yml
test/packages/good_integration_fleet_reserved_vars/docs/README.md
test/packages/good_integration_fleet_reserved_vars/manifest.yml

code/go/internal/validator/spec.go

elastic-vault-github-plugin-prod · 2026-04-09T21:09:03Z

Created or updated PR in integrations repository to test this version. Check elastic/integrations#18319

elasticmachine · 2026-04-09T21:13:51Z

💚 Build Succeeded

Buildkite Build
Commit: 7f1d76c

History

💚 Build #2033 succeeded ee912db

teresaromero · 2026-04-10T07:34:46Z

code/go/internal/validator/semantic/validate_fleet_reserved_vars.go

+	}
+
+	for _, ds := range dataStreams {
+		manifestPath := dataStreamDir + "/" + ds + "/manifest.yml"


i always struggle with path construction between linux/windows. use path.Join instead to avoid slash errors between platforms

i see the tests passed with this config 🤔 interesting

oof yes, good catch! 😄

teresaromero

looks good! couple thoughts:

variables for integrations can be defined also at package root level (vars) and policy template input level (vars), i think we are missing these cases. for input packages is also a vars at root level and the one at the policy templates
i was thinking if perhaps instead of creating the streams variables and then running again a loop, we could run validation on the only loop when normalizing. this way we just go through once and we can append validation errors on the go, skipping the variables we are not interested. if i read correctly, the streams list have variables we dont even care. wdyt?

MichelLosier added 6 commits April 8, 2026 14:56

Add validation of fleet reserved vars

e279501

Register ValidateFleetReservedVars

8952abf

Add test packages for fleet reserved vars validation

8fb674b

Add unit tests for validate_fleet_reserved_vars

57df6de

Formatting

ee912db

Add data stream type validation for use_apm

7f1d76c

MichelLosier marked this pull request as ready for review April 9, 2026 21:01

MichelLosier requested a review from a team as a code owner April 9, 2026 21:01

coderabbitai bot reviewed Apr 9, 2026

View reviewed changes

code/go/internal/validator/spec.go Outdated Show resolved Hide resolved

elastic-vault-github-plugin-prod bot mentioned this pull request Apr 9, 2026

Test branch package-spec#1134 - DO NOT MERGE elastic/integrations#18319

Draft

teresaromero reviewed Apr 10, 2026

View reviewed changes

Fix path building, update changelog

f38767f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fleet reserved variable validation#1134

Add fleet reserved variable validation#1134
MichelLosier wants to merge 7 commits intoelastic:mainfrom
MichelLosier:1100-add-use-apm-var-validation

MichelLosier commented Apr 8, 2026 •

edited

Loading

Uh oh!

MichelLosier commented Apr 9, 2026

Uh oh!

coderabbitai bot commented Apr 9, 2026 •

edited

Loading

Walkthrough

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

elastic-vault-github-plugin-prod bot commented Apr 9, 2026

Uh oh!

elasticmachine commented Apr 9, 2026

Uh oh!

teresaromero Apr 10, 2026

Uh oh!

teresaromero Apr 10, 2026

Uh oh!

MichelLosier Apr 10, 2026

Uh oh!

teresaromero left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

MichelLosier commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Related issues

Uh oh!

MichelLosier commented Apr 9, 2026

Uh oh!

coderabbitai bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

elastic-vault-github-plugin-prod bot commented Apr 9, 2026

Uh oh!

elasticmachine commented Apr 9, 2026

💚 Build Succeeded

History

Uh oh!

teresaromero Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

teresaromero Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

MichelLosier Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

teresaromero left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MichelLosier commented Apr 8, 2026 •

edited

Loading

coderabbitai bot commented Apr 9, 2026 •

edited

Loading