| 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/Collectors/Applications" |
| 7 | keywords: ['windows', 'microsoft', 'netframework', 'dotnet'] |
| 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 | ## Setup |
| 53 | |
| 54 | |
| 55 | ### Prerequisites |
| 56 | |
| 57 | No action required. |
| 58 | |
| 59 | ### Configuration |
| 60 | |
| 61 | #### Options |
| 62 | |
| 63 | |
| 64 | |
| 65 | |
| 66 | |
| 67 | | Option | Description | Default | Required | |
| 68 | |:-----|:------------|:--------|:---------:| |
| 69 | | update every | Data collection frequency. | 1 | no | |
| 70 | |
| 71 | |
| 72 | |
| 73 | |
| 74 | #### via File |
| 75 | |
| 76 | The configuration file name for this integration is `netdata.conf`. |
| 77 | Configuration for this specific integration is located in the `[plugin:windows:PerflibNetFramework]` section within that file. |
| 78 | |
| 79 | The file format is a modified INI syntax. The general structure is: |
| 80 | |
| 81 | ```ini |
| 82 | [section1] |
| 83 | option1 = some value |
| 84 | option2 = some other value |
| 85 | |
| 86 | [section2] |
| 87 | option3 = some third value |
| 88 | ``` |
| 89 | You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 90 | Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 91 | |
| 92 | ```bash |
| 93 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 94 | sudo ./edit-config netdata.conf |
| 95 | ``` |
| 96 | |
| 97 | ##### Examples |
| 98 | There are no configuration examples. |
| 99 | |
| 100 | |
| 101 | |
| 102 | ## Alerts |
| 103 | |
| 104 | There are no alerts configured by default for this integration. |
| 105 | |
| 106 | |
| 107 | ## Metrics |
| 108 | |
| 109 | Metrics grouped by *scope*. |
| 110 | |
| 111 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 112 | |
| 113 | |
| 114 | |
| 115 | ### Per Processes running |
| 116 | |
| 117 | These metrics refer to NET applications. |
| 118 | |
| 119 | Labels: |
| 120 | |
| 121 | | Label | Description | |
| 122 | |:-----------|:----------------| |
| 123 | | process | The process name. | |
| 124 | |
| 125 | Metrics: |
| 126 | |
| 127 | | Metric | Dimensions | Unit | |
| 128 | |:------|:----------|:----| |
| 129 | | netframework.clrexception_thrown | exceptions | exceptions/s | |
| 130 | | netframework.clrexception_filters | filters | filters/s | |
| 131 | | netframework.clrexception_finallys | finallys | finallys/s | |
| 132 | | netframework.clrexception_throw_to_catch_depth | traversed | stack_frames/s | |
| 133 | | netframework.clrinterop_com_callable_wrappers | com_callable_wrappers | ccw/s | |
| 134 | | netframework.clrinterop_interop_marshallings | marshallings | marshallings/s | |
| 135 | | netframework.clrinterop_interop_stubs_created | created | stubs/s | |
| 136 | | netframework.clrjit_methods | jit-compiled | methods/s | |
| 137 | | netframework.clrjit_time | time | percentage | |
| 138 | | netframework.clrjit_standard_failures | failures | failures/s | |
| 139 | | netframework.clrjit_il_bytes | compiled_msil | bytes/s | |
| 140 | | netframework.clrloading_loader_heap_size | committed | bytes | |
| 141 | | netframework.clrloading_appdomains_loaded | loaded | domain/s | |
| 142 | | netframework.clrloading_appdomains_unloaded | unloaded | domain/s | |
| 143 | | netframework.clrloading_assemblies_loaded | loaded | assemblies/s | |
| 144 | | netframework.clrloading_classes_loaded | loaded | classes/s | |
| 145 | | netframework.clrloading_class_load_failures | class_load | failures/s | |
| 146 | | netframework.clrremoting_channels | registered | channels/s | |
| 147 | | netframework.clrremoting_context_bound_classes_loaded | loaded | classes | |
| 148 | | netframework.clrremoting_context_bound_objects | allocated | objects/s | |
| 149 | | netframework.clrremoting_context_proxies | objects | objects/s | |
| 150 | | netframework.clrremoting_remote_calls | calls | calls/s | |
| 151 | | netframework.clrsecurity_link_time_checks | linktime | checks/s | |
| 152 | | netframework.clrsecurity_checks_time | time | percentage | |
| 153 | | netframework.clrsecurity_stack_walk_depth | stack | depth | |
| 154 | | netframework.clrsecurity_runtime_checks | runtime | checks/s | |
| 155 | | netframework.clrlocksandthreads_queue_length | threads | threads/s | |
| 156 | | netframework.clrlocksandthreads_current_logical_threads | logical | threads | |
| 157 | | netframework.clrlocksandthreads_current_physical_threads | physical | threads | |
| 158 | | netframework.clrlocksandthreads_recognized_threads | threads | threads/s | |
| 159 | | netframework.clrlocksandthreads_contentions | contentions | contentions/s | |
| 160 | |
| 161 |