Skip to content

loggregator_agent_windows job from loggregator-agent/7.6.3

Github source: 0a33762c or master branch

Properties

deployment

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

Default
""

disable_logs

Disable log egress from the agent

Default
false

disable_udp

Disable incoming UDP

Default
false

doppler

grpc_port

Port for outgoing log messages via GRPC

Default
8082

override_az_url

URL to use for dopplers AZ qualifies instead of using bosh links

override_url

URL to use for dopplers instead of bosh link

enabled

Enable v1 Firehose and v2 Logstream

Default
true

grpc_port

Port the agent is listening on to receive gRPC log envelopes

Default
3458

listening_port

Port the agent is listening on to receive dropsonde log messages

Default
3457

logging

format

timestamp

Format for timestamp in component logs. Valid values are ‘deprecated’ and ‘rfc3339’.

Default
deprecated

loggregator

tls

agent
cert

TLS certificate for agent

key

TLS key for agent

ca_cert

CA root required for key/cert verification

cipher_suites

An ordered list of supported SSL cipher suites. Allowed cipher suites are TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 and TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

Default
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

metrics

ca_cert

TLS CA cert to verify requests to metrics endpoint.

cert

TLS certificate for metrics server signed by the metrics CA

debug

Enables go_ and process_ metrics along with a pprof endpoint

Default
false

key

TLS private key for metrics server signed by the metrics CA

port

Port the agent uses to serve metrics and debug information

Default
14824

pprof_port

If debug metrics is enabled, pprof will start at this port, ideally set to something other then 0

Default
0

server_name

The server name used in the scrape configuration for the metrics endpoint

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 the agent

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

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
""

Templates

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

  • bin/pre-start.ps1 (from pre-start.ps1.erb)
  • config/certs/loggregator_agent.crt (from loggregator_agent.crt.erb)
  • config/certs/loggregator_agent.key (from loggregator_agent.key.erb)
  • config/certs/loggregator_ca.crt (from loggregator_ca.crt.erb)
  • config/certs/metrics.crt (from metrics.crt.erb)
  • config/certs/metrics.key (from metrics.key.erb)
  • config/certs/metrics_ca.crt (from metrics_ca.crt.erb)
  • config/ingress_port.yml (from ingress_port.yml.erb)
  • config/prom_scraper_config.yml (from prom_scraper_config.yml.erb)

Packages

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