Regenerate integrations docs (#19161)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 9, 2024 at 04:43 UTC
ebfecae9073f66574589222560638d31e1dcd97c
2 files changed
+143
src/collectors/COLLECTORS.md
+2
@@ -1165,6 +1165,8 @@ If you don't see the app/service you'd like to monitor in this list:
1165
1166
- [Memory statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/memory_statistics.md)
1167
1168
+- [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md)
1169
+
1170
- [System statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_statistics.md)
1171
1172
- [System thermal zone](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_thermal_zone.md)
src/collectors/windows.plugin/integrations/net_framework.md
new
+141
@@ -0,0 +1,141 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/net_framework.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "NET Framework"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Windows Systems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# NET Framework
12
+
13
+
14
+<img src="https://netdata.cloud/img/dotnet.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibNetFramework
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors application built with .NET
25
+
26
+
27
+It queries different NET Framework objects per process from Perflib in order to gather the metrics.
28
+
29
+
30
+This collector is only supported on the following platforms:
31
+
32
+- windows
33
+
34
+This collector only supports collecting metrics from a single instance of this integration.
35
+
36
+
37
+### Default Behavior
38
+
39
+#### Auto-Detection
40
+
41
+The collector automatically detects all of the metrics, no further configuration is required.
42
+
43
+
44
+#### Limits
45
+
46
+The default configuration for this integration does not impose any limits on data collection.
47
+
48
+#### Performance Impact
49
+
50
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
+
52
+
53
+## Metrics
54
+
55
+Metrics grouped by *scope*.
56
+
57
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58
+
59
+
60
+
61
+### Per Processes running
62
+
63
+These metrics refer to NET applications.
64
+
65
+Labels:
66
+
67
+| Label | Description |
68
+|:-----------|:----------------|
69
+| process | The process name. |
70
+
71
+Metrics:
72
+
73
+| Metric | Dimensions | Unit |
74
+|:------|:----------|:----|
75
+| netframework.clrexception_thrown | exceptions | exceptions/s |
76
+| netframework.clrexception_filters | filters | filters/s |
77
+| netframework.clrexception_finallys | finallys | finallys/s |
78
+| netframework.clrexception_throw_to_catch_depth | traversed | stack_frames/s |
79
+| netframework.clrinterop_com_callable_wrappers | com_callable_wrappers | ccw/s |
80
+| netframework.clrinterop_interop_marshallings | marshallings | marshallings/s |
81
+| netframework.clrinterop_interop_stubs_created | created | stubs/s |
82
+| netframework.clrjit_methods | jit-compiled | methods/s |
83
+| netframework.clrjit_time | time | percentage |
84
+| netframework.clrjit_standard_failures | failures | failures/s |
85
+| netframework.clrjit_il_bytes | compiled_msil | bytes/s |
86
+| netframework.clrloading_loader_heap_size | committed | bytes |
87
+| netframework.clrloading_appdomains_loaded | loaded | domain/s |
88
+| netframework.clrloading_appdomains_unloaded | unloaded | domain/s |
89
+| netframework.clrloading_assemblies_loaded | loaded | assemblies/s |
90
+| netframework.clrloading_classes_loaded | loaded | classes/s |
91
+| netframework.clrloading_class_load_failures | class_load | failures/s |
92
+
93
+
94
+
95
+## Alerts
96
+
97
+There are no alerts configured by default for this integration.
98
+
99
+
100
+## Setup
101
+
102
+### Prerequisites
103
+
104
+No action required.
105
+
106
+### Configuration
107
+
108
+#### File
109
+
110
+The configuration file name for this integration is `netdata.conf`.
111
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
112
+
113
+The file format is a modified INI syntax. The general structure is:
114
+
115
+```ini
116
+[section1]
117
+ option1 = some value
118
+ option2 = some other value
119
+
120
+[section2]
121
+ option3 = some third value
122
+```
123
+You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
124
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
125
+
126
+```bash
127
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
128
+sudo ./edit-config netdata.conf
129
+```
130
+#### Options
131
+
132
+
133
+
134
+| Name | Description | Default | Required |
135
+|:----|:-----------|:-------|:--------:|
136
+| PerflibNetFramework | An option to enable or disable the data collection. | yes | no |
137
+
138
+#### Examples
139
+There are no configuration examples.
140
+
141
+