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 Redis Cache

Monitor Microsoft Azure Cache for Redis

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 Redis",
  "Description": "LPU for Redis",
  "Actions": [
    "Microsoft.Cache/*/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

Cache

NameDescription
Access KeysThe keys of the Redis cache
Cache Read (Bytes per Second)The amount of data read by the cache
Cache Write (Bytes per Second)The amount of data written by the cache
Connected Clients (Connections)The number of clients connected to the cache
Enable Non-SSL PortSpecifies whether the non-SSL Redis server port (6379) is enabled
Evicted KeysThe number of evicted keys in the cache
Expired KeysThe number of expired keys in the cache
Get CommandsTotal number of get commands
HitsThe number of successful lookups on the cache
Host NameRedis host name
IDThe resource ID of the cache
LocationThe resource location of the cache
MissesThe number of failed lookups on the cache
NameThe resource name of the cache
PortRedis non-SSL port
Processor Time (%)The amount of the CPU used by the cache
Provisioning StateRedis instance provisioning status
Rate of Operations (Operations per Second)The rate of operations performed on the cache
Redis ConfigurationAll Redis Settings
Redis VersionThe version of Redis being used for the cache
Resource GroupThe Resource Group of the Azure resource.
Server Load (%)The amount of load on the server
Set CommandsTotal number of set commands
Shard CountThe number of shards (only present if Redis is a Premium Cluster Cache)
SKU CapacityThe size of the Redis cache to deploy
SKU FamilyThe SKU family to use
SKU NameThe type of Redis cache to deploy
SSL PortRedis SSL port
Static IP AddressStatic IP Address
Subnet IDThe full resource ID of a subnet in a virtual network to deploy the Redis cache in
TagsMicrosoft Azure resource tags
Tenant SettingsTenant Settings
Total Commands ProcessedThe total number of commands processed by the cache
Total KeysThe total number of keys in the cache
TypeMicrosoft Azure resource type
Used Memory (Bytes)The amount of memory used by the cache
Used Memory RSS (Bytes)The amount of memory that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by tools such as top and ps

Firewall Rule

NameDescription
End IPLowest IP address included in the range
IDResource ID of the firewall rule
NameResource name of the firewall rule
Start IPHighest IP address included in the range
TypeMicrosoft Azure resource type

Shard

NameDescription
Cache Read (Bytes per Second)The amount of data read by the cache
Cache Write (Bytes per Second)The amount of data written by the cache
Connected Clients (Connections)The number of clients connected to the cache
Evicted KeysThe number of evicted keys in the cache
Expired KeysThe number of expired keys in the cache
Get CommandsTotal number of get commands
HitsThe number of successful lookups on the cache
MissesThe number of failed lookups on the cache
NumberThe identifying number for the shard.
Parent IDThe resource ID of the shard's parent cache.
Processor Time (%)The amount of the CPU used by the cache
Rate of Operations (Operations per Second)The rate of operations performed on the cache
Server Load (%)The amount of load on the server
Set CommandsTotal number of set commands
Total Commands ProcessedThe total number of commands processed by the cache
Total KeysThe total number of keys in the cache
Used Memory (Bytes)The amount of memory used by the cache
Used Memory RSS (Bytes)The amount of memory that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by tools such as top and ps

Updated 8 months ago

Microsoft Azure Redis Cache


Monitor Microsoft Azure Cache for Redis

Suggested Edits are limited on API Reference Pages

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