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

Commit e6304ff

Browse files
Merge pull request #2470 from splunk/urbiz-DG27625-mssql-rx
[DG27625]: MSSQL server rx - Activate resource attributes
2 parents fe1cfb5 + 5f452c3 commit e6304ff

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

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

Lines changed: 31 additions & 1 deletion
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

@@ -99,7 +101,35 @@ Enable built-in content
99101

100102
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`.
101103

102-
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
103133
104134
.. _mssql-server-receiver-settings:
105135

0 commit comments

Comments
 (0)