Docs » Available host and application monitors » Configure application receivers for databases » SQL

SQL ๐Ÿ”—

Description ๐Ÿ”—

The Splunk Distribution of OpenTelemetry Collector provides this integration as the SQL monitor type using the Smart Agent receiver.

Use this monitor to gather database usage metrics from SQL queries on your databases.

This integration is available for Kubernetes, Windows, and Linux.

Benefits ๐Ÿ”—

After you configure the integration, you can access these features:

Installation ๐Ÿ”—

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration ๐Ÿ”—

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which youโ€™ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide an SQL monitor entry in your Smart Agent or Collector configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector ๐Ÿ”—

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/sql:
    type: sql
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/sql receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/sql]

Smart Agent ๐Ÿ”—

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
  - type: sql
    ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings ๐Ÿ”—

The following tables show the configuration options for this monitor:

Option

Required

Type

Description

queries

Yes

list of objects (see below)

A list of queries that generate data points.

host

No

string

Host or address of the SQL instance.

port

No

integer

Port of the SQL instance. The default value is 0.

params

No

map of strings

Replaceable parameters, in the form of key-value pairs. The system inserts the values into connectionString for a specified key, using Go template syntax. For example, {{.key}}.

dbDriver

No

string

The database driver to use. Valid values are postgres, mysql, sqlserver, and snowflake.

connectionString

No

string

Connection string and replaceable parameters used to connect to the database. To learn more, see the list of connection string parameters for the Go pq package.

logQueries

No

bool

(default: false) If true, log query results infolevel.

The nested queries configuration object has the following fields:

Option

Required

Type

Description

query

Yes

string

An SQL query text that selects one or more rows from a database.

params

No

list of values

Optional parameters that replace placeholders in the query string.

metrics

No

list of objects (see below)

Metrics generated from the query.

datapointExpressions

No

list of strings

A set of expressions that convert each row to a set of metrics. Each of these run for each row in the query result set, allowing you to generate multiple data points per row. Each expression must evaluate to a single data point or nil.

The nested metrics configuration object has the following fields:

Option

Required

Type

Description

metricName

Yes

string

The name of the metric as it appears in Splunk Observability Cloud.

valueColumn

Yes

string

The column name that holds the data point value.

dimensionColumns

No

list of strings

The names of the columns that make up the dimensions of the data point.

isCumulative

No

bool

Whether the value is a cumulative counters (true) or gauge (false). If you set this to the wrong value and send in your first data point for the metric name with the wrong type, you have to manually change the type, as it is set in the system based on the first type seen. The default value is false.

dimensionPropertyColumns

No

map of lists

Mapping between dimensions and the columns to be used to attach corresponding properties.

Supported drivers ๐Ÿ”—

You must specify the dbDriver option that contains the name of the database driver to use. These names are the same as the name of the Golang SQL driver used in the agent. The monitor formats the connectionString according to the driver you specify.

Note

Please be sure to use the correct connection string syntax based on the driver youโ€™re using. For example, if you use the mysql driver, you must use the connection string syntax for the mysql driver.

This is the list of the drivers currently supported:

See the following example:

smartagent/sql:
  - type: sql
      host: localhost
      port: 1433
      dbDriver: sqlserver
      connectionString: 'Server=127.0.0.1;Database=WideWorldImporters;User Id=sa;Password=123456;'
    queries: 
      query: 'SELECT COUNT(*) as count FROM Sales.Orders'
    metrics:
      metricName: "orders"
      valueColumn: "count"

Parameterized connection string ๐Ÿ”—

The monitor treats the value of connectionString as a Golang template with a context consisting of the variables host and port and all the parameters from the params option. To add a variable to the template, use the Golang {{.varname}} template syntax.

Collect Snowflake performance and usage metrics ๐Ÿ”—

To configure the agents to collect Snowflake performance and usage metrics, do the following:

  1. Copy the pkg/sql/snowflake-metrics.yaml file from the sql monitor repo into the same location as your agent.yaml file. For example, /etc/splunk. Find the latest version of snowflake-metrics.yaml in our GitHub repo.

  2. Configure the SQL monitor as follows:

