[Fleet] Allow to configure monitoring runtime in agent policy #233345

nchaulet · 2025-08-28T14:16:43Z

Summary

Resolve #233186

Allow to configure monitoring runtime in agent policy.

Implementation details:

I made some change to our settings framework to support empty value, and label for select. Those changes are covered with unit tests

UI Changes

Agent policy editor

How to test

I tested this locally and it seems to generate correct policy that are handled by Elastic Agent

And we switch to otel when configuring to otel

{"log.level":"info","@timestamp":"2025-08-28T18:09:46.706Z","log.origin":{"function":"github.com/elastic/elastic-agent/internal/pkg/agent/application/monitoring/reload.(*ServerReloader).Start","file.name":"reload/reload.go","file.line":54},"message":"Starting monitoring server with cfg &config.MonitoringConfig{Enabled:true, MonitorLogs:true, MonitorMetrics:true, MetricsPeriod:\"\", FailureThreshold:(*uint)(nil), LogMetrics:true, HTTP:(*config.MonitoringHTTPConfig)(0x40024825d0), Namespace:\"default\", Pprof:(*config.PprofConfig)(nil), MonitorTraces:false, APM:config.APMConfig{Environment:\"\", APIKey:\"\", SecretToken:\"\", Hosts:[]string(nil), GlobalLabels:map[string]string(nil), TLS:config.APMTLS{SkipVerify:false, ServerCertificate:\"\", ServerCA:\"\"}, SamplingRate:(*float32)(nil)}, Diagnostics:config.Diagnostics{Uploader:config.Uploader{MaxRetries:10, InitDur:1000000000, MaxDur:600000000000}, Limit:config.Limit{Interval:60000000000, Burst:1}}, RuntimeManager:\"otel\"}","log":{"source":"elastic-agent"},"ecs.version":"1.6.0"}

cmacknz · 2025-08-28T18:07:05Z

This should be backported to 9.1 and 8.19 as well as we intend to eventually use beat receivers there as well.

elasticmachine · 2025-08-28T18:08:38Z

Pinging @elastic/fleet (Team:Fleet)

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --update'

…lastic/kibana into feature-fleet-agent-runtime-monitoring

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --update'

…lastic/kibana into feature-fleet-agent-runtime-monitoring

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/maintenance_window --update'

…no-cache --fix'

jen-huang

Did you do some manual testing of clearing/un-setting this setting? Do brand new agent policies get '' as a value right away?

