Skip to content

Commit b872bff

Browse files
committed
add documentation
Signed-off-by: Markus Blaschke <[email protected]>
1 parent e075db9 commit b872bff

File tree

3 files changed

+23
-6
lines changed

3 files changed

+23
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Go Common library for webdevops projects
22

33
* [azuresdk](/azuresdk/README.md)
4+
* [prometheus](/prometheus/README.md)

azuresdk/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,19 @@ Example configuration:
7676
}
7777
```
7878

79-
### Tag handling
79+
## Tag manager
8080

8181
Tag can be dynamically added to metrics and processed though filters
8282

83-
format is: `tagname?filter1` or `tagname?filter1&filter2`
83+
format is: `tagname?option1` or `tagname?option1&option2`
8484

85-
| Tag filter | Description |
86-
|------------|-----------------------------|
87-
| `toLower` | Lowercasing Azure tag value |
88-
| `toUpper` | Uppercasing Azure tag value |
85+
| Tag option | Description |
86+
|------------|-----------------------------------------------------------------------------------------------------------------|
87+
| `name` | Name of target label |
88+
| `toLower` | Lowercasing Azure tag value |
89+
| `toUpper` | Uppercasing Azure tag value |
90+
| `inherit` | If tag is not set, try to fetch from parent structure (Resource -> ResourceGroup -> Subscription) |
91+
| `source` | Defines where the tag value should be fetched from, allowed values: `resource`, `resourceGroup`, `subscription` |
8992

9093
## AzureTracing metrics
9194

prometheus/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Prometheus common library webdevops projects
2+
3+
## Collector
4+
5+
### Caching
6+
7+
Prometheus collector offers a caching mechanism for faster restart with different backends defined by the cache spec:
8+
9+
| Cache spec | Description |
10+
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------|
11+
| `file://path/to/cache/` | Use local filesystem to cache data (use PVC inside Kubernetes!) |
12+
| `azblob://{storageAccountName}.blob.core.windows.net/{containerName}/{optionalPath}` | Use Azure StorageAccount to save cache data (with optional sub path) |
13+
| `k8scm://{namespace}/{configMapName}` | Use Kubernetes ConfigMap to save cache data |

0 commit comments

Comments
 (0)