Skip to content

metron_agent job from cf/266

Github source: 1fb7a485 or master branch

Properties

doppler

addr

DNS name for doppler. This needs to be round robbin DNS if you want metron to communicate with multiple dopplers.

Default
doppler.service.cf.internal

grpc_port

Port for outgoing log messages via GRPC

Default
8082

udp_port

Port for outgoing log messages via UDP

Default
3457

loggregator

tls

ca_cert

CA root required for key/cert verification

metron
cert

TLS certificate for metron

key

TLS key for metron

metron_agent

deployment

Name of deployment (added as tag on all outgoing v1 envelopes)

Default
""

disable_udp

Disable incoming UDP

Default
false

grpc_port

Port the metron agent is listening on to receive gRPC log envelopes

Default
3458

health_port

The port for the health endpoint

Default
14824

listening_address

Address the metron agent is listening on to receive dropsonde log messages provided for BOSH links and should not be overwritten

Default
127.0.0.1

listening_port

Port the metron agent is listening on to receive dropsonde log messages

Default
3457

logrotate

freq_min

The frequency in minutes which logrotate will rotate VM logs

Default
5
rotate

The number of files that logrotate will keep around on the VM

Default
7
size

The size at which logrotate will decide to rotate the log file

Default
50M

pprof_port

The pprof port for runtime profiling data

Default
0

tags

Collection of tags to add on all outgoing v2 envelopes. Bosh deployment, job, index and IP will be merged with this property if they are not provided

Default
{}
Example
deployment: cf

zone

Availability zone where this agent is running

Default
""

syslog_daemon_config

address

IP address for syslog aggregator

Default
""

custom_rule

Custom rule for syslog forward daemon

Default
""

enable

Enable or disable rsyslog configuration for forwarding syslog messages into metron

Default
true

fallback_addresses

Addresses of fallback servers to be used if the primary syslog server is down. Only tcp or relp are supported. Each list entry should consist of “address”, “transport” and “port” keys.

Default
[]

max_message_size

maximum message size to be sent

Default
4k

port

Port of syslog aggregator

Default
""

transport

Transport to be used when forwarding logs (tcp|udp).

Default
udp

Templates

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

  • bin/metron_agent_ctl (from metron_agent_ctl.erb)
  • config/certs/loggregator_ca.crt (from loggregator_ca.crt.erb)
  • config/certs/metron_agent.crt (from metron_agent.crt.erb)
  • config/certs/metron_agent.key (from metron_agent.key.erb)
  • config/logrotate.conf (from logrotate.conf.erb)
  • config/metron_agent.json (from metron_agent.json.erb)
  • config/metron_agent_logrotate.cron (from metron_agent_logrotate.cron.erb)
  • config/syslog_forwarder.conf (from syslog_forwarder.conf.erb)

Packages

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