Add Windows Certificate Store Integration Tile #20337
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # CHANGELOG - windows_certificate | ||
|
|
||
| ## 1.0.0 / 2025-05-20 | ||
|
|
||
| ***Added***: | ||
|
|
||
| * Initial Release |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,76 @@ | ||||||
| # Agent Check: Windows Certificate Store | ||||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| This integration monitors the Local Machine certificates in the [Windows Certificate Store][1] for ceritificate expiration. | ||||||
|
|
||||||
| ## Setup | ||||||
|
|
||||||
| ### Installation | ||||||
|
|
||||||
| The Windows Certificate Store integration is included in the [Datadog Agent][2] package. Please see the next section to configure. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### Configuration | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Not sure if "alert" is the most accurate term here, or "notification", but we should include an adjective.
Suggested change
|
||||||
|
|
||||||
| 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`. | ||||||
|
|
||||||
| This example configuration monitors all certificates in the local machine's `ROOT` store: | ||||||
|
|
||||||
| ```yaml | ||||||
| instances: | ||||||
| - certificate_store: ROOT | ||||||
| ``` | ||||||
| This example configuraiton monitors ceritificates in `ROOT` that have `microsoft` or `verisign` in the subject: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| ```yaml | ||||||
| instances: | ||||||
| - certificate_store: ROOT | ||||||
| certificate_subjects: | ||||||
| - microsoft | ||||||
| - verisign | ||||||
| ``` | ||||||
| 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: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| ```yaml | ||||||
| instances: | ||||||
| - certificate_store: ROOT | ||||||
| certificate_subjects: | ||||||
| - microsoft | ||||||
| - verisign | ||||||
| days_warning: 10 | ||||||
| days_critical: 5 | ||||||
| ``` | ||||||
|
|
||||||
| ### Validation | ||||||
|
|
||||||
| [Run the Agent's status subcommand][6] and look for `windows_certificate` under the Checks section. | ||||||
|
|
||||||
| ## Data Collected | ||||||
|
|
||||||
| ### Metrics | ||||||
|
|
||||||
| See [metadata.csv][7] for a list of metrics provided by this integration. | ||||||
|
|
||||||
| ### Events | ||||||
|
|
||||||
| The windows_certificate integration does not include any events. | ||||||
|
|
||||||
| ### Service Checks | ||||||
|
|
||||||
| See [service_checks.json][8] for a list of service checks provided by this integration. | ||||||
|
|
||||||
| ## Troubleshooting | ||||||
|
|
||||||
| Need help? Contact [Datadog support][9]. | ||||||
|
|
||||||
|
|
||||||
| [1]: https://learn.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores | ||||||
| [2]: https://app.datadoghq.com/account/settings/agent/latest | ||||||
| [3]: https://docs.datadoghq.com/agent/kubernetes/integrations/ | ||||||
| [4]: https://github.com/DataDog/datadog-agent/blob/main/cmd/agent/dist/conf.d/windows_certificate.d/conf.yaml.example | ||||||
| [5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent | ||||||
| [6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information | ||||||
| [7]: https://github.com/DataDog/integrations-core/blob/master/windows_certificate/metadata.csv | ||||||
| [8]: https://github.com/DataDog/integrations-core/blob/master/windows_certificate/assets/service_checks.json | ||||||
| [9]: https://docs.datadoghq.com/help/ | ||||||
| [10]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| { | ||
| "author_name": "Datadog", | ||
| "description": "## Windows Certificate Store Integration Dashboard\n\nThis is an example Windows Certificate Store dashboard demonstrating the information that the integration collects.", | ||
| "layout_type": "ordered", | ||
| "template_variables": [ | ||
| { | ||
| "available_values": [], | ||
| "default": "*", | ||
| "name": "certificate_store", | ||
| "prefix": "certificate_store" | ||
| }, | ||
| { | ||
| "available_values": [], | ||
| "default": "*", | ||
| "name": "subject_common_name", | ||
| "prefix": "subject_cn" | ||
| } | ||
| ], | ||
| "title": "Windows Certificate Store Overview", | ||
| "widgets": [ | ||
| { | ||
| "definition": { | ||
| "has_background": true, | ||
| "has_border": true, | ||
| "horizontal_align": "center", | ||
| "sizing": "contain", | ||
| "type": "image", | ||
| "url": "https://static.datadoghq.com/static/images/logos/windows-certificate_large.svg", | ||
| "vertical_align": "center" | ||
| }, | ||
| "id": 4652925140828556, | ||
| "layout": { | ||
| "height": 5, | ||
| "width": 4, | ||
| "x": 0, | ||
| "y": 0 | ||
| } | ||
| }, | ||
| { | ||
| "definition": { | ||
| "background_color": "vivid_blue", | ||
| "layout_type": "ordered", | ||
| "show_title": true, | ||
| "title": "Certificate Expiration", | ||
| "type": "group", | ||
| "widgets": [ | ||
| { | ||
| "definition": { | ||
| "check": "windows_certificate.cert_expiration", | ||
| "group_by": [], | ||
| "grouping": "cluster", | ||
| "tags": [ | ||
| "$certificate_store", | ||
| "$subject_common_name" | ||
| ], | ||
| "title": "Certificate Expiration", | ||
| "title_align": "center", | ||
| "title_size": "16", | ||
| "type": "check_status" | ||
| }, | ||
| "id": 5168903633321084, | ||
| "layout": { | ||
| "height": 2, | ||
| "width": 4, | ||
| "x": 0, | ||
| "y": 0 | ||
| } | ||
| }, | ||
| { | ||
| "definition": { | ||
| "background_color": "yellow", | ||
| "content": "Included service check:\n\n* `windows_certificate.cert_expiration` - Returns CRITICAL if the certificate has expired or expires in less than `days_critical`, returns WARNING if the certificate expires in less than `days_warning`, otherwise returns OK.", | ||
| "font_size": "14", | ||
| "has_padding": true, | ||
| "show_tick": true, | ||
| "text_align": "left", | ||
| "tick_edge": "left", | ||
| "tick_pos": "50%", | ||
| "type": "note", | ||
| "vertical_align": "center" | ||
| }, | ||
| "id": 6717423497232037, | ||
| "layout": { | ||
| "height": 2, | ||
| "width": 3, | ||
| "x": 4, | ||
| "y": 0 | ||
| } | ||
| }, | ||
| { | ||
| "definition": { | ||
| "legend_columns": [ | ||
| "avg", | ||
| "min", | ||
| "max", | ||
| "value", | ||
| "sum" | ||
| ], | ||
| "legend_layout": "auto", | ||
| "requests": [ | ||
| { | ||
| "display_type": "line", | ||
| "formulas": [ | ||
| { | ||
| "formula": "query1" | ||
| } | ||
| ], | ||
| "queries": [ | ||
| { | ||
| "data_source": "metrics", | ||
| "name": "query1", | ||
| "query": "avg:windows_certificate.days_remaining{$certificate_store, $subject_common_name} by {subject_cn}" | ||
| } | ||
| ], | ||
| "response_format": "timeseries", | ||
| "style": { | ||
| "line_type": "solid", | ||
| "line_width": "normal", | ||
| "order_by": "values", | ||
| "palette": "dog_classic" | ||
| } | ||
| } | ||
| ], | ||
| "show_legend": true, | ||
| "title": "Days Till Expiration", | ||
| "title_align": "left", | ||
| "title_size": "16", | ||
| "type": "timeseries" | ||
| }, | ||
| "id": 4514519614660249, | ||
| "layout": { | ||
| "height": 2, | ||
| "width": 4, | ||
| "x": 0, | ||
| "y": 2 | ||
| } | ||
| }, | ||
| { | ||
| "definition": { | ||
| "background_color": "yellow", | ||
| "content": "Days until certificate(s) expire", | ||
| "font_size": "14", | ||
| "has_padding": true, | ||
| "show_tick": true, | ||
| "text_align": "left", | ||
| "tick_edge": "left", | ||
| "tick_pos": "50%", | ||
| "type": "note", | ||
| "vertical_align": "center" | ||
| }, | ||
| "id": 3226539913664578, | ||
| "layout": { | ||
| "height": 1, | ||
| "width": 3, | ||
| "x": 4, | ||
| "y": 2 | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "id": 3432759619201891, | ||
| "layout": { | ||
| "height": 5, | ||
| "width": 7, | ||
| "x": 4, | ||
| "y": 0 | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "version": 2, | ||
| "created_at": "2025-05-13", | ||
| "last_updated_at": "2025-05-13", | ||
| "title": "A certificate is expired or about to expire", | ||
| "description": "This monitor alerts when there are certificates in the Windows Certificate Store that are expired or close to expiring.", | ||
| "tags": [ | ||
| "integration:windows-certificate" | ||
| ], | ||
| "definition": { | ||
| "name": "A certificate is expired or about to expire", | ||
| "type": "service check", | ||
| "query": "\"windows_certificate.cert_expiration\".over(\"*\").by(\"certificate_store\",\"host\",\"subject_cn\").last(2).count_by_status()", | ||
| "message": "The Windows Certificate integration is reporting the following for Certificate: {{subject_cn.name}} in Store: {{certificate_store.name}}\n\n{{#is_warning}}\n\nWarning: {{check_message}}\n\n{{/is_warning}}\n\n{{#is_alert}}\n\nAlert: {{check_message}}\n\n{{/is_alert}}", | ||
| "tags": [ | ||
| "integration:windows_certificate" | ||
| ], | ||
| "options": { | ||
| "thresholds": { | ||
| "critical": 1, | ||
| "warning": 1, | ||
| "ok": 1 | ||
| }, | ||
| "notify_audit": false, | ||
| "notify_no_data": false, | ||
| "renotify_interval": 0, | ||
| "timeout_h": 0, | ||
| "threshold_windows": null, | ||
| "include_tags": true, | ||
| "new_group_delay": 60, | ||
| "avalanche_window": 10 | ||
| }, | ||
| "priority": null | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [ | ||
| { | ||
| "agent_version": "7.67.0", | ||
| "integration": "Windows Certificate Store", | ||
| "groups": [ | ||
| "certificate_store", | ||
| "subject_cn", | ||
| "subject_ou", | ||
| "subject_c", | ||
| "subject_o", | ||
| "subject_l" | ||
| ], | ||
| "check": "windows_certificate.cert_expiration", | ||
| "statuses": [ | ||
| "ok", | ||
| "critical", | ||
| "warning" | ||
| ], | ||
| "name": "Certificate validation", | ||
| "description": "Returns `CRITICAL` if the certificate has expired or expires in less than `days_critical`, returns `WARNING` if the certificate expires in less than `days_warning`, otherwise returns `OK`." | ||
| } | ||
| ] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| { | ||
| "manifest_version": "2.0.0", | ||
| "app_uuid": "67feed3c-1676-4d6b-9d72-3ca8c0a6e3dc", | ||
| "app_id": "windows-certificate", | ||
| "display_on_public_website": false, | ||
| "tile": { | ||
| "overview": "README.md#Overview", | ||
| "configuration": "README.md#Setup", | ||
| "support": "README.md#Support", | ||
| "changelog": "CHANGELOG.md", | ||
| "description": "Monitor your Windows hosts' certificates stores for certificate expiration.", | ||
| "title": "Windows Certificate Store", | ||
| "media": [], | ||
| "classifier_tags": [ | ||
| "Supported OS::Windows", | ||
| "Category::OS & System", | ||
| "Category::Windows", | ||
| "Offering::Integration", | ||
| "Submitted Data Type::Metrics" | ||
| ] | ||
| }, | ||
| "assets": { | ||
| "integration": { | ||
| "auto_install": true, | ||
| "source_type_id": 46050783, | ||
| "source_type_name": "Windows Certificate Store", | ||
| "configuration": {}, | ||
| "events": { | ||
| "creates_events": false | ||
| }, | ||
| "metrics": { | ||
| "prefix": "windows_certificate.", | ||
| "check": "windows_certificate.days_remaining", | ||
| "metadata_path": "metadata.csv" | ||
| }, | ||
| "service_checks": { | ||
| "metadata_path": "assets/service_checks.json" | ||
| } | ||
| }, | ||
| "dashboards": { | ||
| "Windows Certificate Store Overview": "assets/dashboards/windows_certificate_overview.json" | ||
| }, | ||
| "monitors": { | ||
| "A certificate is expired or about to expire": "assets/monitors/windows_certificate_expiration.json" | ||
| } | ||
| }, | ||
| "author": { | ||
| "support_email": "[email protected]", | ||
| "name": "Datadog", | ||
| "homepage": "https://www.datadoghq.com", | ||
| "sales_email": "[email protected]" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric,sample_tags | ||
| windows_certificate.days_remaining,gauge,,day,,Days until certificate expiration,1,windows_certificate_store,Days until expiration,, |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.