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

For more information on how to use the below LPU and other Azure Data Collection setup. See the Microsoft Azure Sources topic

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

Name
Required?
Description

Subscription ID

Required

GUID Subscription ID

Tenant ID

Required

GUID Tenant ID (also known as Directory ID)

Client ID

Required

GUID Client ID (also known as Application ID)

Client Secret

Required

The 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 Level

Selects which monitor metrics should be collected.

Filter By Resource Group Type

Selects whether to use a whitelist or blacklist when filtering by Resource Groups.

Filter By Resource Group Whitelist

A 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 Blacklist

A 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 Type

Selects whether to use a whitelist or blacklist when filtering by Resource Groups.

Filter By Tags Group Whitelist

A 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 Blacklist

A 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

Name
Description

Average Pages

The average amount of pages needed for a paged resource type.

Average Request Retries

The average number of retry requests per unique requests made.

Average Retry Attempts

The 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 ID

The client ID used to make API calls.

Failed Requests

The total number of requests that returned a failure response.

Maximum Pages

The most amount of pages needed for a paged resource type.

Maximum Retries

The highest number of retries made for a single request.

Maximum Retry Wait (Milliseconds)

The most amount of time a retried request spent waiting.

Minimum Pages

The 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 Responses

The total number of successful requests that responded with some other accepted status.

Request Timeouts

The total number of requests that timed out waiting for a response.

Requests Retried

The number of unique requests that were retried.

Retry Status Responses

The total number of successful requests that responded with the status TOO MANY REQUESTS (429).

Retry Timeouts

The total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.

Status OK Responses

The total number of successful requests that responded with the status OK (200).

Subscription ID

The subscription ID used to make API calls.

Successful Requests

The total number of requests that returned a successful response.

Tenant ID

The tenant ID used to make API calls.

Total Monitor Requests

The total number of requests made to get monitor metrics.

Total Paged Requests

The total amount of resource types that required paging.

Total Requests

The total number of requests made during collection.

Total Retries

The total number of retry requests that were made.

Unique Monitor Requests

The number of unique requests made to get monitor metrics.

Unique Requests

The number of requests made with unique endpoints.

Elastic Pool

Name
Description

CPU Usage (%)

CPU Usage

Creation Date

The creation date of the elastic pool

Database DTU Maximum

The maximum DTU any one database can consume

Database DTU Minimum

The minimum DTU all databases are guaranteed

DTU

The total shared DTU for the database elastic pool

DTU Usage (%)

DTU Usage

Edition

The edition of the elastic pool

EDTU Limit

eDTU limit

EDTU Used

eDTU used

ID

Resource ID of the elastic pool

In-Memory OLTP Storage Usage (%)

In-Memory OLTP storage percent

Location

Resource location of the elastic pool

Log Write Usage (%)

Log I/O Usage

Name

Resource name of the elastic pool

Physical Data Read Usage (%)

Data I/O Usage

Resource Group

The Resource Group of the Azure resource.

Sessions Usage (%)

Sessions Usage

State

The 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

Tags

Microsoft Azure resource tags

Type

Microsoft Azure resource type

Workers Usage (%)

Workers Usage

Zone Redundant

Whether 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

Name
Description

Charset

The charset of the database

Collation

The collation of the database

ID

Resource ID of the database

Name

Resource name of the database

Type

Microsoft Azure resource type

MySQL Server

Name
Description

Active Connections (Connections)

Total active connections

Administrator Login

The 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 Date

Earliest restore point creation time

Failed Connections (Connections)

Total failed connections

Fully Qualified Domain Name

The fully qualified domain name of the server

Geo-redundant Backup

Whether to enable Geo-redundant or not for server backup

ID

The resource ID of the server

I/O Consumption (%)

I/O consumption

Location

The resource location the server resides in

Memory Usage (%)

Memory usage

Name

The resource name of the server

Resource Group

The Resource Group of the Azure resource.

SKU Capacity

The scale up/out capacity, representing server's compute units

SKU Family

The family of hardware

SKU Name

The name of the SKU, typically, tier + family + cores

SKU Tier

The tier of the particular SKU

SSL Enforcement

Whether 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

Type

Microsoft Azure resource type

User Visible State

A state of the server that is visible to user

Version

The version of the server

PostgreSQL Database

Name
Description

Charset

The charset of the database

Collation

The collation of the database

ID

Resource ID of the database

Name

Resource name of the database

Type

Microsoft Azure resource type

PostgreSQL Server

Name
Description

Active Connections (Connections)

Total active connections

Administrator Login

The 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 Date

Earliest restore point creation time

Failed Connections (Connections)

Total failed connections

Fully Qualified Domain Name

The fully qualified domain name of the server

Geo-redundant Backup

Whether to enable Geo-redundant or not for server backup

ID

The resource ID of the server

I/O Consumption (%)

I/O consumption

Location

The resource location the server resides in

Memory Usage (%)

Memory usage

Name

The resource name of the server

Resource Group

The Resource Group of the Azure resource.

SKU Capacity

The scale up/out capacity, representing server's compute units

SKU Family

The family of hardware

SKU Name

The name of the SKU, typically, tier + family + cores

SKU Tier

The tier of the particular SKU

SSL Enforcement

Whether 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

Type

Microsoft Azure resource type

User Visible State

A state of the server that is visible to user

Version

The version of the server

SQL Database

Name
Description

Blocked By Firewall

Blocked by Firewall

Collation

The collation of the database

Containment State

The containment state of the database

CPU Usage (%)

CPU usage

Creation Date

The creation date of the database

Current Service Objective ID

The 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 ID

The ID of the database

Database Storage Usage (%)

Database size usage

Deadlocks

Deadlocks

Default Secondary Location

The default secondary region for this database

DTU Limit

DTU Limit

DTU Usage (%)

DTU usage

DTU Used

DTU used

DWU Consumption Usage (%)

DWU usage

DWU Limit

DWU limit

DWU Used

DWU used

Earliest Restore Date

This records the earliest start date and time that restore is available for this database

Edition

The edition of the database

Elastic Pool Name

The name of the elastic pool the database is in

Failed Connections (Connections)

Failed Connections

Failover Group ID

The resource identifier of the failover group containing this database

ID

Resource ID of the database

In-Memory OLTP Storage (%)

In-Memory OLTP storage percent

Kind

Kind of database

Location

Resource location of the database

Log Write Usage (%)

Log I/O usage

Maximum Database Size (Bytes)

The max size of the database

Name

Resource name of the database

Physical Data Read Usage (%)

Data I/O usage

Read Scale

If 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 ID

The 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 Name

The 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 Name

Indicates the name of the sample schema to apply when creating this database

Service Level Objective

The current service level objective of the database

Sessions Usage (%)

Sessions usage

Status

The status of the database

Successful Connections (Connections)

Successful Connections

Total Database Size (Bytes)

Total database size

Type

Microsoft Azure resource type

Workers Usage (%)

Workers usage

SQL Server

Name
Description

Administrator Login

Administrator username for the server

Fully Qualified Domain Name

The fully qualified domain name of the server

ID

The resource ID of the server

Kind

Kind of SQL server

Location

The resource location of the server

Name

The resource name of the server

Resource Group

The Resource Group of the Azure resource.

State

The state of the server

Type

Microsoft Azure resource type

Version

The version of the server