Skip to content

Commit b914be4

Browse files
mrafi97rtrieu
andauthored
Update README
Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
1 parent b9e7e3e commit b914be4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

windows_certificate/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
## Overview
44

5-
This integration monitors the Local Machine certificates in the [Windows Certificate Store][1] for ceritificate expiration.
5+
This integration monitors the Local Machine certificates in the [Windows Certificate Store][1] to check whether any of have expired.
66

77
## Setup
88

99
### Installation
1010

11-
The Windows Certificate Store integration is included in the [Datadog Agent][2] package. Please see the next section to configure.
11+
The Windows Certificate Store integration is included in the [Datadog Agent][2] package but requires configuration (see instructions below).
1212

1313
### Configuration
1414

15-
Edit the `windows_certificate.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][10]. See the [sample windows_certificate.d/conf.yaml][4] for all available configuration options. When you are done editing the configuration file, [restart the Agent][5] to load the new configuration.
15+
Edit the `windows_certificate.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][10]. See the [`sample windows_certificate.d/conf.yaml`][4] for all available configuration options. When you are done editing the configuration file, [restart the Agent][5] to load the new configuration.
1616

1717
The integration can monitor the expiration of all certificates in a given store or selectively monitor specific certificates from a given list of strings matching with the certificate subjects. The store names that are available for monitoring are listed in `HKEY_LOCAL_MACHINE\Software\Microsoft\SystemCertificates`.
1818

@@ -22,15 +22,15 @@ This example configuration monitors all certificates in the local machine's `ROO
2222
instances:
2323
- certificate_store: ROOT
2424
```
25-
This example configuraiton monitors ceritificates in `ROOT` that have `microsoft` or `verisign` in the subject:
25+
This example configuration monitors certificates in `ROOT` that have `microsoft` or `verisign` in the subject:
2626
```yaml
2727
instances:
2828
- certificate_store: ROOT
2929
certificate_subjects:
3030
- microsoft
3131
- verisign
3232
```
33-
The parameters `days_warning` and `days_critical` are used to specify the number of days before certificate expiration from which the service check `windows_certificate.cert_expiration` begins emitting WARNING/CRITICAL. In the below example the service check will emit a WARNING when a certificate is 10 days from expiring and CRITICAL when it is 5 days away from expiring:
33+
The parameters `days_warning` and `days_critical` are used to specify the number of days before certificate expiration from which the service check `windows_certificate.cert_expiration` begins emitting WARNING/CRITICAL alerts. In the below example the service check emits a WARNING alert when a certificate is 10 days from expiring and CRITICAL when it is 5 days away from expiring:
3434
```yaml
3535
instances:
3636
- certificate_store: ROOT

0 commit comments

Comments
 (0)