Add extended_documentation for direct connection-only metrics

open-telemetry · Mar 27, 2024 · 06d65b1 · 06d65b1
1 parent 5d41386
commit 06d65b1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/receiver/sqlserverreceiver/documentation.md b/receiver/sqlserverreceiver/documentation.md
@@ -192,6 +192,8 @@ metrics:
 
 Total time that the users waited for reads.
 
+This metric is only available when the receiver is configured to directly connect to SQL Server.
+
 | Unit | Metric Type | Value Type |
 | ---- | ----------- | ---------- |
 | s | Gauge | Double |

diff --git a/receiver/sqlserverreceiver/metadata.yaml b/receiver/sqlserverreceiver/metadata.yaml
@@ -174,6 +174,7 @@ metrics:
     gauge:
       value_type: double
     attributes: [physical_filename, logical_filename, file_type]
+    extended_documentation: This metric is only available when the receiver is configured to directly connect to SQL Server.
 
 tests:
   config: