Skip to content

Commit 7785eb1

Browse files
zmoogzmoog
authored
[azure metrics] Add latency config option (#14018)
Add the Latency config option to Azure Monitor integrations. 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`. We expect the latency to help integrations with a few services that report metrics with delay.
1 parent c002065 commit 7785eb1

File tree

12 files changed

+98
-4
lines changed

12 files changed

+98
-4
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/changelog.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
- version: 1.9.0
2+
changes:
3+
- description: Add latency configuration option.
4+
type: enhancement
5+
link: https://github.com/elastic/integrations/pull/14018
16
- version: 1.8.0
27
changes:
38
- description: Add enable_batch_api option

‎packages/azure_metrics/data_stream/compute_vm/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ metricsets: ["monitor"]
22
default_resource_type: "Microsoft.Compute/virtualMachines"
33
add_cloud_metadata: true
44
period: {{period}}
5+
{{#if latency}}
6+
latency: {{latency}}
7+
{{/if}}
58
{{#if client_id}}
69
client_id: {{client_id}}
710
{{/if}}

‎packages/azure_metrics/data_stream/compute_vm_scaleset/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ metricsets: ["monitor"]
22
default_resource_type: "Microsoft.Compute/virtualMachineScaleSets"
33
add_cloud_metadata: true
44
period: {{period}}
5+
{{#if latency}}
6+
latency: {{latency}}
7+
{{/if}}
58
{{#if client_id}}
69
client_id: {{client_id}}
710
{{/if}}

‎packages/azure_metrics/data_stream/container_instance/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["monitor"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

‎packages/azure_metrics/data_stream/container_registry/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["monitor"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

‎packages/azure_metrics/data_stream/container_service/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["monitor"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

‎packages/azure_metrics/data_stream/database_account/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["monitor"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

‎packages/azure_metrics/data_stream/monitor/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["monitor"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

‎packages/azure_metrics/data_stream/storage_account/agent/stream/stream.yml.hbs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
metricsets: ["storage"]
22
period: {{period}}
3+
{{#if latency}}
4+
latency: {{latency}}
5+
{{/if}}
36
{{#if client_id}}
47
client_id: {{client_id}}
58
{{/if}}

0 commit comments

Comments
 (0)