Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion gdi/opentelemetry/components/mssql-server-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Next, include the receiver in the ``metrics`` pipeline of the ``service`` sectio
receivers:
- sqlserver

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

Configure a named instance on Windows
--------------------------------------------

Expand Down Expand Up @@ -99,7 +101,35 @@ Enable built-in content

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

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.
.. 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.

For more information:

* 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.

* 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.

Enable metrics and resource attributes
--------------------------------------------

Some resource attributes, such as ``sqlserver.instance.name``, are disabled by default.

To enable them, specify the option in your config file:

.. code:: yaml

receivers:
sqlserver:
collection_interval: 10s
sqlserver/1:
collection_interval: 5s
username: sa
password: securepassword
server: 0.0.0.0
port: 1433
resource_attributes:
sqlserver.instance.name:
enabled: true

.. _mssql-server-receiver-settings:

Expand Down
Loading