Skip to content

otel-collector-windows job from otel-collector/0.11.10

Github source: c7b296b4 or master branch

Properties

allow_list

exporters

Exporters allowed for use in otel-collector config. Must be a subset of list included in otel-collector builder config. Empty list means allow all possible.

Example
- otlp
- prometheus
- prometheus_remote_write

extensions

Extensions allowed for use in otel-collector config. Must be a subset of list included in otel-collector builder config. Empty list means allow all possible.

Example
- pprof

processors

Processors allowed for use in otel-collector config. Must be a subset of list included in otel-collector builder config. Empty list means allow all possible.

Example
- batch

config

Collector configuration

Default
{}
Example
|+
  receivers:
    otlp/placeholder:

  processors:
    batch:

  exporters:
    otlp:
      endpoint: otelcol:4317

  service:
    pipelines:
      traces:
        receivers: [otlp/placeholder]
        processors: [batch]
        exporters: [otlp]
      metrics:
        receivers: [otlp/placeholder]
        processors: [batch]
        exporters: [otlp]

enabled

Enable OTel Collector

Default
true

ingress

grpc

address

Address to listen on to receive OTLP over gRPC

Default
127.0.0.1
port

Port the collector is listening on to receive OTLP over gRPC

Default
9100
tls
ca_cert

CA root required for key/cert verification in gRPC ingress

cert

TLS server certificate for gRPC ingress

key

TLS server key for gRPC ingress

limits

cpu

Controls how many CPU cores this process can use simultaneously.

memory_mib

Memory limit to apply to this process, in mebibytes.

Default
512

metric_exporters

Exporter configuration for aggregate metric egress. Deprecated, please use ‘config’ property.

Default
{}
Example
|+
  otlp:
    endpoint: otelcol:4317
  otlp/2:
    endpoint: otelcol:4318

secrets

List of named secret entries with four slots each (cert, key, ca, secret) interpolated into a YAML-string config at render time via {{ .name.type }} placeholders. E.g. use when config must stay a string and embeds values BOSH ((var)) substitution cannot inject (multi-line PEMs). Every declared secret must be used at least once or rendering fails.

Default
[]
Example
|+
  - name: prod-otlp
    ca:   ((prod_ca))
    cert: ((prod_cert))
    key:  ((prod_key))
  - name: vendor
    secret: ((vendor_auth_token))
  # Then reference from `config`:
  #   exporters:
  #     otlp_grpc/prod:
  #       tls:
  #         ca_pem:   '{{ .prod-otlp.ca }}'
  #         cert_pem: '{{ .prod-otlp.cert }}'
  #         key_pem:  '{{ .prod-otlp.key }}'
  #     otlp_http/vendor:
  #       headers:
  #         authorization: '{{ .vendor.secret }}'

telemetry

metrics

level

Level of metrics the collector exposes about itself

Default
basic
port

Port to serve the collector’s internal metrics

Default
14830

trace_exporters

Exporter configuration for aggregate trace egress. Deprecated, please use ‘config’ property.

Default
{}
Example
|+
  otlp/trace:
    endpoint: otelcol:4317
  otlp/trace2:
    endpoint: otelcol:4318

Templates

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

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