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 Databases

Monitor Azure DBaaS platform metrics

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

Steps:

  1. Using the Azure CLI Client, find the Subscription ID and Tenant ID from your account list
  2. Create a custom RBAC role using the JSON provided. Include your Subscription ID and rename the file to azure.json
  3. Create an Active Directory Service Principal and assign the custom RBAC role t it.

Creating custom roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/custom-roles

Assigning roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal

{
  "Name": "LPU SQL Servers",
  "Description": "LPU for SQL Servers",
  "Actions": [
    "Microsoft.Sql/servers/*/read",
    "Microsoft.Sql/servers/databases/providers/Microsoft.Insights/*/read",
    "Microsoft.DBforMySQL/*/read",
    "Microsoft.DBforPostgreSQL/*/read",
    "Microsoft.Storage/*/read",
    "Microsoft.Insights/metrics/*/read",
    "Microsoft.Authorization/*/read"
  ],
  "AssignableScopes": [
    "/subscriptions/[Subscription ID]"
  ]
}

Connection Parameters

NameRequired?Description
Subscription IDRequiredGUID Subscription ID
Tenant IDRequiredGUID Tenant ID (also known as Directory ID)
Client IDRequiredGUID Client ID (also known as Application ID)
Client SecretRequiredThe Secret (also known as Key) corresponding to the Client ID.
Maximum HTTP Retry Time (seconds)The maximum amount of time in seconds to retry each API request when the API is throttling.
HTTP Request Timeout (seconds)The maximum amount of time in seconds before a single HTTP request will fail.
Monitor Metric Collection LevelSelects which monitor metrics should be collected.
Filter By Resource Group TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Resource Group WhitelistA comma separated list of resource groups to explicitly allow. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Resource Group BlacklistA comma separated list of resource groups to filter out. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Tags Group TypeSelects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Tags Group WhitelistA comma separated list of tags to explicitly allow. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.
Filter By Tags Group BlacklistA comma separated list of tags to filter out. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.

Metrics

API Usage

NameDescription
Average PagesThe average amount of pages needed for a paged resource type.
Average Request RetriesThe average number of retry requests per unique requests made.
Average Retry AttemptsThe average number of retry requests made per unique request that was retried.
Average Retry Wait (Milliseconds)The average amount of time retried requests spent waiting.
Client IDThe client ID used to make API calls.
Failed RequestsThe total number of requests that returned a failure response.
Maximum PagesThe most amount of pages needed for a paged resource type.
Maximum RetriesThe highest number of retries made for a single request.
Maximum Retry Wait (Milliseconds)The most amount of time a retried request spent waiting.
Minimum PagesThe least amount of pages needed for a paged resource type.
Minimum Retry Wait (Milliseconds)The least amount of time a retried request spent waiting.
Other Status ResponsesThe total number of successful requests that responded with some other accepted status.
Request TimeoutsThe total number of requests that timed out waiting for a response.
Requests RetriedThe number of unique requests that were retried.
Retry Status ResponsesThe total number of successful requests that responded with the status TOO MANY REQUESTS (429).
Retry TimeoutsThe total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.
Status OK ResponsesThe total number of successful requests that responded with the status OK (200).
Subscription IDThe subscription ID used to make API calls.
Successful RequestsThe total number of requests that returned a successful response.
Tenant IDThe tenant ID used to make API calls.
Total Monitor RequestsThe total number of requests made to get monitor metrics.
Total Paged RequestsThe total amount of resource types that required paging.
Total RequestsThe total number of requests made during collection.
Total RetriesThe total number of retry requests that were made.
Unique Monitor RequestsThe number of unique requests made to get monitor metrics.
Unique RequestsThe number of requests made with unique endpoints.

Elastic Pool

NameDescription
CPU Usage (%)CPU Usage
Creation DateThe creation date of the elastic pool
Database DTU MaximumThe maximum DTU any one database can consume
Database DTU MinimumThe minimum DTU all databases are guaranteed
DTUThe total shared DTU for the database elastic pool
DTU Usage (%)DTU Usage
EditionThe edition of the elastic pool
EDTU LimiteDTU limit
EDTU UsedeDTU used
IDResource ID of the elastic pool
In-Memory OLTP Storage Usage (%)In-Memory OLTP storage percent
LocationResource location of the elastic pool
Log Write Usage (%)Log I/O Usage
NameResource name of the elastic pool
Physical Data Read Usage (%)Data I/O Usage
Resource GroupThe Resource Group of the Azure resource.
Sessions Usage (%)Sessions Usage
StateThe state of the elastic pool
Storage Limit (Bytes)Gets storage limit for the database elastic pool
Storage Usage (%)Storage Usage
Storage Used (Bytes)Storage used
TagsMicrosoft Azure resource tags
TypeMicrosoft Azure resource type
Workers Usage (%)Workers Usage
Zone RedundantWhether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones

MySQL Database

NameDescription
CharsetThe charset of the database
CollationThe collation of the database
IDResource ID of the database
NameResource name of the database
TypeMicrosoft Azure resource type

