Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source


The prometheus.exporter.mssql component embeds sql_exporter for collecting stats from a Microsoft SQL Server.


prometheus.exporter.mssql "LABEL" {
    connection_string = CONNECTION_STRING


The following arguments can be used to configure the exporter’s behavior. Omitted fields take their default values.

connection_stringsecretThe connection string used to connect to an Microsoft SQL Server.yes
max_idle_connectionsintMaximum number of idle connections to any one target.3no
max_open_connectionsintMaximum number of open connections to any one target.3no
timeoutdurationThe query timeout in seconds."10s"no

The sql_exporter examples show the format of the connection_string argument:



The prometheus.exporter.mssql component does not support any blocks, and is configured fully through arguments.

Exported fields

The following fields are exported and can be referenced by other components.

targetslist(map(string))The targets that can be used to collect exporter metrics.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets or to a prometheus.scrape component that collects the exposed metrics.

The exported targets use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.mssql is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.mssql does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.mssql does not expose any component-specific debug metrics.


This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.mssql:

prometheus.exporter.mssql "example" {
  connection_string = "sqlserver://user:pass@localhost:1433"

// Configure a prometheus.scrape component to collect mssql metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.mssql.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]

prometheus.remote_write "demo" {
  endpoint {

    basic_auth {
      username = USERNAME
      password = PASSWORD

Replace the following:

  • PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
  • USERNAME: The username to use for authentication to the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.