Skip to content

Document Windows NPM setup and make sure it starts#761

Merged
mx-psi merged 6 commits intomainfrom
mx-psi/document-sysprobe-setup
Nov 17, 2022
Merged

Document Windows NPM setup and make sure it starts#761
mx-psi merged 6 commits intomainfrom
mx-psi/document-sysprobe-setup

Conversation

@mx-psi
Copy link
Copy Markdown
Member

@mx-psi mx-psi commented Nov 2, 2022

What does this PR do?

  • Add documentation about the need to use windows_npm_install when setting up NPM on Windows.
  • Restart Datadog Agent service on Windows on system probe configuration changes.

Motivation

  • Flag was undocumented and we did not mention this explicitly anywhere.
  • The NPM driver did not start since the system probe class was applied after the service start.

Additional Notes

It's difficult to do this automatically since we would have to call the datadog::datadog_agent class on the datadog::system_probe one, so instead we are just documenting this.

Describe your test plan

Docs only change.

@mx-psi mx-psi requested review from a team as code owners November 2, 2022 12:17
Copy link
Copy Markdown
Contributor

@buraizu buraizu left a comment

Choose a reason for hiding this comment

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

Approving, but left a small suggestion for consistency with other parameter descriptions

Comment thread README.md Outdated
mx-psi and others added 2 commits November 3, 2022 09:06
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
@mx-psi mx-psi mentioned this pull request Nov 17, 2022
@mx-psi mx-psi force-pushed the mx-psi/document-sysprobe-setup branch from 5e00d4f to 640f5ca Compare November 17, 2022 10:57
@mx-psi mx-psi changed the title Add documentation about Windows NPM setup Document Windows NPM setup and make sure it starts Nov 17, 2022
Copy link
Copy Markdown
Contributor

@KSerrania KSerrania left a comment

Choose a reason for hiding this comment

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

I've left some comments about the documentation, but otherwise this looks great!

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
@mx-psi mx-psi requested a review from KSerrania November 17, 2022 13:58
@mx-psi mx-psi merged commit 0f4573d into main Nov 17, 2022
@mx-psi mx-psi deleted the mx-psi/document-sysprobe-setup branch November 17, 2022 14:17
cegeka-jenkins pushed a commit to cegeka/puppet-datadog_agent that referenced this pull request Feb 5, 2026
* Add documentation about Windows NPM setup

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>

* Add note about previous install

* Notify services on system probe file updates

* Restart the main Agent instead of the system probe

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants