Skip to main content

MSSQL

This check will try to connect to a specified SQL Server database, run a query against it and verify the results.

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: mssql-check
spec:
interval: 30
mssql:
- name: mssql pass
url: "server=mssql.default.svc;user id=$(username);password=$(password);port=1433;database=master"
username:
valueFrom:
secretKeyRef:
name: mssql-credentials
key: USERNAME
password:
valueFrom:
secretKeyRef:
name: mssql-credentials
key: PASSWORD
query: SELECT 1
results: 1
FieldDescriptionSchemeRequired
urlConnection string to connect to the SQL Server serverstringYes
queryquery that needs to be executed on the serverstringYes
resultsNumber rows to check forintYes
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics
Connection
connectionPath of existing connection e.g. connection://mssql/instance/ Mutually exclusive with username, password
Connection
usernameEnvVar
passwordEnvVar
urlIf the url is specifed in both the connection and in the url field, the url field takes precedence

Result Variables

NameDescriptionScheme
rows[]map[string]interface{ }
countNumber of rows returnedint