Skip to content

Commit 6abd5ce

Browse files
committed
Update docs
1 parent f894b6d commit 6abd5ce

File tree

3 files changed

+61
-2
lines changed

3 files changed

+61
-2
lines changed

packages/azure_metrics/_dev/build/docs/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,36 @@ The settings' main section contains all the options needed to access the Azure A
167167

168168
### Advanced options
169169

170-
There are three additional advanced options:
170+
There are the following additional advanced options:
171+
172+
`Latency` _string_
173+
: Optional. Latency is the time it takes for the Azure service to publish the metric values to Azure Monitor. The integration uses the latency value to compensate for the delay in metric value publishing.
174+
175+
Default value is `0`. Typical values are `30s` or `1m`.
176+
177+
```text
178+
| |
179+
| | Now
180+
| │ |
181+
| time grain │ |
182+
│ │◀──(PT1M)──▶ │ |
183+
│ │ |
184+
├──────────────────────────────────────────┼─────────────┼──────────────|
185+
│ │ |
186+
│ timespan │ │ |
187+
|◀───────────────────────(5min)─────────────────────────▶│ |
188+
│ │ │ |
189+
| period │ |
190+
│◀───────────────────────(5min)─────────────────────────▶| │
191+
│ │ |
192+
│ │ |
193+
| │ latency |
194+
| | ◀──(1min)──▶ |
195+
│ │ |
196+
│ │ |
197+
Start End |
198+
│ │ |
199+
```
171200

172201
`Resource Manager Endpoint` _string_
173202
: Optional. By default, the integration uses the Azure public environment. To override, users can provide a specific resource manager endpoint to use a different Azure environment.

packages/azure_metrics/docs/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,36 @@ The settings' main section contains all the options needed to access the Azure A
167167

168168
### Advanced options
169169

170-
There are three additional advanced options:
170+
There are the following additional advanced options:
171+
172+
`Latency` _string_
173+
: Optional. Latency is the time it takes for the Azure service to publish the metric values to Azure Monitor. The integration uses the latency value to compensate for the delay in metric value publishing.
174+
175+
Default value is `0`. Typical values are `30s` or `1m`.
176+
177+
```text
178+
| |
179+
| | Now
180+
| │ |
181+
| time grain │ |
182+
│ │◀──(PT1M)──▶ │ |
183+
│ │ |
184+
├──────────────────────────────────────────┼─────────────┼──────────────|
185+
│ │ |
186+
│ timespan │ │ |
187+
|◀───────────────────────(5min)─────────────────────────▶│ |
188+
│ │ │ |
189+
| period │ |
190+
│◀───────────────────────(5min)─────────────────────────▶| │
191+
│ │ |
192+
│ │ |
193+
| │ latency |
194+
| | ◀──(1min)──▶ |
195+
│ │ |
196+
│ │ |
197+
Start End |
198+
│ │ |
199+
```
171200

172201
`Resource Manager Endpoint` _string_
173202
: Optional. By default, the integration uses the Azure public environment. To override, users can provide a specific resource manager endpoint to use a different Azure environment.

packages/azure_metrics/manifest.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ vars:
8181
- name: latency
8282
type: text
8383
title: Latency
84+
description: Latency is the time it takes for the Azure service to publish the metric values to Azure Monitor. The integration uses the latency value to compensate for the delay in metric value publishing. Default value is `0`. Typical values are `30s` or `1m`. [Learn more](https://www.elastic.co/docs/reference/integrations/azure_metrics/#advanced-options).
8485
multi: false
8586
required: false
8687
show_user: false

0 commit comments

Comments
 (0)