-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[DOCS-14455] Add custom log config to Fleet Automation #38049
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
Changes from all commits
b647e87
d2849aa
fa7d1ad
1031813
a028d04
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: Configure Custom Logs | ||
| description: "Remotely configure custom log collection at scale with Fleet Automation." | ||
| private: true | ||
| further_reading: | ||
| - link: "/agent/fleet_automation/" | ||
| tag: "Documentation" | ||
| text: "Fleet Automation" | ||
| - link: "/agent/fleet_automation/configure_integrations/" | ||
| tag: "Documentation" | ||
| text: "Configure Agent Integrations" | ||
| - link: "/agent/fleet_automation/configure_agents/" | ||
| tag: "Documentation" | ||
| text: "Configure Agents" | ||
| - link: "/api/latest/fleet-automation/" | ||
| tag: "Documentation" | ||
| text: "Fleet Automation API" | ||
| site_support_id: fleet-automation-standard-features | ||
| --- | ||
|
|
||
| Use [Fleet Automation][2] to manage custom log collection settings on your Agents remotely at scale. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Remote Configuration][1] enabled for your organization | ||
| - Agent version 7.76 or later | ||
| - Linux VMs (installed with the install script or the Ansible Datadog Role) or Windows VMs | ||
|
|
||
| <div class="alert alert-info"> | ||
| Configuring custom logs on Agents in containerized workloads is not supported. | ||
| </div> | ||
|
|
||
| ## Configure custom logs across multiple Agents | ||
|
|
||
| <div class="alert alert-tip">As you step through the configuration wizard, the <strong>Configuration Summary</strong> panel shows your current selected scope of Agents. Use this to check how a change would affect an Agent by previewing configuration diffs on a specific Agent in scope.</a></div> | ||
|
|
||
| 1. In Fleet Automation, open the [{{< ui >}}Configuration{{< /ui >}}][2] tab and click {{< ui >}}Configure Agents{{< /ui >}}. | ||
| 1. Scope the configuration to the target Agents. Filter by host information or tags to target a specific group. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it expected to have 1 everywhere instead of 1 2 3 4 ? Same for line 52
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Markdown accepts either -- you can do 1-2-3 or 1-1-1. If the latter, it will automatically number them correctly for you in the built version. I like to do 1-1-1 because then if you insert a step anywhere in the list, you don't have to re-number all the steps that follow. |
||
| 1. Choose {{< ui >}}Custom Logs{{< /ui >}}. | ||
| 1. Select an operation (for more information, see [How configuration changes are applied](#how-configuration-changes-are-applied)): | ||
|
|
||
| - {{< ui >}}Add New{{< /ui >}}. Specify the filename for the new configuration file, and fill in the configuration as prompted. You can add additional log collection settings by clicking {{< ui >}}+ Add Log Collection{{< /ui >}}. | ||
| - {{< ui >}}Edit & Replace{{< /ui >}}. Click {{< ui >}}Select a File{{< /ui >}} and choose the configuration file you want to replace, then update the log collection settings. | ||
| - {{< ui >}}Delete{{< /ui >}}. Click {{< ui >}}Select a File to Delete{{< /ui >}}. | ||
|
|
||
| <div class="alert alert-tip">Toggle between <strong>Visual</strong> and <strong>YAML</strong> mode when filling out the log collection configuration. Use <strong>YAML</strong> mode to paste in YAML directly.</div> | ||
|
|
||
| 1. Review the deployment plan. Fleet Automation generates a configuration diff for each affected Agent so you can verify the exact changes. | ||
| 1. Click {{< ui >}}Deploy Configuration{{< /ui >}} to start the deployment. Track progress from the [Deployments page][3]. | ||
|
|
||
| ## How configuration changes are applied | ||
|
|
||
| Each operation applies changes to custom log collection on an Agent differently: | ||
|
|
||
| - {{< ui >}}Add New{{< /ui >}}: Deploys a new configuration file. | ||
|
evazorro marked this conversation as resolved.
|
||
|
|
||
| - {{< ui >}}Edit & Replace{{< /ui >}}: Replaces the entire configuration file. Include all desired values in your update. Any values you omit are removed. | ||
|
evazorro marked this conversation as resolved.
|
||
|
|
||
| - {{< ui >}}Delete{{< /ui >}}: Removes the configuration file from the target Agents. | ||
|
|
||
| ## Further Reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: /agent/guide/setup_remote_config | ||
| [2]: https://app.datadoghq.com/fleet/agent-management | ||
| [3]: https://app.datadoghq.com/fleet/deployments | ||
Uh oh!
There was an error while loading. Please reload this page.