Skip to contents

The CreateScraper operation creates a scraper to collect metrics

Source: R/prometheusservice_operations.R
prometheusservice_create_scraper.Rd

The create_scraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources and sends them to your Amazon Managed Service for Prometheus workspace. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

See https://www.paws-r-sdk.com/docs/prometheusservice_create_scraper/ for full documentation.

Usage

prometheusservice_create_scraper(
  alias = NULL,
  scrapeConfiguration,
  source,
  destination,
  roleConfiguration = NULL,
  clientToken = NULL,
  tags = NULL
)

Arguments

alias

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

scrapeConfiguration

[required] The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

source

[required] The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.

destination

[required] The Amazon Managed Service for Prometheus workspace to send metrics to.

roleConfiguration

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

clientToken

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

tags

(Optional) The list of tag keys and values to associate with the scraper.