forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add metricbeat iis module (elastic#15059)
* created iis module * work in progress * iis changes * add iis module * light * work on build * work on build * build * fmt update * temp * work on website * temp * temp * manifest changes * temp * temp * work on wp * adding application pool metricset * wmi option * test * work on apppool * work on app pool * work on website metricset * work on tests * Work on website * work on website * work on website * perfmon fix * work on websie * update config * feedback * work on feedback * temp * ecs * temp * add counters
- Loading branch information
Showing
45 changed files
with
1,716 additions
and
42 deletions.
There are no files selected for viewing
This file contains 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 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,99 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-module-iis]] | ||
== iis module | ||
|
||
beta[] | ||
|
||
This is the iis module. | ||
|
||
IIS (Internet Information Services) is a secure, reliable, and scalable Web server that provides an easy to manage platform for developing and hosting Web applications and services. | ||
|
||
The `iis` module will periodically retrieve IIS related metrics using performance counters such as: | ||
|
||
- System/Process counters like the the overall server and CPU usage for the IIS Worker Process and memory (currently used and available memory for the IIS Worker Process). | ||
- IIS performance counters like Web Service: Bytes Received/Sec, Web Service: Bytes Sent/Sec, etc, which are helpful to track to identify potential spikes in traffic. | ||
- Web Service Cache counters in order to monitor user mode cache and output cache. | ||
|
||
|
||
The `iis` module mericsets are `webserver`, `website` and `application_pool`. | ||
|
||
[source,yaml] | ||
---- | ||
- module: iis | ||
metricsets: | ||
- webserver | ||
- website | ||
- application_pool | ||
enabled: true | ||
period: 10s | ||
# filter on application pool names | ||
# application_pool.name: [] | ||
---- | ||
|
||
[float] | ||
== Metricsets | ||
|
||
[float] | ||
=== `webserver` | ||
A light metricset using the windows perfmon metricset as the base metricset. | ||
This metricset allows users to retrieve aggregated metrics for the entire webserver, | ||
|
||
[float] | ||
=== `website` | ||
A light metricset using the windows perfmon metricset as the base metricset. | ||
This metricset will collect metrics of specific sites, users can configure which websites they want to monitor, else, all are considered. | ||
|
||
[float] | ||
=== `application_pool` | ||
This metricset will collect metrics of specific application pools, users can configure which websites they want to monitor, else, all are considered. | ||
|
||
|
||
[float] | ||
=== Module-specific configuration notes | ||
|
||
`application_pool.name`:: []string, users can specify the application pools they would like to monitor. | ||
|
||
|
||
|
||
[float] | ||
=== Example configuration | ||
|
||
The iis module supports the standard configuration options that are described | ||
in <<configuration-metricbeat>>. Here is an example configuration: | ||
|
||
[source,yaml] | ||
---- | ||
metricbeat.modules: | ||
- module: iis | ||
metricsets: | ||
- webserver | ||
- website | ||
- application_pool | ||
enabled: true | ||
period: 10s | ||
# filter on application pool names | ||
# application_pool.name: [] | ||
---- | ||
|
||
[float] | ||
=== Metricsets | ||
|
||
The following metricsets are available: | ||
|
||
* <<metricbeat-metricset-iis-application_pool,application_pool>> | ||
|
||
* <<metricbeat-metricset-iis-webserver,webserver>> | ||
|
||
* <<metricbeat-metricset-iis-website,website>> | ||
|
||
include::iis/application_pool.asciidoc[] | ||
|
||
include::iis/webserver.asciidoc[] | ||
|
||
include::iis/website.asciidoc[] | ||
|
This file contains 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,23 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-metricset-iis-application_pool]] | ||
=== iis application_pool metricset | ||
|
||
beta[] | ||
|
||
include::../../../module/iis/application_pool/_meta/docs.asciidoc[] | ||
|
||
|
||
==== Fields | ||
|
||
For a description of each field in the metricset, see the | ||
<<exported-fields-iis,exported fields>> section. | ||
|
||
Here is an example document generated by this metricset: | ||
|
||
[source,json] | ||
---- | ||
include::../../../module/iis/application_pool/_meta/data.json[] | ||
---- |
This file contains 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,24 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-metricset-iis-webserver]] | ||
=== iis webserver metricset | ||
|
||
beta[] | ||
|
||
include::../../../module/iis/webserver/_meta/docs.asciidoc[] | ||
|
||
This is a default metricset. If the host module is unconfigured, this metricset is enabled by default. | ||
|
||
==== Fields | ||
|
||
For a description of each field in the metricset, see the | ||
<<exported-fields-iis,exported fields>> section. | ||
|
||
Here is an example document generated by this metricset: | ||
|
||
[source,json] | ||
---- | ||
include::../../../module/iis/webserver/_meta/data.json[] | ||
---- |
This file contains 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,24 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-metricset-iis-website]] | ||
=== iis website metricset | ||
|
||
beta[] | ||
|
||
include::../../../module/iis/website/_meta/docs.asciidoc[] | ||
|
||
This is a default metricset. If the host module is unconfigured, this metricset is enabled by default. | ||
|
||
==== Fields | ||
|
||
For a description of each field in the metricset, see the | ||
<<exported-fields-iis,exported fields>> section. | ||
|
||
Here is an example document generated by this metricset: | ||
|
||
[source,json] | ||
---- | ||
include::../../../module/iis/website/_meta/data.json[] | ||
---- |
This file contains 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 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 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.