Regenerate integrations docs (#19152)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 7, 2024 at 10:26 UTC
71197dacafb28184c84784458a6dd1da81fae3bf
2 files changed
+167
src/collectors/COLLECTORS.md
+2
@@ -1161,6 +1161,8 @@ If you don't see the app/service you'd like to monitor in this list:
1161
1162
- [IIS](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/iis.md)
1163
1164
+- [MS SQL Server](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/ms_sql_server.md)
1165
+
1166
- [Memory statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/memory_statistics.md)
1167
1168
- [System statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/system_statistics.md)
src/collectors/windows.plugin/integrations/ms_sql_server.md
new
+165
@@ -0,0 +1,165 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/ms_sql_server.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
+sidebar_label: "MS SQL Server"
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
+# MS SQL Server
12
+
13
+
14
+<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
+
16
+
17
+Plugin: windows.plugin
18
+Module: PerflibMSSQL
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Microsoft SQL Server statistics.
25
+
26
+
27
+It queries different SQL objects per instance 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 MSSQL instance
62
+
63
+These metrics refer to the Microsoft SQL Servers instances defined on host.
64
+
65
+Labels:
66
+
67
+| Label | Description |
68
+|:-----------|:----------------|
69
+| mssql_instance | The instance name. |
70
+
71
+Metrics:
72
+
73
+| Metric | Dimensions | Unit |
74
+|:------|:----------|:----|
75
+| mssql.instance_user_connections | user | connections |
76
+| mssql.instance_sqlstats_batch_requests | batch | requests/s |
77
+| mssql.instance_sql_errors | errors | errors/s |
78
+| mssql.instance_sqlstats_sql_compilations | compilations | compilations/s |
79
+| mssql.instance_sqlstats_sql_recompilations | recompiles | recompiles/s |
80
+| mssql.instance_sqlstats_auto_parameterization_attempts | failed | attempts/s |
81
+| mssql.instance_sqlstats_safe_auto_parameterization_attempts | safe | attempts/s |
82
+| mssql.instance_accessmethods_page_splits | page | splits/s |
83
+| mssql.instance_cache_hit_ratio | hit_ratio | percentage |
84
+| mssql.instance_bufman_iops | read, written | pages/s |
85
+| mssql.instance_bufman_checkpoint_pages | log | pages/s |
86
+| mssql.instance_bufman_page_life_expectancy | life_expectancy | seconds |
87
+| mssql.instance_memmgr_server_memory | memory | bytes |
88
+| mssql.instance_memmgr_connection_memory_bytes | memory | bytes |
89
+| mssql.instance_memmgr_pending_memory_grants | pending | processes |
90
+| mssql.instance_memmgr_external_benefit_of_memory | benefit | bytes |
91
+| mssql.instance_locks_deadlocks | alloc_unit, application, database, extent, file, hobt, key, metadata, oib, object, page, rid, row_group, xact | deadlocks/s |
92
+| mssql.instance_locks_lock_wait | alloc_unit, application, database, extent, file, hobt, key, metadata, oib, object, page, rid, row_group, xact | locks/s |
93
+| mssql.instance_blocked_processes | blocked | processes |
94
+
95
+### Per Database
96
+
97
+These metrics refer to Microsoft SQL Server databases.
98
+
99
+Labels:
100
+
101
+| Label | Description |
102
+|:-----------|:----------------|
103
+| mssql_instance | The instance name. |
104
+| database | The database name. |
105
+
106
+Metrics:
107
+
108
+| Metric | Dimensions | Unit |
109
+|:------|:----------|:----|
110
+| mssql.database_active_transactions | active | transactions |
111
+| mssql.database_transactions | transactions | transactions/s |
112
+| mssql.database_write_transactions | write | transactions/s |
113
+| mssql.database_backup_restore_operations | backup | operations/s |
114
+| mssql.database_log_flushes | log | flushes/s |
115
+| mssql.database_log_flushed | flushed | bytes/s |
116
+
117
+
118
+
119
+## Alerts
120
+
121
+There are no alerts configured by default for this integration.
122
+
123
+
124
+## Setup
125
+
126
+### Prerequisites
127
+
128
+No action required.
129
+
130
+### Configuration
131
+
132
+#### File
133
+
134
+The configuration file name for this integration is `netdata.conf`.
135
+Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
136
+
137
+The file format is a modified INI syntax. The general structure is:
138
+
139
+```ini
140
+[section1]
141
+ option1 = some value
142
+ option2 = some other value
143
+
144
+[section2]
145
+ option3 = some third value
146
+```
147
+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
148
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
149
+
150
+```bash
151
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
152
+sudo ./edit-config netdata.conf
153
+```
154
+#### Options
155
+
156
+
157
+
158
+| Name | Description | Default | Required |
159
+|:----|:-----------|:-------|:--------:|
160
+| PerflibMSSQL | An option to enable or disable the data collection. | yes | no |
161
+
162
+#### Examples
163
+There are no configuration examples.
164
+
165
+