Skip to content

metricsforwarder job from app-autoscaler/9.2.0

Github source: 8e35bc80 or master branch

Properties

autoscaler

metricsforwarder

cache_cleanup_interval

The time interval to purge expired cache entries in metric forwarder

Default
6h
cache_ttl

The time interval to mark cache entries as expired in metric forwarder

Default
900s
cred_helper
impl

Either default or stored_procedure which retrieves and manages credentials

Default
default
stored_procedure_config

Configuration to define the stored procedure config if stored_procedure is used as the implementation. stored_procedure_config: schema_name: string create_binding_credential_procedure_name: string drop_binding_credential_procedure_name: string drop_all_binding_credential_procedure_name: string validate_binding_credential_procedure_name: string

Example below:

stored_procedure_config: schema_name: SCHEMA create_binding_credential_procedure_name: CREATE drop_binding_credential_procedure_name: DROP drop_all_binding_credential_procedure_name: DROPALL validate_binding_credential_procedure_name: VALIDATE

Default
{}
health
password

the password of health endpoint

Default
""
port

The listening port of health endpoint

Default
6403
username

the username of health endpoint

Default
""
hooks
post_start

Script to run after metricsforwarder has started

Default
""
post_stop

Script to run after metricsforwarder has stopped

Default
""
pre_start

Script to run before starting metricsforwarder

Default
""
Example
|+
  #!/bin/bash
  echo "Going to start metricsforwarder"
  echo "metricsforwarder data directory is ${DATA_DIR}"
  echo "metricsforwarder port is ${PORT}"
  echo "metricsforwarder directory is ${PACKAGE_DIR}"
pre_stop

Script to run before stopping metricsforwarder

Default
""
logging
level

The level of logging

Default
info
loggregator
metron_address

IP address and port where the metron agent is running

Default
127.0.0.1:3458
tls
ca_cert

PEM-encoded ca certificate of loggregator ingress client

cert

PEM-encoded tls client certificate to connect to loggregator ingress client

key

PEM-encoded tls client key to connect to loggregator ingress client

policy_poller_interval

The time interval to refresh cached policies from policy database

Default
60s
rate_limit
max_amount

The number of requests accepted by rate limit

Default
10
valid_duration

The rate limit evaluation duration

Default
1s
require_consul

Whether to start consul agent

Default
false
server
port

Port on which the metricsforwarder server will listen

Default
6201

policy_db

address

IP address on which the policydb server will listen

Default
autoscalerpostgres.service.cf.internal
databases

The list of databases used in policydb database including name

db_scheme

Database scheme to be used to access policydb

port

Port on which the policydb server will listen

roles

The list of database roles used in policydb database including name/password

sslmode

The sslmode to connect to postgres server

Default
disable
tls
ca

PEM-encoded ca certificate of tls database server

Default
""
certificate

PEM-encoded certificate of tls database client

Default
""
private_key

PEM-encoded key of tls database client

Default
""

policy_db_connection_config

connection_max_lifetime
Default
60s
max_idle_connections
Default
10
max_open_connections
Default
20

storedprocedure_db

address

IP address on which the storedproceduredb server will listen

Default
""
databases

The list of databases used in storedproceduredb database including name

db_scheme

Database scheme to be used to access storedproceduredb

port

Port on which the storedproceduredb server will listen

roles

The list of database roles used in storedproceduredb database including name/password

sslmode

The sslmode to connect to postgres server

Default
disable
tls
ca

PEM-encoded ca certificate of tls database server

Default
""
certificate

PEM-encoded certificate of tls database client

Default
""
private_key

PEM-encoded key of tls database client

Default
""

storedprocedure_db_connection_config

connection_max_lifetime
Default
60s
max_idle_connections
Default
10
max_open_connections
Default
20

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/metricsforwarder/ directory (learn more).

  • bin/hooks/post-start.sh (from hooks/post-start.sh.erb)
  • bin/hooks/post-stop.sh (from hooks/post-stop.sh.erb)
  • bin/hooks/pre-start.sh (from hooks/pre-start.sh.erb)
  • bin/hooks/pre-stop.sh (from hooks/pre-stop.sh.erb)
  • bin/metricsforwarder_ctl (from metricsforwarder_ctl)
  • bin/pre-start (from pre-start.erb)
  • config/certs/metron_client/ca.crt (from metron_client_ca.crt.erb)
  • config/certs/metron_client/client.crt (from metron_client.crt.erb)
  • config/certs/metron_client/client.key (from metron_client.key.erb)
  • config/certs/policy_db/ca.crt (from policy_db_ca.crt.erb)
  • config/certs/policy_db/crt (from policy_db.crt.erb)
  • config/certs/policy_db/key (from policy_db.key.erb)
  • config/certs/storedprocedure_db/ca.crt (from storedprocedure_db_ca.crt.erb)
  • config/certs/storedprocedure_db/crt (from storedprocedure_db.crt.erb)
  • config/certs/storedprocedure_db/key (from storedprocedure_db.key.erb)
  • config/metricsforwarder.yml (from metricsforwarder.yml.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.