Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 4.7 KB

monitor-key-vault-reference.md

File metadata and controls

99 lines (71 loc) · 4.7 KB
Raw
title description author ms.topic ms.author ms.service ms.subservice ms.custom ms.date
Monitoring Azure Key Vault data reference
Important reference material needed when you monitor Key Vault
msmbaldwin
reference
mbaldwin
key-vault
general
subject-monitoring
02/20/2024

Monitoring Key Vault data reference

See Monitoring Key Vault for details on collecting and analyzing monitoring data for Key Vault.

Metrics

This section lists all the automatically collected platform metrics collected for Key Vault.

Metric Type Resource Provider / Type Namespace
and link to individual metrics
Key Vault Microsoft.KeyVault/vaults
Managed HSM Microsoft.KeyVault/managedhsms

Key Vault metrics

Resource Provider and Type: Microsoft.KeyVault/vaults

| Name | Metric | Unit | Type | Description | |:-------|:-----|:------------|:------------------| | Overall Vault Availability | Availability | Percent | Average | Vault requests availability | | Overall Vault Saturation | SaturationShoebox | Percent | Average| Vault capacity used | | Total Service Api Hits | ServiceApiHit | Count | Count | Number of total service API hits | | Overall Service Api Latency | ServiceApiLatency | MilliSeconds | Average | Overall latency of service API requests | | Total Service Api Results | ServiceApiResult | Count | Count | Number of total service API results |

For more information, see a list of all platform metrics supported in Azure Monitor.

Metric dimensions

For more information on what metric dimensions are, see Multi-dimensional metrics.

Key Vault has the following dimensions associated with its metrics:

  • ActivityType
  • ActivityName
  • TransactionType
  • StatusCode
  • StatusCodeClass

Resource logs

This section lists the types of resource logs you can collect for Key Vault.

For reference, see a list of Microsoft.KeyVault/vaults. For full details, see Azure Key Vault logging.

Resource Log Type Resource Provider / Type Namespace
and link to individual metrics
Key Vault Microsoft.KeyVault/vaults
Managed HSM Microsoft.KeyVault/managedhsms

Azure Monitor Logs tables

This section refers to all of the Azure Monitor Logs Kusto tables relevant to Key Vault and available for query by Log Analytics.

Resource Type Notes
Key Vault

For a reference of all Azure Monitor Logs / Log Analytics tables, see the Azure Monitor Log Table Reference.

Diagnostics tables

Key Vault uses the Azure Diagnostics, Azure Activity table, and Azure Metrics tables to store resource log information. The following columns are relevant.

Azure Diagnostics

Property Description
_ResourceId A unique identifier for the resource that the record is associated with
CallerIPAddress IP address of the user who has performed the operation UPN claim or SPN claim based on availability.
DurationMs The duration of the operation in milliseconds.
httpStatusCode_d HTTP status code returned by the request (for example, 200)
Level Level of the event. One of the following values: Critical, Error, Warning, Informational and Verbose.
OperationName Name of the operation, for example, Alert
properties_s
Region_s
requestUri_s The URI of the client request.
Resource
ResourceProvider Resource provider of the Azure resource reporting the metric.
ResultSignature
TimeGenerated Date and time the record was created

See also