diff --git a/metricbeat/docs/modules/aws.asciidoc b/metricbeat/docs/modules/aws.asciidoc index add39a7cbbb..42d24c65ccd 100644 --- a/metricbeat/docs/modules/aws.asciidoc +++ b/metricbeat/docs/modules/aws.asciidoc @@ -10,10 +10,12 @@ This file is generated! See scripts/mage/docs_collector.go This module periodically fetches monitoring metrics from AWS CloudWatch using https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services. -Note: extra AWS charges on GetMetricData API requests will be generated by this module. All metrics are enabled by default. +IMPORTANT: Extra AWS charges on CloudWatch API requests will be generated by this +module. Please see <> for more details. + [float] == Module-specific configuration notes @@ -196,6 +198,7 @@ real-time metrics for users to better understand the performance of their web applications and services. [float] +[[aws-api-requests]] == AWS API requests count per metricset This session is to document what are the AWS API called made by each metricset in `aws` module. This will be useful for users to estimate costs for using `aws` diff --git a/metricbeat/docs/modules/azure.asciidoc b/metricbeat/docs/modules/azure.asciidoc index 93d644bd999..f7605bd9e87 100644 --- a/metricbeat/docs/modules/azure.asciidoc +++ b/metricbeat/docs/modules/azure.asciidoc @@ -18,6 +18,9 @@ Additional azure API calls will be executed in order to retrieve information reg The azure module mericsets are `monitor`, `compute_vm` and `compute_vm_scaleset` +IMPORTANT: Extra Azure charges on metric queries may be generated by this module. +Please see <<<> for more details. + [float] === Dashboards @@ -119,6 +122,7 @@ so the `period` for `billing` metricset should be `24h` or multiples of `24h`. This metricset will collect application insights metrics, the `period` (interval) for the `app-insights` metricset is set by default at `300s`. [float] +[[azure-api-cost]] == Additional notes about metrics and costs 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/. diff --git a/metricbeat/docs/modules/googlecloud.asciidoc b/metricbeat/docs/modules/googlecloud.asciidoc index 1db74b893ff..cda21fb7de3 100644 --- a/metricbeat/docs/modules/googlecloud.asciidoc +++ b/metricbeat/docs/modules/googlecloud.asciidoc @@ -10,7 +10,10 @@ beta[] This module periodically fetches monitoring metrics from Google Cloud Platform using https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] for Google Cloud Platform services. -Note: extra GCP charges on Stackdriver Monitoring API requests will be generated by this module. + +IMPORTANT: Extra GCP charges on Stackdriver Monitoring API requests may be +generated by this module. Please see <> +for more details. [float] == Module config and parameters @@ -138,7 +141,8 @@ GCP monitoring data has a up to 240 seconds latency, which means latest monitori In googlecloud module, metrics are collected based on this ingest delay, which is also obtained from ListMetricDescriptors API. [float] -=== Rough estimation of the number of API Calls +[[gcp-api-requests]] +=== Rough estimation of the number of API calls 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. 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. diff --git a/x-pack/metricbeat/module/aws/_meta/docs.asciidoc b/x-pack/metricbeat/module/aws/_meta/docs.asciidoc index 32afafebf86..fe9aeea007f 100644 --- a/x-pack/metricbeat/module/aws/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/aws/_meta/docs.asciidoc @@ -2,10 +2,12 @@ This module periodically fetches monitoring metrics from AWS CloudWatch using https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services. -Note: extra AWS charges on GetMetricData API requests will be generated by this module. All metrics are enabled by default. +IMPORTANT: Extra AWS charges on CloudWatch API requests will be generated by this +module. Please see <> for more details. + [float] == Module-specific configuration notes @@ -188,6 +190,7 @@ real-time metrics for users to better understand the performance of their web applications and services. [float] +[[aws-api-requests]] == AWS API requests count per metricset This session is to document what are the AWS API called made by each metricset in `aws` module. This will be useful for users to estimate costs for using `aws` diff --git a/x-pack/metricbeat/module/azure/_meta/docs.asciidoc b/x-pack/metricbeat/module/azure/_meta/docs.asciidoc index 38e11f24a85..3749ab17bc7 100644 --- a/x-pack/metricbeat/module/azure/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/azure/_meta/docs.asciidoc @@ -10,6 +10,9 @@ Additional azure API calls will be executed in order to retrieve information reg The azure module mericsets are `monitor`, `compute_vm` and `compute_vm_scaleset` +IMPORTANT: Extra Azure charges on metric queries may be generated by this module. +Please see <<<> for more details. + [float] === Dashboards @@ -111,6 +114,7 @@ so the `period` for `billing` metricset should be `24h` or multiples of `24h`. This metricset will collect application insights metrics, the `period` (interval) for the `app-insights` metricset is set by default at `300s`. [float] +[[azure-api-cost]] == Additional notes about metrics and costs 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/. diff --git a/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc b/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc index b5a676d65ad..00846498770 100644 --- a/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc @@ -1,6 +1,9 @@ This module periodically fetches monitoring metrics from Google Cloud Platform using https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] for Google Cloud Platform services. -Note: extra GCP charges on Stackdriver Monitoring API requests will be generated by this module. + +IMPORTANT: Extra GCP charges on Stackdriver Monitoring API requests may be +generated by this module. Please see <> +for more details. [float] == Module config and parameters @@ -128,7 +131,8 @@ GCP monitoring data has a up to 240 seconds latency, which means latest monitori In googlecloud module, metrics are collected based on this ingest delay, which is also obtained from ListMetricDescriptors API. [float] -=== Rough estimation of the number of API Calls +[[gcp-api-requests]] +=== Rough estimation of the number of API calls 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. 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.