monasca-agent/conf.d/http_metrics.yaml.example

75 lines
3.2 KiB
Plaintext

# (C) Copyright 2015 Hewlett Packard Enterprise Development Company LP
init_config:
instances:
# - name: Some Service Name
# url: http://some.url.example.com
# timeout: 1
# If your service uses basic authentication, you can optionally
# specify a username and password that will be used in the check.
# username: user
# password: pass
# If your service uses keystone for authentication, you can optionally
# specify the information to collect a token to be used in the check.
# This information should follow the same guidelines presented in
# agent.yaml.template
# https://github.com/openstack/monasca-agent/blob/master/agent.yaml.template
# If use_keystone=True and keystone_config is not specified, the keystone information
# from the agent config will be used.
# use_keystone=True
# keystone_config:
# keystone_url: http://endpoint.com/v3/
# username: user
# password: password
# The (optional) collect_response_time parameter will instruct the
# check to create a metric 'network.http.response_time', tagged with
# the url, reporting the response time in seconds.
# collect_response_time: true
# The (optional) disable_ssl_validation will instruct the check
# to skip the validation of the SSL certificate of the URL being tested.
# This is mostly useful when checking SSL connections signed with
# certificates that are not themselves signed by a public authority.
# When true, the check logs a warning in collector.log
# disable_ssl_validation: true
# The (optional) headers parameter allows you to send extra headers
# with the request. This is useful for explicitly specifying the host
# header or perhaps adding headers for authorisation purposes. Note
# that the http client library converts all headers to lowercase.
# This is legal according to RFC2616
# (See: http://tools.ietf.org/html/rfc2616#section-4.2)
# but may be problematic with some HTTP servers
# (See: https://code.google.com/p/httplib2/issues/detail?id=169)
# headers:
# Host: alternative.host.example.com
# X-Auth-Token: SOME-AUTH-TOKEN
# dimensions:
# dim1: value1
# To select which metrics to record, create a whitelist. Each entry in
# the whitelist should include the name you want to give the metric,
# the path to the metric value in the json (as a series of keys
# separated by '/'), and the type of recording to use (counter, gauge,
# rate, histogram, set). See the Plugins documentation about
# http_metrics for more information about the different types.
# whitelist:
# - name: jvm.memory.total.used
# path: gauges/jvm.memory.total.used/value
# type: gauge
# - name: metrics.published
# path: meters/monasca.api.app.MetricService.metrics.published/count
# type: rate
# - name: raw-sql.time.avg
# path: timers/org.skife.jdbi.v2.DBI.raw-sql/mean
# type: gauge