Skip to content

Commit e5d0373

Browse files
authored
Add cost warning to aws, googlecloud and azure doc (#20033)
* Add cost warning to aws googlecloud and azure doc
1 parent 51c02dd commit e5d0373

File tree

6 files changed

+28
-6
lines changed

6 files changed

+28
-6
lines changed

metricbeat/docs/modules/aws.asciidoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ This file is generated! See scripts/mage/docs_collector.go
1010

1111
This module periodically fetches monitoring metrics from AWS CloudWatch using
1212
https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services.
13-
Note: extra AWS charges on GetMetricData API requests will be generated by this module.
1413

1514
All metrics are enabled by default.
1615

16+
IMPORTANT: Extra AWS charges on CloudWatch API requests will be generated by this
17+
module. Please see <<aws-api-requests,AWS API requests>> for more details.
18+
1719
[float]
1820
== Module-specific configuration notes
1921

@@ -196,6 +198,7 @@ real-time metrics for users to better understand the performance of their web
196198
applications and services.
197199

198200
[float]
201+
[[aws-api-requests]]
199202
== AWS API requests count per metricset
200203
This session is to document what are the AWS API called made by each metricset
201204
in `aws` module. This will be useful for users to estimate costs for using `aws`

metricbeat/docs/modules/azure.asciidoc

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Additional azure API calls will be executed in order to retrieve information reg
1818

1919
The azure module mericsets are `monitor`, `compute_vm` and `compute_vm_scaleset`
2020

21+
IMPORTANT: Extra Azure charges on metric queries may be generated by this module.
22+
Please see <<<<azure-api-cost,additional notes about metrics and costs>> for more details.
23+
2124
[float]
2225
=== Dashboards
2326

@@ -119,6 +122,7 @@ so the `period` for `billing` metricset should be `24h` or multiples of `24h`.
119122
This metricset will collect application insights metrics, the `period` (interval) for the `app-insights` metricset is set by default at `300s`.
120123

121124
[float]
125+
[[azure-api-cost]]
122126
== Additional notes about metrics and costs
123127

124128
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.

metricbeat/docs/modules/googlecloud.asciidoc

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ beta[]
1010

1111
This module periodically fetches monitoring metrics from Google Cloud Platform using
1212
https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] for Google Cloud Platform services.
13-
Note: extra GCP charges on Stackdriver Monitoring API requests will be generated by this module.
13+
14+
IMPORTANT: Extra GCP charges on Stackdriver Monitoring API requests may be
15+
generated by this module. Please see <<gcp-api-requests,rough estimation of the number of API calls>>
16+
for more details.
1417

1518
[float]
1619
== Module config and parameters
@@ -138,7 +141,8 @@ GCP monitoring data has a up to 240 seconds latency, which means latest monitori
138141
In googlecloud module, metrics are collected based on this ingest delay, which is also obtained from ListMetricDescriptors API.
139142

140143
[float]
141-
=== Rough estimation of the number of API Calls
144+
[[gcp-api-requests]]
145+
=== Rough estimation of the number of API calls
142146
Google Cloud Platform pricing depends of the number of requests you do to their API's. Here you have some information that you can use to make an estimation of the pricing you should expect. For example, imagine that you have a Compute Metricset activated and you don't want to exclude labels. You have a total of 20 instances running in a particular GCP project, region and zone.
143147

144148
For example, if Compute Metricset fetches 14 metrics (which is the number of metrics fetched in the early beta version). Each of those metrics will attempt an API call to Compute API to retrieve also their metadata. Because you have 20 different instances, the total number of API calls that will be done on each refresh period are: 14 metrics + 20 instances = 34 API requests every 5 minutes if that is your current Period. 9792 API requests per day with one zone. If you add 2 zones more with the same amount of instances you'll have 19584 API requests per day (9792 on each zone) or around 587520 per month for the Compute Metricset. This maths must be done for each different Metricset with slight variations.

x-pack/metricbeat/module/aws/_meta/docs.asciidoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
This module periodically fetches monitoring metrics from AWS CloudWatch using
44
https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services.
5-
Note: extra AWS charges on GetMetricData API requests will be generated by this module.
65

76
All metrics are enabled by default.
87

8+
IMPORTANT: Extra AWS charges on CloudWatch API requests will be generated by this
9+
module. Please see <<aws-api-requests,AWS API requests>> for more details.
10+
911
[float]
1012
== Module-specific configuration notes
1113

@@ -188,6 +190,7 @@ real-time metrics for users to better understand the performance of their web
188190
applications and services.
189191

190192
[float]
193+
[[aws-api-requests]]
191194
== AWS API requests count per metricset
192195
This session is to document what are the AWS API called made by each metricset
193196
in `aws` module. This will be useful for users to estimate costs for using `aws`

x-pack/metricbeat/module/azure/_meta/docs.asciidoc

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Additional azure API calls will be executed in order to retrieve information reg
1010

1111
The azure module mericsets are `monitor`, `compute_vm` and `compute_vm_scaleset`
1212

13+
IMPORTANT: Extra Azure charges on metric queries may be generated by this module.
14+
Please see <<<<azure-api-cost,additional notes about metrics and costs>> for more details.
15+
1316
[float]
1417
=== Dashboards
1518

@@ -111,6 +114,7 @@ so the `period` for `billing` metricset should be `24h` or multiples of `24h`.
111114
This metricset will collect application insights metrics, the `period` (interval) for the `app-insights` metricset is set by default at `300s`.
112115

113116
[float]
117+
[[azure-api-cost]]
114118
== Additional notes about metrics and costs
115119

116120
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.

x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
This module periodically fetches monitoring metrics from Google Cloud Platform using
22
https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] for Google Cloud Platform services.
3-
Note: extra GCP charges on Stackdriver Monitoring API requests will be generated by this module.
3+
4+
IMPORTANT: Extra GCP charges on Stackdriver Monitoring API requests may be
5+
generated by this module. Please see <<gcp-api-requests,rough estimation of the number of API calls>>
6+
for more details.
47

58
[float]
69
== Module config and parameters
@@ -128,7 +131,8 @@ GCP monitoring data has a up to 240 seconds latency, which means latest monitori
128131
In googlecloud module, metrics are collected based on this ingest delay, which is also obtained from ListMetricDescriptors API.
129132

130133
[float]
131-
=== Rough estimation of the number of API Calls
134+
[[gcp-api-requests]]
135+
=== Rough estimation of the number of API calls
132136
Google Cloud Platform pricing depends of the number of requests you do to their API's. Here you have some information that you can use to make an estimation of the pricing you should expect. For example, imagine that you have a Compute Metricset activated and you don't want to exclude labels. You have a total of 20 instances running in a particular GCP project, region and zone.
133137

134138
For example, if Compute Metricset fetches 14 metrics (which is the number of metrics fetched in the early beta version). Each of those metrics will attempt an API call to Compute API to retrieve also their metadata. Because you have 20 different instances, the total number of API calls that will be done on each refresh period are: 14 metrics + 20 instances = 34 API requests every 5 minutes if that is your current Period. 9792 API requests per day with one zone. If you add 2 zones more with the same amount of instances you'll have 19584 API requests per day (9792 on each zone) or around 587520 per month for the Compute Metricset. This maths must be done for each different Metricset with slight variations.

0 commit comments

Comments
 (0)