Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Microsoft Azure SQL Database

MSSQL Azure Hosted Database Instance

Metrics are collected via JDBC from the Azure SQL Database directly.

Please refer to the Microsoft Azure Sources topic for additional information on how to configure the LPU, and general Azure Data Collection setup details.

Least Privileged User

Setting Microsoft Azure SQL Database User Privileges

A least-privileged user (LPU) with VIEW DATABASE STATE and VIEW DEFINITION privileges is required for each user database being monitored.

Create a Basic LPU

On the "master" Microsoft Azure database instance, execute the following commands:
NOTE: Replace with your own password.

CREATE LOGIN lpu

WITH PASSWORD = <PASSWORD>;

#On each Microsoft Azure database, including the master, execute the following commands:

CREATE USER lpu FROM LOGIN lpu;

GRANT VIEW DATABASE STATE TO lpu;

GRANT VIEW DEFINITION TO lpu;

Connection Parameters

NameRequired?Description
HostRequiredThe Microsoft SQL database to connect to.
PortThe port for communication to the Microsoft SQL database.
Use Active Directory
UsernameRequired
PasswordRequired
Query Count Per Database
Exclude Textless Queries
DatabasesComma-separated list of database(s) to monitor. Leave blank to monitor all databases.
Exclude EventsA comma separated list of strings. Events will not be created when their message contains any of these strings.
Max Threads
Collect ObjectsWhether or not to collect Object resources.

Metrics

Database

NameDescription
Active Connections (Connections)The number of active connections to the database
Active TransactionsNumber of active transactions on database
Approximate Last Start DateThe approximate time that the database was started
Auto CloseShows whether auto close is enabled
Auto Create StatisticsShows whether auto create statistics is enabled.
Auto ShrinkShows whether auto shrink is enabled.
Auto Update StatisticsShows whether auto update statistics is enabled.
Average CPU Utilization (%)Average compute utilization in percentage of the limit of the service tier.
Average Data I/O Utilization (%)Average data I/O utilization in percentage of the limit of the service tier.
Average Log Write Resource Utilization (%)Average write resource utilization in percentage of the limit of the service tier.
Average Memory Usage (%)Average memory utilization in percentage of the limit of the service tier.
Background ProcessesThe current number of background processes
Blocked ProcessesThe current number of blocked processes
Buffer Ideal Page Life Expectancy (Seconds)The Buffer Ideal Page Life Expectancy of the Database.
Buffer Pool Size (Mebibytes)Total size of the buffer pool for a database
Connections (Connections)The total number of connections to the database
Creation DateDate the database was created or last renamed
Data Space Usage (Mebibytes)Database data space
Dormant ProcessesThe current number of dormant processes
DTU LimitCurrent max database DTU setting for this database during this interval.
IDDatabase identification number (unique within the Azure SQL Database server)
In-Memory OLTP Storage Utilization (%)Storage utilization for In-Memory OLTP in percentage of the limit of the service tier (at the end of the reporting interval).
Index Space Usage (Mebibytes)Database index space
Instance Wait Time (Milliseconds)Total wait time of the server
IOPS (Operations)Total amount of disk write and read operations.
Maximum Concurrent Sessions (%)Maximum concurrent sessions in percentage of the limit of the database's service tier.
Maximum Concurrent Workers (%)Maximum concurrent workers (requests) in percentage of the limit of the database's service tier.
Maximum Storage Size (Megabytes)Maximum storage size for the time period, including database data, indexes, stored procedures and metadata
NameName of the database (unique within the Azure SQL Database server)
Possible Connections (Connections)The maximum number of possible connections to the database
Preconnect ProcessesThe current number of preconnect processes
Read Data (Bytes)Disk read data for database.
Read Delay (Milliseconds)Total time, in milliseconds, that the users waited for reads issued on files for the database
Read OnlyShows whether read only mode is enabled.
Read Operations (Operations)This metric represents the amount of disk read operations over time.
Recovery ModelDescription of the recovery model selected for the database
Reserved Space (Mebibytes)Database reserved space
Runnable ProcessesThe current number of runnable processes
Runnable Tasks CountNumber of workers, with tasks assigned to them, that are waiting to be scheduled on the runnable queue
Running ProcessesThe current number of running processes
Server NameLogical server name
Service TierService Tier of the database
Single User ModeShows whether single user mode is enabled.
Size Used (Mebibytes)Database size
Sleeping ProcessesThe current number of sleeping processes
StatusDescription of the database state
Suspended ProcessesThe current number of suspended processes
thread_countThe number of workers that are associated with this database. This includes workers that are not assigned any task
Time Since Creation (Days)Days since database was created.
Time Since Last Start (Days)The approximate number of days since the database was started
Total Data (Bytes)Total disk read and write data for database.
Unused Reserved Space (Mebibytes)Database unused reserved space
User LookupsTotal number of bookmark lookups by user queries
User ScansTotal number of scans by user queries. This represents scans that did not use 'seek' predicate.
User SeeksTotal number of seeks by user queries
User UpdatesTotal number of updates by user queries. This includes Insert, Delete and Updates representing number of operations done not the actual rows affected. For example, if you delete 1000 rows in one statement, this count will increment by 1
Write Data (Bytes)Disk write data for database.
Write Delay (Milliseconds)Total time, in milliseconds, that users waited for writes to be completed on files for the database
Write Operations (Operations)This metrice represents the amount of disk write operations over time.

