Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell authored Oct 29, 2024
2 parents 9c64146 + 69e7872 commit f5754b4
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 38 deletions.
10 changes: 0 additions & 10 deletions .github/issue_commands.json

This file was deleted.

21 changes: 0 additions & 21 deletions .github/workflows/issue_commands.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,19 @@ For a server name to be included, it must match the regular expression specified

### service block

Name | Type | Description | Default | Required
---------------|----------|-------------------------------------------------------|---------|---------
`use_api` | `string` | Use API calls to collect service data instead of WMI. | `false` | no
`where_clause` | `string` | WQL 'where' clause to use in WMI metrics query. | `""` | no
Name | Type | Description | Default | Required
---------------|----------|-------------------------------------------------------------|---------|---------
`use_api` | `string` | Use the Windows API to collect service data instead of WMI. | `false` | no
`where_clause` | `string` | WQL 'where' clause to use in WMI metrics query. | `""` | no

The `where_clause` argument can be used to limit the response to the services you specify, reducing the size of the response.
If `use_api` is enabled, 'where_clause' won't be effective.

The Windows API is more performant than WMI. Set `use_api` to `true` in situations when the WMI takes too long to get the service information.
Setting `use_api` to `true` does have a few disadvantages compared to using WMI:
* WMI queries in `where_clause` won't work.
* The `status` field of the service is not available. You can use the `state` property to retrieve status information. This property provides the same information, but it is formatted differently.


### smtp block

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,15 @@ Full reference of options:
# "WQL 'where' clause to use in WMI metrics query. Limits the response to the services you specify and reduces the size of the response.
# Maps to collector.service.services-where in windows_exporter
[where_clause: <string> | default=""]
# If "use_api" is set to "true", service data will be collected via the Windows API.
# If "use_api" is set to "false", service data will be collected via WMI.
# When "use_api" is set to "true", "where_clause" will be ignored and will not take effect.
# The Windows API is more performant than WMI. Set `use_api` to `true` in situations when the WMI takes too long to get the service information.
# Setting `use_api` to `true` does have a few disadvantages compared to using WMI:
# * WMI queries in `where_clause` won't work.
# * The `status` field of the service won't be reported. Instead, use the `state` property.
# It has the same information, albeit formatted differently.
[use_api: <boolean> | default = false]

# Configuration for physical disk on Windows
physical_disk:
Expand Down
6 changes: 3 additions & 3 deletions internal/web/ui/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8473,9 +8473,9 @@ rollup-plugin-terser@^7.0.0:
terser "^5.0.0"

rollup@^2.43.1:
version "2.79.1"
resolved "https://registry.yarnpkg.com/rollup/-/rollup-2.79.1.tgz#bedee8faef7c9f93a2647ac0108748f497f081c7"
integrity sha512-uKxbd0IhMZOhjAiD5oAFp7BqvkA4Dv47qpOCtaNvng4HBwdbWtdOh8f5nZNuk2rp51PMGk3bzfWu5oayNEuYnw==
version "2.79.2"
resolved "https://registry.yarnpkg.com/rollup/-/rollup-2.79.2.tgz#f150e4a5db4b121a21a747d762f701e5e9f49090"
integrity sha512-fS6iqSPZDs3dr/y7Od6y5nha8dW1YnbgtsyotCVvoFGKbERG++CVRFv1meyGDE1SNItQA8BrnCw7ScdAhRJ3XQ==
optionalDependencies:
fsevents "~2.3.2"

Expand Down

0 comments on commit f5754b4

Please sign in to comment.