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 Event Hub

Please refer to the Microsoft Azure Sources topic for additional information on how to configure the LPU, and for 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 EventHub",
  "Description": "LPU for EventHub",
  "Actions": [
    "Microsoft.EventHub/*/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.

Authorization Rule

NameDescription
IDResource ID of the rule
NameResource Name of the rule
RightsThe rights associated with the rule
TypeMicrosoft Azure resource type

Event Hub

NameDescription
Capture BacklogCapture Backlog for Microsoft.EventHub.
Capture DestinationName for capture destination
Capture EnabledA value that indicates whether capture description is enabled
Capture EncodingThe encoding format of capture description
Capture Interval (Seconds)The time window allows you to set the frequency with which the capture to Azure Blobs will happen
Capture Size Limit (Bytes)The size window defines the amount of data built up in your Event Hub before an capture operation
Captured Data (Bytes)Captured data for Microsoft.EventHub.
Captured MessagesCaptured Messages for Microsoft.EventHub.
Connections ClosedConnections Closed for Microsoft.EventHub.
Connections OpenedConnections Opened for Microsoft.EventHub.
Created AtThe exact time the Event Hub was created
IDResource ID of the Event Hub.
Incoming Data (Bytes)Incoming data for Microsoft.EventHub.
Incoming MessagesIncoming Messages for Microsoft.EventHub.
Incoming Requests (Requests)Incoming Requests for Microsoft.EventHub.
Message RetentionNumber of days to retain the events for this Event Hub
NameResource name of the Event Hub
Outgoing Data (Bytes)Outgoing data for Microsoft.EventHub.
Outgoing MessagesOutgoing Messages for Microsoft.EventHub.
Partition CountNumber of partitions created for the Event Hub
Partition IDsA current list of shards on the Event Hub
Quota Exceeded ErrorsQuota Exceeded Errors for Microsoft.EventHub.
Server ErrorsServer Errors for Microsoft.EventHub.
Size (Bytes)Size of an EventHub.
StatusThe current status of the Event Hub
Successful Requests (Requests)Successful Requests for Microsoft.EventHub.
Throttled Requests (Requests)Throttled Requests for Microsoft.EventHub.
TypeMicrosoft Azure resource type
Updated AtThe exact time the message was updated
User ErrorsUser Errors for Microsoft.EventHub.

Namespace

NameDescription
Active ConnectionsTotal Active Connections for Microsoft.EventHub.
Archived MessagesEvent Hub archived messages in a namespace
Archived Messages Throughput (Bytes)Event Hub archived message throughput in a namespace
Backlog Archived MessagesEvent Hub archive messages in backlog for a namespace
Capture BacklogCapture Backlog for Microsoft.EventHub.
Captured Data (Bytes)Captured data for Microsoft.EventHub.
Captured MessagesCaptured Messages for Microsoft.EventHub.
Connections ClosedConnections Closed for Microsoft.EventHub.
Connections OpenedConnections Opened for Microsoft.EventHub.
Created AtThe time the Namespace was created
Event Hub Incoming MessagesIncoming Messages for Microsoft.EventHub.
Event Hub Incoming Requests (Requests)Incoming Requests for Microsoft.EventHub.
Event Hub Outgoing MessagesOutgoing Messages for Microsoft.EventHub.
Event Hub Successful Requests (Requests)Successful Requests for Microsoft.EventHub.
Failed Requests (Requests)Total failed requests for a namespace
IDEvent hub namespace ID
Incoming Data (Bytes)Incoming data for Microsoft.EventHub.
Incoming MessagesTotal incoming messages for a namespace
Incoming Requests (Requests)Total incoming send requests for a namespace
Internal Server ErrorsTotal internal server errors for a namespace
Is Auto Inflate EnabledValue that indicates whether AutoInflate is enabled for event hub namespace
LocationLocation of the namespace
Maximum Throughput UnitsUpper limit of throughput units when AutoInflate is enabled
Metric IDIdentifier for Azure Insights metrics
Miscellaneous Server ErrorsMiscellaneous server errors for a namespace
NameName of the event hub namespace
Outgoing Data (Bytes)Outgoing data for Microsoft.EventHub.
Outgoing Message Throughput (Bytes)Event Hub outgoing message throughput for a namespace
Outgoing MessagesTotal outgoing messages for a namespace
Provisioning StateProvisioning state of the namespace
Quota Exceeded ErrorsQuota Exceeded Errors for Microsoft.EventHub.
Resource GroupThe Resource Group of the Azure resource.
Server Busy ErrorsTotal server busy errors for a namespace
Server ErrorsServer Errors for Microsoft.EventHub.
Service Bus EndpointEndpoint you can use to perform Service Bus operations
Size (Bytes)Size of an EventHub.
SKU CapacityThe Event Hubs throughput units
SKU NameName of the SKU
SKU TierThe billing tier of this particular SKU
StatusStatus of the namespace
Successful Requests (Requests)Total successful requests for a namespace
TagsMicrosoft Azure resource tags
Throttled Requests (Requests)Throttled Requests for Microsoft.EventHub.
TypeMicrosoft Azure resource type
Updated AtThe time the Namespace was updated
User ErrorsUser Errors for Microsoft.EventHub.

Updated 8 months ago

Microsoft Azure Event Hub


Suggested Edits are limited on API Reference Pages

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