I remember encountering unexpected behavior before with these generated settings before, where the agent policies are always created with a non-undefined value for introduced settings (we don't want this since we prefer to use agent default unless user explicitly chooses otherwise). Just want to make sure we double check here :)

jen-huang · 2025-08-29T00:24:42Z

x-pack/platform/plugins/shared/fleet/common/settings/agent_policy_settings.tsx

+  {
+    name: 'agent.monitoring._runtime_experimental',
+    title: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeTitle', {
+      defaultMessage: 'Monitoring Runtime (experimental)',


Suggested change

defaultMessage: 'Monitoring Runtime (experimental)',

defaultMessage: 'Runtime monitoring (experimental)',

sentence casing + I think "runtime monitoring" makes more sense than "monitoring runtime"

I also agree with Jen here.

Not a native speaker here, but does Runtime monitoring has a special meaning, here what it's configuring it's that agent flag agent.monitoring._runtime_experimental that configure the internal runtime of the agent monitoring.

I was going to say that just happens to be the order from how the setting is nested, but after reviewing the original issue I think I misunderstood the intent. it's the runtime used for the self-monitoring process, not monitoring the runtime :)

so we should just fix the sentence casing here

Suggested change

defaultMessage: 'Monitoring Runtime (experimental)',

defaultMessage: 'Monitoring runtime (experimental)',

jen-huang · 2025-08-29T00:26:11Z

x-pack/platform/plugins/shared/fleet/common/settings/agent_policy_settings.tsx

+      },
+      {
+        value: 'otel',
+        text: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeLabel', {


Suggested change

text: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeLabel', {

text: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeOtelLabel', {

extremely small nit with naming of this i18n key 😅

jen-huang · 2025-08-29T00:30:10Z

x-pack/platform/plugins/shared/fleet/server/types/models/agent_policy.ts

+        timeout: schema.maybe(schema.string()),
+        target_directory: schema.maybe(schema.string()),


curious where these additions came from?

That a good point, I should have pointed this in the PR description, I added a test that verify that all advenced settings generate a valid full policy response here and found a few settings that were missing from the schema, as we plan to backport this up to 8.17 I think it's okay to not have a dedicated PR for that wdyt?

jen-huang · 2025-08-29T00:30:21Z

x-pack/platform/plugins/shared/fleet/server/types/models/agent_policy.ts

+          metrics: schema.maybe(
+            schema.object({
+              period: schema.maybe(schema.string()),
+            })
+          ),


this one too

x-pack/platform/plugins/shared/fleet/common/settings/agent_policy_settings.tsx

nchaulet · 2025-08-29T18:31:49Z

Did you do some manual testing of clearing/un-setting this setting? Do brand new agent policies get '' as a value right away?
I remember encountering unexpected behavior before with these generated settings before, where the agent policies are always created with a non-undefined value for introduced settings (we don't want this since we prefer to use agent default unless user explicitly chooses otherwise). Just want to make sure we double check here :)

Yes I tested those, and I added a special case to handle '' to not render those settings

vishaangelova · 2025-08-29T19:06:23Z

Looping in @lcawl as I don’t know enough about the API docs (yet) and whether it’s possible to use the x-state in this case.

jen-huang

Code LGTM

lcawl · 2025-08-29T23:42:05Z

@vishaangelova I was not able to find any example of x-state added to a property managed by kbn/config-schema, and looking at the type it does not seems supported yet https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-config-schema/src/types/type.ts#L40 no?

You're right it looks like support for x-state has been added at the operation level but not yet at the parameter or property-level, so I've added that to our list of outstanding to-dos.

florent-leborgne

LGTM for experience docs.

@lcawl @vishaangelova Assuming that this PR gets merged before we allow x-state at the parameter or props level, will we create a separate task to update it later?

vishaangelova · 2025-09-01T09:48:03Z

@florent-leborgne good point! I’ve created an issue to track PRs related to Fleet APIs so that we can add the availability information when we have support for x-state at this level: elastic/docs-content#2769

nchaulet · 2025-09-02T07:54:13Z

@elasticmachine merge upstream

kibanamachine · 2025-09-02T10:02:37Z

Starting backport for target branches: 8.19, 9.1

https://github.com/elastic/kibana/actions/runs/17400085628

elasticmachine · 2025-09-02T10:03:07Z

💚 Build Succeeded

Buildkite Build
Commit: 20d7039

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	2.1MB	2.1MB	+1.1KB

History

💔 Build #333867 failed f80569b
💔 Build #333813 failed ddac8e1

cc @nchaulet

kibanamachine · 2025-09-02T10:09:53Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts
❌	9.1	Backport failed because of merge conflicts You might need to backport the following PRs to 9.1: - Add overlay for Fleet remote synced integrations API (#233493) - [ska] remove kbn/test-suites-xpack imports (#233427) - [Fleet] remove sync integrations APIs in serverless (#233482)

Manual backport

To create the backport manually run:

node scripts/backport --pr 233345

Questions ?

Please refer to the Backport tool documentation

nchaulet · 2025-09-02T10:26:50Z

💚 All backports created successfully

Status	Branch	Result
✅	9.1
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…c#233345) (cherry picked from commit 52c02e9) # Conflicts: # x-pack/platform/plugins/private/translations/translations/de-DE.json

…233345) (#233708) # Backport This will backport the following commits from `main` to `9.1`: - [[Fleet] Allow to configure monitoring runtime in agent policy (#233345)](#233345)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

…c#233345)

…233345) (#233710) # Backport This will backport the following commits from `main` to `8.19`: - [[Fleet] Allow to configure monitoring runtime in agent policy (#233345)](#233345)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…c#233345)

[Fleet] Allow to configure monitoring runtime in agent policy

b3e3ae7

fix

c390b18

nchaulet added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:Fleet Team label for Observability Data Collection Fleet team labels Aug 28, 2025

nchaulet self-assigned this Aug 28, 2025

nchaulet marked this pull request as ready for review August 28, 2025 18:08

nchaulet requested a review from a team as a code owner August 28, 2025 18:08

nchaulet added backport:prev-minor backport:version Backport to applied version labels v9.1.3 v8.19.3 and removed backport:prev-minor backport:skip This PR does not require backporting labels Aug 28, 2025

kibanamachine added 2 commits August 28, 2025 18:23

[CI] Auto-commit changed files from 'make api-docs'

ddac8e1

elastic-vault-github-plugin-prod bot requested a review from a team as a code owner August 28, 2025 18:42

nchaulet and others added 5 commits August 28, 2025 15:19

Add more tests

9dad233

Merge branch 'feature-fleet-agent-runtime-monitoring' of github.com:e…

6de6cc8

…lastic/kibana into feature-fleet-agent-runtime-monitoring

fix typo

22b8773

Merge branch 'feature-fleet-agent-runtime-monitoring' of github.com:e…

5b4baf5

…lastic/kibana into feature-fleet-agent-runtime-monitoring

bmorelli25 requested a review from vishaangelova August 28, 2025 19:41

kibanamachine added 3 commits August 28, 2025 20:27

[CI] Auto-commit changed files from 'make api-docs'

f80569b

[CI] Auto-commit changed files from 'node scripts/eslint_all_files --…

9de9b96

…no-cache --fix'

jen-huang reviewed Aug 29, 2025

View reviewed changes

vishaangelova reviewed Aug 29, 2025

View reviewed changes

x-pack/platform/plugins/shared/fleet/common/settings/agent_policy_settings.tsx Show resolved Hide resolved

nchaulet requested review from jen-huang and vishaangelova August 29, 2025 17:34

jen-huang approved these changes Aug 29, 2025

View reviewed changes

florent-leborgne approved these changes Sep 1, 2025

View reviewed changes

vishaangelova mentioned this pull request Sep 1, 2025

[Fleet] Add availability information at the parameter/property level for new Fleet API settings elastic/docs-content#2769

Open

vishaangelova approved these changes Sep 1, 2025

View reviewed changes

Merge branch 'main' into feature-fleet-agent-runtime-monitoring

20d7039

nchaulet enabled auto-merge (squash) September 2, 2025 08:26

nchaulet merged commit 52c02e9 into main Sep 2, 2025
13 checks passed

nchaulet deleted the feature-fleet-agent-runtime-monitoring branch September 2, 2025 10:02

kibanamachine added the v9.2.0 label Sep 2, 2025

This was referenced Sep 2, 2025

[9.1] [Fleet] Allow to configure monitoring runtime in agent policy (#233345) #233708

Merged

[8.19] [Fleet] Allow to configure monitoring runtime in agent policy (#233345) #233710

Merged

kibanamachine added the v9.1.4 label Sep 2, 2025

ymao1 pushed a commit to ymao1/kibana that referenced this pull request Sep 2, 2025

[Fleet] Allow to configure monitoring runtime in agent policy (elasti…

6e0c5e8

…c#233345)

kibanamachine added the v8.19.4 label Sep 2, 2025

MichelLosier pushed a commit to MichelLosier/kibana that referenced this pull request Sep 2, 2025

[Fleet] Allow to configure monitoring runtime in agent policy (elasti…

de165b6

…c#233345)

kowalczyk-krzysztof pushed a commit to kowalczyk-krzysztof/kibana that referenced this pull request Sep 3, 2025

[Fleet] Allow to configure monitoring runtime in agent policy (elasti…

75269c1

…c#233345)

	defaultMessage: 'Monitoring Runtime (experimental)',
	defaultMessage: 'Runtime monitoring (experimental)',

	text: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeLabel', {
	text: i18n.translate('xpack.fleet.settings.agentPolicyAdvanced.monitoringRuntimeOtelLabel', {

		timeout: schema.maybe(schema.string()),
		target_directory: schema.maybe(schema.string()),

[Fleet] Allow to configure monitoring runtime in agent policy #233345

[Fleet] Allow to configure monitoring runtime in agent policy #233345

Uh oh!

Conversation

nchaulet commented Aug 28, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

UI Changes

How to test

Uh oh!

cmacknz commented Aug 28, 2025

Uh oh!

elasticmachine commented Aug 28, 2025

Uh oh!

jen-huang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nchaulet commented Aug 29, 2025

Uh oh!

vishaangelova commented Aug 29, 2025

Uh oh!

jen-huang left a comment

Choose a reason for hiding this comment

Uh oh!

lcawl commented Aug 29, 2025

Uh oh!

florent-leborgne left a comment

Choose a reason for hiding this comment

Uh oh!

vishaangelova commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nchaulet commented Sep 2, 2025

Uh oh!

Uh oh!

kibanamachine commented Sep 2, 2025

Uh oh!

elasticmachine commented Sep 2, 2025

💚 Build Succeeded

Metrics [docs]

Async chunks

History

Uh oh!

kibanamachine commented Sep 2, 2025

💔 All backports failed

Manual backport

Questions ?

Uh oh!

nchaulet commented Sep 2, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

nchaulet commented Aug 28, 2025 •

edited by kibanamachine

Loading

vishaangelova commented Sep 1, 2025 •

edited

Loading