Skip to content

log-cache job from log-cache/3.2.3

Github source: 360d8791 or master branch

Properties

append_node_addresses

Array of log-cache instances to add to bosh links

disabled

Turns off log cache.

Default
false

ingress_buffer_read_batch_interval

The ingress buffer read batch interval in milliseconds. The interval in which the data will be read out from the ingress buffer used when LogCache nodes send envelopes between each other. In some cases, the batch read interval must be adjusted in order to make place in the buffer faster and avoid ingress drops. Must be an integer.

Default
250

ingress_buffer_read_batch_size

The ingress buffer read batch size in number of items. The size of the ingress buffer read batch used when LogCache nodes send envelopes between each other. In some cases, the batch size must be risen in order to make place in the buffer faster and avoid ingress drops. Must be an integer.

Default
100

ingress_buffer_size

The ingress buffer (diode) size in number of items. The size of the ingress buffer used when LogCache nodes send items between each other. In some cases, the buffer size must be risen in order to avoid ingress drops. Must be an integer.

Default
10000

logging

format

timestamp

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

Default
deprecated

max_per_source

The maximum number of items stored in LogCache per source.

Default
100000

memory_limit_bytes

Overrides memory_limit_percent with a specific size cache in bytes.

memory_limit_percent

Percentage of system memory to use for the cache. Must be an integer.

Default
50

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

The port for LogCache to bind a health endpoint

Default
6060

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

port

The port for the log-cache to listen on

Default
8080

prepend_node_addresses

Array of log-cache instances to add to bosh links

promql

query_timeout

The maximum allowed runtime for a single PromQL query. Smaller timeouts are recommended.

Default
10s

prunes_per_gc

Number of consecutive prunes to do before running garbage collection. Lowering the value increase CPU utilization

Default
3

tls

ca_cert

The Certificate Authority for log cache mutual TLS.

cert

The client cert for log cache mutual TLS.

key

The client private key for log cache mutual TLS.

truncation_interval

The amount of time between log-cache checking if it needs to prune

Default
1s

Templates

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

  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/ca.crt (from ca.crt.erb)
  • config/certs/log_cache.crt (from log_cache.crt.erb)
  • config/certs/log_cache.key (from log_cache.key.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/indicators.yml (from indicators.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.