Skip to content

Commit

Permalink
Add documentation about Windows NPM setup
Browse files Browse the repository at this point in the history
  • Loading branch information
mx-psi committed Nov 2, 2022
1 parent 2ea3a5b commit 91724a9
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,19 @@ With the [`ini_setting` module](https://forge.puppet.com/modules/puppetlabs/inif

5. Verify your Puppet data is in Datadog by searching for `sources:puppet` in the [Event Stream][5].

### NPM setup

To enable the Datadog Agent Network Performance Monitoring (NPM) features follow these steps:

1. (Windows only) Pass the `windows_npm_install` option with value `true` to the `datadog::datadog_agent` class.
2. Use the `datadog_agent::system_probe` class to properly create the configuration file:

```conf
class { 'datadog_agent::system_probe':
enabled => true,
}
```

### Troubleshooting

You can run the Puppet Agent manually to check for errors in the output:
Expand Down Expand Up @@ -281,6 +294,7 @@ These variables can be set in the `datadog_agent` class to control settings in t
| `scrub_args` | A boolean to enable the process cmdline scrubbing (defaults to true). |
| `custom_sensitive_words` | An array to add more words beyond the default ones used by the scrubbing feature (defaults to `[]`). |
| `logs_enabled` | A boolean to enable the logs Agent (defaults to false). |
| `windows_npm_install` | A boolean to enable the Windows NPM driver installation (defaults to false) |
| `container_collect_all` | A boolean to enable logs collection for all containers. |
| `agent_extra_options`<sup>1</sup> | A hash to provide additional configuration options (Agent v6 and v7 only). |
| `hostname_extraction_regex`<sup>2</sup> | A regex used to extract the hostname captured group to report the run in Datadog instead of reporting the Puppet nodename, for example:<br>`'^(?<hostname>.*\.datadoghq\.com)(\.i-\w{8}\..*)?$'` |
Expand Down
5 changes: 5 additions & 0 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,11 @@
# $apt_release
# The distribution channel to be used for the APT repo. Eg: 'stable' or 'beta'.
# String. Default: stable
# $windows_npm_install
# (Windows only) Boolean to install the Windows NPM driver.
# To use NPM features it is necessary to enable install through this flag, as well as
# configuring NPM through the datadog::system_probe class.
# Boolean. Default: false
#
# Sample Usage:
#
Expand Down
7 changes: 7 additions & 0 deletions manifests/system_probe.pp
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Class: datadog_agent::system_probe
#
# This class contains the Datadog agent system probe (NPM) configuration.
# On Windows, install the NPM driver by setting 'windows_npm_install'
# to 'true on the datadog_agent class.
#

class datadog_agent::system_probe(
Boolean $enabled = false,
Boolean $network_enabled = false,
Expand Down

0 comments on commit 91724a9

Please sign in to comment.