Skip to content

Commit 479f861

Browse files
mblaschkemblaschke
committed
release 23.6.0
Signed-off-by: Markus Blaschke <[email protected]>
1 parent 1ba2eb0 commit 479f861

File tree

1 file changed

+9
-40
lines changed

1 file changed

+9
-40
lines changed

‎README.md

+9-40
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@
55
[![Quay.io](https://img.shields.io/badge/Quay.io-webdevops%2Fazure--keyvault--exporter-blue)](https://quay.io/repository/webdevops/azure-keyvault-exporter)
66
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/azure-keyvault-exporter)](https://artifacthub.io/packages/search?repo=azure-keyvault-exporter)
77

8-
Prometheus exporter for Azure Keyvaults which exports general information and dates (created, updated, notBefore, expiry) for secrets, keys and certificates.
8+
Prometheus exporter for Azure KeyVaults which exports general information and dates (created, updated, notBefore, expiry) for secrets, keys and certificates.
99

1010
## Configuration
1111

12-
Normally no configuration is needed but can be customized using environment variables.
13-
1412
```
1513
Usage:
1614
azure-keyvault-exporter [OPTIONS]
1715
1816
Application Options:
1917
--log.debug debug mode [$LOG_DEBUG]
20-
--log.trace trace mode [$LOG_TRACE]
18+
--log.devel development mode [$LOG_DEVEL]
2119
--log.json Switch log output to json format [$LOG_JSON]
2220
--azure.environment= Azure environment name (default: AZUREPUBLICCLOUD) [$AZURE_ENVIRONMENT]
2321
--azure.subscription= Azure subscription ID (space delimiter) [$AZURE_SUBSCRIPTION_ID]
24-
--azure.resourcegroup= Azure ResourceGroup [$AZURE_RESOURCEGROUP]
2522
--azure.resource-tag= Azure Resource tags (space delimiter) (default: owner) [$AZURE_RESOURCE_TAG]
23+
--keyvault.filter= Filter KeyVaults via ResourceGraph kusto filter, query: 'resource | ${filter} | project id' [$KEYVAULT_FILTER]
24+
--cache.path= Cache path (to folder, file://path... or azblob://storageaccount.blob.core.windows.net/containername)
25+
[$CACHE_PATH]
2626
--scrape.time= Default scrape time (time.duration) (default: 5m) [$SCRAPE_TIME]
2727
--scrape.concurrency= Defines who many Keyvaults can be scraped at the same time (default: 10) [$SCRAPE_CONCURRENCY]
2828
--server.bind= Server address (default: :8080) [$SERVER_BIND]
@@ -53,44 +53,13 @@ for Azure API authentication (using ENV vars) see following documentations:
5353

5454
### ResourceTags handling
5555

56-
Tag can be dynamically added to metrics and processed though filters
57-
58-
format is: `tagname?filter1` or `tagname?filter1&filter2`
59-
60-
| Tag filter | Description |
61-
|------------|-----------------------------|
62-
| `toLower` | Lowercasing Azure tag value |
63-
| `toUpper` | Uppercasing Azure tag value |
56+
see [armclient tagmanager documentation](https://github.com/webdevops/go-common/blob/main/azuresdk/README.md#tag-manager)
6457

6558
### AzureTracing metrics
6659

67-
(with 22.2.0 and later)
68-
69-
Azuretracing metrics collects latency and latency from azure-sdk-for-go and creates metrics and is controllable using
70-
environment variables (eg. setting buckets, disabling metrics or disable autoreset).
71-
72-
| Metric | Description |
73-
|------------------------------------------|----------------------------------------------------------------------------------------|
74-
| `azurerm_api_ratelimit` | Azure ratelimit metrics (only on /metrics, resets after query due to limited validity) |
75-
| `azurerm_api_request_*` | Azure request count and latency as histogram |
76-
77-
#### Settings
60+
see [armclient tracing documentation](https://github.com/webdevops/go-common/blob/main/azuresdk/README.md#azuretracing-metrics)
7861

79-
| Environment variable | Example | Description |
80-
|------------------------------------------|------------------------------------|----------------------------------------------------------------|
81-
| `METRIC_AZURERM_API_REQUEST_BUCKETS` | `1, 2.5, 5, 10, 30, 60, 90, 120` | Sets buckets for `azurerm_api_request` histogram metric |
82-
| `METRIC_AZURERM_API_REQUEST_ENABLE` | `false` | Enables/disables `azurerm_api_request_*` metric |
83-
| `METRIC_AZURERM_API_REQUEST_LABELS` | `apiEndpoint, method, statusCode` | Controls labels of `azurerm_api_request_*` metric |
84-
| `METRIC_AZURERM_API_RATELIMIT_ENABLE` | `false` | Enables/disables `azurerm_api_ratelimit` metric |
85-
| `METRIC_AZURERM_API_RATELIMIT_AUTORESET` | `false` | Enables/disables `azurerm_api_ratelimit` autoreset after fetch |
62+
### Caching
8663

64+
see [prometheus collector cache documentation](https://github.com/webdevops/go-common/blob/main/prometheus/README.md#caching)
8765

88-
| `azurerm_api_request` label | Status | Description |
89-
|-----------------------------|--------------------|----------------------------------------------------------------------------------------------------------|
90-
| `apiEndpoint` | enabled by default | hostname of endpoint (max 3 parts) |
91-
| `routingRegion` | enabled by default | detected region for API call, either routing region from Azure Management API or Azure resource location |
92-
| `subscriptionID` | enabled by default | detected subscriptionID |
93-
| `tenantID` | enabled by default | detected tenantID (extracted from jwt auth token) |
94-
| `resourceProvider` | enabled by default | detected Azure Management API provider |
95-
| `method` | enabled by default | HTTP method |
96-
| `statusCode` | enabled by default | HTTP status code |

0 commit comments

Comments
 (0)