From 73bfd00cbe63ac09a9963f63a66589031d9de2cd Mon Sep 17 00:00:00 2001 From: Andrey Burtasov Date: Tue, 28 Nov 2023 11:22:58 +0300 Subject: [PATCH] add docs about smb collector Signed-off-by: Andrey Burtasov --- README.md | 1 + docs/collector.smb.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 docs/collector.smb.md diff --git a/README.md b/README.md index a592bbe7..87dd22b5 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ Name | Description | Enabled by default [remote_fx](docs/collector.remote_fx.md) | RemoteFX protocol (RDP) metrics | [scheduled_task](docs/collector.scheduled_task.md) | Scheduled Tasks metrics | [service](docs/collector.service.md) | Service state metrics | ✓ +[smb](docs/collector.smb.md) | SMB Server | [smtp](docs/collector.smtp.md) | IIS SMTP Server | [system](docs/collector.system.md) | System calls | ✓ [tcp](docs/collector.tcp.md) | TCP connections | diff --git a/docs/collector.smb.md b/docs/collector.smb.md new file mode 100644 index 00000000..dee54711 --- /dev/null +++ b/docs/collector.smb.md @@ -0,0 +1,35 @@ +# smb collector + +The smb collector collects metrics from MS Smb hosts through perflib +======= + + +||| +-|- +Metric name prefix | `smb` +Classes | [Win32_PerfRawData_SMB](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-smb/)
+Enabled by default? | No + +## Flags + +### `--collectors.smb.list` +Lists the Perflib Objects that are queried for data along with the perlfib object id + +### `--collectors.smb.enabled` +Comma-separated list of collectors to use, for example: `--collectors.smb.enabled=ServerShares`. Matching is case-sensitive. Depending on the smb installation not all performance counters are available. Use `--collectors.smb.list` to obtain a list of supported collectors. + +## Metrics +Name | Description +--------------|--------------- +`windows_smb_server_shares_current_open_file_count` | Current total count open files on the SMB Server +`windows_smb_server_shares_tree_connect_count` | Count of user connections to the SMB Server + +### Example metric +_This collector does not yet have explained examples, we would appreciate your help adding them!_ + +## Useful queries +_This collector does not yet have any useful queries added, we would appreciate your help adding them!_ + +## Alerting examples +_This collector does not yet have alerting examples, we would appreciate your help adding them!_ +