receivers:
  smartagent/sql:
    type: sql
    intervalSeconds: 3600
    dbDriver: snowflake
    params:
      account: "account.region"
      database: "SNOWFLAKE"
      schema: "ACCOUNT_USAGE"
      role: "ACCOUNTADMIN"
      user: "user"
      password: "password"
    connectionString: "{{.user}}:{{.password}}@{{.account}}/{{.database}}/{{.schema}}?role={{.role}}"
    queries:
      {"#from": "/etc/signalfx/snowflake-metrics.yaml"}

You can also copy the contents of snowflake-metrics.yaml into agent.yaml under queries. Edit snowflake-metrics.yaml to only include the metrics you want to monitor.

Using the monitor ๐Ÿ”—

Consider the following customers database table:

id

name

country

status

1

Bill

USA

active

2

Mary

USA

inactive

3

Joe

USA

active

4

Elizabeth

Germany

active

Use the following monitor configuration to generate metrics about active users and customer counts by country:

monitors:
  - type: sql
    host: localhost
    port: 5432
    dbDriver: postgres
    params:
      user: admin
      password: s3cr3t
    # The `host` and `port` values shown in this example (also provided through autodiscovery) are interpolated
    # to the connection string as appropriate for the database driver.
    # Also, the values from the `params` configuration option above can be
    # interpolated.
    connectionString: 'host={{.host}} port={{.port}} dbname=main user={{.user}} password={{.password}} sslmode=disable'
    queries:
      - query: 'SELECT COUNT(*) as count, country, status FROM customers GROUP BY country, status;'
        metrics:
          - metricName: "customers"
            valueColumn: "count"
            dimensionColumns: ["country", "status"]

When you use this configuration, you get series of MTS, all with the metric name customers. Each MTS has a county and status dimension. The dimension value is the number of customers that belong to that combination of country and status. You can also specify multiple metrics items to generate more than one metric from a single query.

Using metric expressions ๐Ÿ”—

If you need to do more complex logic than mapping columns to metric values and dimensions, use the datapointExpressions option thatโ€™s available for individual metric configurations. Create more sophisticated logic to derive data points from individual rows by using the expr expression language. These expressions must evaluate to data points created by the GAUGE or CUMULATIVE helper functions available in the expressionโ€™s context. You can also have the expression evaluate to nil if you donโ€™t need to generate a data point for a particular row.

Both the GAUGE and CUMULATIVE functions have the following signature:

(metricName, dimensions, value)

  • metricName: Must be a string

  • dimensions: Must be a map of string keys and values, and

  • value: Must be a numeric value.

Each of the columns in the row maps to a variable in the context of the expression with the same name. For example, if you have a column called name in your SQL query result, you can use a variable called name in the expression. In your expression, surround string values with single quotes ('').

For example, the MySQL SHOW REPLICA STATUS query doesnโ€™t let you pre-process columns using SQL, but you can convert the Replica_IO_Running column (a string Yes/No value) to a gauge data point with values of value of 0 or 1 by using the following configuration:

   - type: sql
     # This is an example discovery rule. Your environment might be different.
     discoveryRule: container_labels["mysql.replica"] == "true" && port == 3306
     dbDriver: mysql
     params:
       user: root
       password: password
     connectionString: '{{.user}}:{{.password}}@tcp({{.host}})/<database>'
     # You can also use '.user:.password@tcp(.host)/' if you don't want to specify a database.
     queries:
      - query: 'SHOW REPLICA STATUS'
        datapointExpressions:
          - 'GAUGE("mysql.replica_sql_running", {main_uuid: Main_UUID, channel: Channel_name}, Replica_SQL_Running == "Yes" ? 1 : 0)'

Use this configuration to generate a single gauge data point for each row in the replica status output, with two dimension, main_uuid and channel, and with a value of 0 or 1, depending on if the SQL thread for the replica is running.

Metrics filtering ๐Ÿ”—

The Splunk Distribution of OpenTelemetry Collector and the Smart Agent donโ€™t do any built-in filtering of metrics coming out of this monitor.

Get help ๐Ÿ”—

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.