Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 18fa326

Browse files
Feedback
1 parent 3716c1f commit 18fa326

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed

gdi/opentelemetry/components/mssql-server-receiver.rst

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Next, include the receiver in the ``metrics`` pipeline of the ``service`` sectio
5555
receivers:
5656
- sqlserver
5757
58+
.. caution:: To retrieve out-of-the-box content properly, you need to explicitly enable and disable specific metrics and resource attributes in your configuration file. Read more at :ref:`mssql-server-receiver-ootb`.
59+
5860
Configure a named instance on Windows
5961
--------------------------------------------
6062

@@ -73,28 +75,6 @@ If you're using a named instance on Windows, you need to specify a computer and
7375
sqlserver.instance.name:
7476
enabled: true
7577
76-
Enable resource attributes
77-
--------------------------------------------
78-
79-
Some resource attributes, such as ``sqlserver.instance.name``, are disabled by default.
80-
81-
To enable them, specify the option in your config file:
82-
83-
.. code:: yaml
84-
85-
receivers:
86-
sqlserver:
87-
collection_interval: 10s
88-
sqlserver/1:
89-
collection_interval: 5s
90-
username: sa
91-
password: securepassword
92-
server: 0.0.0.0
93-
port: 1433
94-
resource_attributes:
95-
sqlserver.instance.name:
96-
enabled: true
97-
9878
Advanced configuration
9979
--------------------------------------------
10080

@@ -121,7 +101,35 @@ Enable built-in content
121101

122102
Splunk Observability Cloud provides built-in dashboards with charts that give you immediate visibility into the technologies and services being used in your environment. Learn more at :ref:`collector-builtin-dashboard`.
123103

124-
For the MS SQL Server receiver out-of-the-box content to work properly, you need to explicitly enable and disable specific metrics and resource attributes in your configuration file. See the configuration that enables built-in content at :new-page:`SQL Server discovery yaml <https://github.com/signalfx/splunk-otel-collector/blob/main/internal/confmapprovider/discovery/bundle/bundle.d/receivers/sqlserver.discovery.yaml>` in GitHub.
104+
.. caution:: For the MS SQL Server receiver out-of-the-box content to work properly, you need to explicitly enable and disable specific metrics and resource attributes in your configuration file.
105+
106+
For more information:
107+
108+
* See the configuration that enables built-in content at :new-page:`SQL Server discovery yaml <https://github.com/signalfx/splunk-otel-collector/blob/main/internal/confmapprovider/discovery/bundle/bundle.d/receivers/sqlserver.discovery.yaml>` in GitHub.
109+
110+
* See the list of default and optional metrics at :new-page:`SQL server default and optional metrics <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/sqlserverreceiver/documentation.md#optional-metrics>` in GitHub.
111+
112+
Enable metrics and resource attributes
113+
--------------------------------------------
114+
115+
Some resource attributes, such as ``sqlserver.instance.name``, are disabled by default.
116+
117+
To enable them, specify the option in your config file:
118+
119+
.. code:: yaml
120+
121+
receivers:
122+
sqlserver:
123+
collection_interval: 10s
124+
sqlserver/1:
125+
collection_interval: 5s
126+
username: sa
127+
password: securepassword
128+
server: 0.0.0.0
129+
port: 1433
130+
resource_attributes:
131+
sqlserver.instance.name:
132+
enabled: true
125133
126134
.. _mssql-server-receiver-settings:
127135

0 commit comments

Comments
 (0)