MySQL Server

NameDescription
Active Connections (Connections)Total active connections
Administrator LoginThe administrator's login name of a server
Backup Retention (Days)The amount of time backups are retained for the server
CPU Usage (%)CPU usage
Earliest Restore DateEarliest restore point creation time
Failed Connections (Connections)Total failed connections
Fully Qualified Domain NameThe fully qualified domain name of the server
Geo-redundant BackupWhether to enable Geo-redundant or not for server backup
IDThe resource ID of the server
I/O Consumption (%)I/O consumption
LocationThe resource location the server resides in
Memory Usage (%)Memory usage
NameThe resource name of the server
Resource GroupThe Resource Group of the Azure resource.
SKU CapacityThe scale up/out capacity, representing server's compute units
SKU FamilyThe family of hardware
SKU NameThe name of the SKU, typically, tier + family + cores
SKU TierThe tier of the particular SKU
SSL EnforcementWhether to enable ssl enforcement or not when connecting to the server
Storage Limit (Megabytes)Max storage allowed for a server
Storage Usage (%)Storage usage
Storage Used (Bytes)Storage used
TypeMicrosoft Azure resource type
User Visible StateA state of the server that is visible to user
VersionThe version of the server

PostgreSQL Database

NameDescription
CharsetThe charset of the database
CollationThe collation of the database
IDResource ID of the database
NameResource name of the database
TypeMicrosoft Azure resource type

PostgreSQL Server

NameDescription
Active Connections (Connections)Total active connections
Administrator LoginThe administrator's login name of a server
Backup Retention (Days)The amount of time backups are retained for the server
CPU Usage (%)CPU usage
Earliest Restore DateEarliest restore point creation time
Failed Connections (Connections)Total failed connections
Fully Qualified Domain NameThe fully qualified domain name of the server
Geo-redundant BackupWhether to enable Geo-redundant or not for server backup
IDThe resource ID of the server
I/O Consumption (%)I/O consumption
LocationThe resource location the server resides in
Memory Usage (%)Memory usage
NameThe resource name of the server
Resource GroupThe Resource Group of the Azure resource.
SKU CapacityThe scale up/out capacity, representing server's compute units
SKU FamilyThe family of hardware
SKU NameThe name of the SKU, typically, tier + family + cores
SKU TierThe tier of the particular SKU
SSL EnforcementWhether to enable ssl enforcement or not when connecting to the server
Storage Limit (Megabytes)Max storage allowed for a server
Storage Usage (%)Storage percentage
Storage Used (Bytes)Storage used
TypeMicrosoft Azure resource type
User Visible StateA state of the server that is visible to user
VersionThe version of the server

SQL Database

NameDescription
Blocked By FirewallBlocked by Firewall
CollationThe collation of the database
Containment StateThe containment state of the database
CPU Usage (%)CPU usage
Creation DateThe creation date of the database
Current Service Objective IDThe current service level objective ID of the database. This is the ID of the service level objective that is currently active.
Data Warehouse Node Data Read Usage (%)DW node level Data I/O usage
Data Warehouse Node Level CPU Usage (%)DW node level CPU usage
Database IDThe ID of the database
Database Storage Usage (%)Database size usage
DeadlocksDeadlocks
Default Secondary LocationThe default secondary region for this database
DTU LimitDTU Limit
DTU Usage (%)DTU usage
DTU UsedDTU used
DWU Consumption Usage (%)DWU usage
DWU LimitDWU limit
DWU UsedDWU used
Earliest Restore DateThis records the earliest start date and time that restore is available for this database
EditionThe edition of the database
Elastic Pool NameThe name of the elastic pool the database is in
Failed Connections (Connections)Failed Connections
Failover Group IDThe resource identifier of the failover group containing this database
IDResource ID of the database
In-Memory OLTP Storage (%)In-Memory OLTP storage percent
KindKind of database
LocationResource location of the database
Log Write Usage (%)Log I/O usage
Maximum Database Size (Bytes)The max size of the database
NameResource name of the database
Physical Data Read Usage (%)Data I/O usage
Read ScaleIf the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition
Requested Service Objective IDThe configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database
Requested Service Objective NameThe name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database
Sample NameIndicates the name of the sample schema to apply when creating this database
Service Level ObjectiveThe current service level objective of the database
Sessions Usage (%)Sessions usage
StatusThe status of the database
Successful Connections (Connections)Successful Connections
Total Database Size (Bytes)Total database size
TypeMicrosoft Azure resource type
Workers Usage (%)Workers usage

SQL Server

NameDescription
Administrator LoginAdministrator username for the server
Fully Qualified Domain NameThe fully qualified domain name of the server
IDThe resource ID of the server
KindKind of SQL server
LocationThe resource location of the server
NameThe resource name of the server
Resource GroupThe Resource Group of the Azure resource.
StateThe state of the server
TypeMicrosoft Azure resource type
VersionThe version of the server

Updated 8 months ago

Microsoft Azure Databases


Monitor Azure DBaaS platform metrics

Suggested Edits are limited on API Reference Pages

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