Skip to content

Add new policy settings available in Fleet#1076

Merged
kilfoyle merged 3 commits intoelastic:mainfrom
kilfoyle:1073/policy-settings
May 17, 2024
Merged

Add new policy settings available in Fleet#1076
kilfoyle merged 3 commits intoelastic:mainfrom
kilfoyle:1073/policy-settings

Conversation

@kilfoyle
Copy link
Copy Markdown
Member

@kilfoyle kilfoyle commented May 16, 2024 •
edited by jen-huang
Loading

This updates the Elastic Agent policies docs page with three settings added to the Fleet UI for 8.15:

  • Limit CPU usage
  • Agent HTTP monitoring
  • Agent logging level

@jen-huang and @juliaElastic This also removes the Maximum CPU usage and HTTP monitoring endpoint settings from the Enable custom settings in an agent policy page. To avoid any broken links from the UI (and the Kibana CI link checker complaining), can you please update the UI "Learn more" links for these three settings to these URLs:

https://www.elastic.co/guide/en/fleet/current/agent-policy.html#agent-policy-limit-cpu
https://www.elastic.co/guide/en/fleet/current/agent-policy.html#agent-policy-http-monitoring
https://www.elastic.co/guide/en/fleet/current/agent-policy.html#agent-policy-log-level

Also, Jen, if elastic/elastic-agent#4747 doesn't make 8.15 please let me know and I'll remove the log level section.

Target: 8.15
Closes: #1073

P.S. I guess there are other settings soon to come, so please let me know whenever those need to be added to the docs.

PREVIEW

Maximum CPU
Screenshot 2024-05-16 at 3 30 05 PM

Default monitoring port
Screenshot 2024-05-16 at 3 31 00 PM

Log level
Screenshot 2024-05-17 at 9 43 57 AM

@kilfoyle kilfoyle requested a review from a team as a code owner May 16, 2024 19:49
@github-actions
Copy link
Copy Markdown

github-actions bot commented May 16, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

jen-huang
jen-huang previously approved these changes May 16, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@jen-huang jen-huang left a comment

Choose a reason for hiding this comment

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

Thanks @kilfoyle! I'll keep on eye on that agent bug and open a PR to adjust the doc for these settings.

juliaElastic
juliaElastic reviewed May 17, 2024
View reviewed changes
docs/en/ingest-management/agent-policies.asciidoc Outdated

. Set **Agent HTTP monitoring** setting to enabled, and then specify a host and port for the monitoring data output.

. Enable **buffer.enabled** if you'd like {agent} and {beats} to collect metrics into an in-memory buffer and expose these through a `/buffer` endpoint. This data can be useful for debugging or if the {agent} has issues communicating with {es}. Enabling this option may slightly increase process memory usage.
Copy link
Copy Markdown
Contributor

@juliaElastic juliaElastic May 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Currently the enabled and buffer.enabled flags are not visible on the UI because I couldn't test it successfully: elastic/kibana#180922 (comment)

@ycombinator Should I raise an issue on agent side for this or can someone check on agent side if these flags can be changed from the policy?

Copy link
Copy Markdown
Contributor

@ycombinator ycombinator May 17, 2024

Choose a reason for hiding this comment

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

Reading elastic/kibana#180922 (comment), these settings should work so I'd file a bug in Agent with steps to reproduce so we can prioritize fixing it. Thanks!

Copy link
Copy Markdown
Member Author

@kilfoyle kilfoyle May 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@juliaElastic For now I've removed mention of the enabled and the buffer.enabled flags. If these get added back to the UI please just let me know and I'll fix up the docs.

juliaElastic
juliaElastic reviewed May 17, 2024
View reviewed changes
karenzone
karenzone approved these changes May 17, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM!

@jen-huang jen-huang mentioned this pull request May 17, 2024
Merged
@kilfoyle kilfoyle merged commit 854fa22 into elastic:main May 17, 2024
jen-huang added a commit to elastic/kibana that referenced this pull request May 17, 2024
@jen-huang
[UII] Update doc links for agent policy settings (#183761)
7a51ad9 
## Summary

Update doc links for some agent policy settings that will be changed
with @kilfoyle's work in
elastic/ingest-docs#1076
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ycombinator ycombinator ycombinator left review comments

@juliaElastic juliaElastic juliaElastic left review comments

+2 more reviewers

@jen-huang jen-huang jen-huang approved these changes

@karenzone karenzone karenzone approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

backport-skip

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Fleet] Document HTTP monitoring config

5 participants

@kilfoyle @ycombinator @jen-huang @karenzone @juliaElastic