Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fleet] Add variable to the preconfiguration example #981

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

nchaulet
Copy link
Member

Description

Resolve elastic/kibana#159444

Add variable to the preconfiguration example

@nchaulet nchaulet requested a review from a team as a code owner March 25, 2024 14:05
Copy link

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.

Copy link
Contributor

mergify bot commented Mar 25, 2024

This pull request does not have a backport label. Could you fix it @nchaulet? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@@ -49,7 +49,7 @@ xpack.fleet.agentPolicies:
name: fleet_server
----

The following example creates an agent policy for general use:
The following example creates an agent policy for general use, that customize the period for the system.core metrics:
Copy link
Member Author

@nchaulet nchaulet Mar 25, 2024

Choose a reason for hiding this comment

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

@kilfoyle will it make sense to add something to tell the user they can find all the available input and variable in the integration UI?

Copy link
Contributor

Choose a reason for hiding this comment

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

@nchaulet I think that makes sense. Do you think it might be better to refer people to the Integrations documentation rather than the UI? Usually the docs are better as a reference, but I don't see that period setting described on the System integration page.

Depending on which is better (refer people to the docs or to the UI), here are a couple of suggestions for the text.

Refer users to the docs:

The following example creates an agent policy for general use, and customizes the `period` setting for the `system.core` data stream. All available inputs and variables are described in the link:https://docs.elastic.co/en/integrations[Integrations] documentation.

Refer users to the UI:

The following example creates an agent policy for general use, and customizes the `period` setting for the `system.core` data stream. You can find all available inputs and variables in the **Integrations** app in {kib}.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you think it might be better to refer people to the Integrations documentation rather than the UI? Usually the docs are better as a reference, but I don't see that period setting described on the System integration page.

Unfortunately I do not think we have the information in the Integrations documentation

Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚢
Thanks @nchaulet!

@nchaulet nchaulet merged commit e36ed87 into main Mar 25, 2024
3 checks passed
@nchaulet nchaulet deleted the feature-doc-preconfigured-variables branch March 25, 2024 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Fleet] Add example about preconfigured policies with variables
2 participants