<scrape_config> - Prometheusドキュメント

scrape_configセクションは、監視対象とそれらをどのようにscrapeするかを表すパラメーターの集合である。 一般的なケースでは、一つのscrapeの設定が一つのジョブを指定する。高度な設定ではそうでない場合もある。

監視対象は、static_configsによって静的に設定されることも、service-discoveryの仕組みによって動的に設定されることもある。

relabel_configsによって、scrapeする前に任意の対象・ラベルを変更することが可能である。

# The job name assigned to scraped metrics by default.
job_name: <job_name>

# How frequently to scrape targets from this job.
[ scrape_interval: <duration> | default = <global_config.scrape_interval> ]

# Per-scrape timeout when scraping this job.
[ scrape_timeout: <duration> | default = <global_config.scrape_timeout> ]

# The HTTP resource path on which to fetch metrics from targets.
[ metrics_path: <path> | default = /metrics ]

# honor_labelsは、取得したデータにすでにあるラベルとPrometheusが付与しようとしている
# サーバーサイドのラベル(jobやinstance、手動で設定されたラベル、サービスディスカバリー
# で生成されたラベル)の衝突を制御する
#
# honor_labelsがtrueの場合、取得したデータのラベルの値を保持し、衝突しているサーバーサ
# イドのラベルを無視することで衝突を解決する
#
# honor_labelsがfalseの場合、取得したデータにある衝突しているラベルを
# "exported_<original-label>"(例えばexported_instance、exported_job)という名前に変更
# してからサーバーサイドのラベルを付与することで衝突を解決する。これは、federationのような、対象
# の全てのラベルを保持しなければいけないユースケースで便利である。
#
# グローバルに設定された"external_labels"は、この設定に影響されないことに注意すること。
# 外部システムとのやりとりでは、それらは必ず時系列データにそのラベルがまだない場合にのみ適用され、
# そうでない場合は無視される。
[ honor_labels: <boolean> | default = false ]

# Configures the protocol scheme used for requests.
[ scheme: <scheme> | default = http ]

# Optional HTTP URL parameters.
params:
  [ <string>: [<string>, ...] ]

# 設定されてusernameとpasswordでscrapeのリクエストの`Authorization`ヘッダを毎回セットする。
# passwordとpassword_fileは相互排他的である。
basic_auth:
  [ username: <string> ]
  [ password: <secret> ]
  [ password_file: <string> ]

# 設定された署名なしトークン (Bearer Token)でscrapeのリクエストの`Authorization`ヘッダを
# 毎回セットする。`bearer_token_file`と相互排他的である。
[ bearer_token: <secret> ]

# 設定ファイルから読み込んだ署名なしトークン (Bearer Token)でscrapeのリクエストの
# `Authorization`ヘッダを毎回セットする。`bearer_token`と相互排他的である。

[ bearer_token_file: /path/to/bearer/token/file ]

# Configures the scrape request's TLS settings.
tls_config:
  [ <tls_config> ]

# Optional proxy URL.
[ proxy_url: <string> ]

# List of Azure service discovery configurations.
azure_sd_configs:
  [ - <azure_sd_config> ... ]

# List of Consul service discovery configurations.
consul_sd_configs:
  [ - <consul_sd_config> ... ]

# List of DNS service discovery configurations.
dns_sd_configs:
  [ - <dns_sd_config> ... ]

# List of EC2 service discovery configurations.
ec2_sd_configs:
  [ - <ec2_sd_config> ... ]

# List of OpenStack service discovery configurations.
openstack_sd_configs:
  [ - <openstack_sd_config> ... ]

# List of file service discovery configurations.
file_sd_configs:
  [ - <file_sd_config> ... ]

# List of GCE service discovery configurations.
gce_sd_configs:
  [ - <gce_sd_config> ... ]

# List of Kubernetes service discovery configurations.
kubernetes_sd_configs:
  [ - <kubernetes_sd_config> ... ]

# List of Marathon service discovery configurations.
marathon_sd_configs:
  [ - <marathon_sd_config> ... ]

# List of AirBnB's Nerve service discovery configurations.
nerve_sd_configs:
  [ - <nerve_sd_config> ... ]

# List of Zookeeper Serverset service discovery configurations.
serverset_sd_configs:
  [ - <serverset_sd_config> ... ]

# List of Triton service discovery configurations.
triton_sd_configs:
  [ - <triton_sd_config> ... ]

# List of labeled statically configured targets for this job.
static_configs:
  [ - <static_config> ... ]

# List of target relabel configurations.
relabel_configs:
  [ - <relabel_config> ... ]

# List of metric relabel configurations.
metric_relabel_configs:
  [ - <relabel_config> ... ]

# scrape毎に受け付けるサンプル数の限界値。もしリラベルした後にこの値より多いサンプルに
# なったらscrape全体が失敗として扱われる。0は制限なしを意味する
[ sample_limit: <int> | default = 0 ]

参考リンク

Prometheus: Up & Running: Infrastructure and Application Performance Monitoring

Prometheus: Up & Running: Infrastructure and Application Performance Monitoring