Geo-Replication Database

NameDescription
Database NameName of the database (unique within the Azure SQL Database server)
Last ReplicationThe timestamp of the last transaction's acknowledgement by the secondary based on the primary database clock
Link IDUnique ID of the geo-replication link
Modify DateUTC time at regional SQL Database datacenter when the database geo-replication has completed. The new database is synchronized with the primary database as of this time.
NameName of the database and the logical server
Partner Database IDPartner database identification number (unique within the Azure SQL Database server)
Partner Server NameName of the logical server containing the linked database
Replication Lag (Seconds)Time difference in seconds between the last_replication value and the timestamp of that transaction's commit on the primary based on the primary database clock
Replication StateThe state of geo-replication for this database
Replication State DescriptionDescription of the state of geo-replication for this database
RoleThe Geo-replication role for this database
Role DescriptionDescription of the Geo-replication role for this database
Secondary Allows ConnectionsThe secondary type
Secondary Allows Connections DescriptionDescription of the secondary type
Server NameLogical server name
Start DateUTC time at a regional SQL Database datacenter when the database replication was initiated

Object

NameDescription
Average Page Lock Wait Duration (Milliseconds)Average number of milliseconds the Database Engine waited on a page lock
Average Row Lock Wait Duration (Milliseconds)Average number of milliseconds the Database Engine waited on a row lock
Database IDDatabase identification number (unique within the Azure SQL Database server)
Database NameName of the database (unique within the Azure SQL Database server)
NameObject name
Page Locks AcquiredCumulative number of times the Database Engine waited on a page lock
Page Locks RequestedCumulative number of page locks requested
Row Locks AcquiredCumulative number of times the Database Engine waited on a row lock
Row Locks RequestedCumulative number of row locks requested

Query

NameDescription
Average Execution Time (Microseconds)The average execution time for the query
Database IDDatabase identification number (unique within the Azure SQL Database server)
Database NameName of the database
Execution Context NameThe name of the context in which the query was executed
Execution Context TypeType of context in which the query was executed
Execution CountNumber of times that the plan has been executed since it was last compiled
Execution Time (Microseconds)Total amount of CPU time consumed by executions of this plan since it was compiled
Last Execution (Microseconds)Last time at which the plan started executing
NameThe Name of the Query.
SQL HandleA token that refers to the batch or stored procedure that the query is part of
SQL TextThe text of the query
Statement End OffsetIndicates, in bytes, starting with 0, the ending position of the query that the row describes within the text of its batch or persisted object. For versions before SQL Server 2014, a value of -1 indicates the end of the batch
Statement Start OffsetIndicates, in bytes, beginning with 0, the starting position of the query that the row describes within the text of its batch or persisted object
Unique Query PlansThe number of unique plans for this query

Server

NameDescription
Active Connections (Connections)The total number of active connections across databases on the server.
NameLogical server name
SQL VersionAzure SQL Version
TypeIs the server configured in a failover cluster

Updated 11 months ago

Microsoft Azure SQL Database


MSSQL Azure Hosted Database Instance

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.