Root Node Config¶

A sample dstore-dist-report-apiconfiguration is shown below:

listen_addr: "localhost:8080"

elasticsearch:
  addr: https://localhost:19200
  index: my-forwarder-index*
  # Auth username.
  user: admin
  # Auth password.
  password: changeme
  tlsconfig:
    insecure_skip_verify: true

log:
  level: Trace

The following YAML key-values are supported for configuration at the root node:

Parameter	Type	Description
`api-key`	string	API Key to use for authorization using the `X-API-Key` header. If not specified, no authorization will be required.
`elasticsearch`	Elasticsearch
`http`	HTTP Metrics	Prometheus Metrics HTTP Listener
`listen_addr`	`<ip:port>`	The address to listen on for REST API queries. The value is an address:port string, in either v4 or v6 format. IPv6 addresses must be placed in square brackets like this `[::1]`. You can omit the address to listen on all local addresses
`tlsconfig`	TLS Config	TLS Configuration for the listener
`log`	Log Config	Log configuration. Note - enable `Trace` level logging to see all Opensearch/Elasticsearch Requests and Responses

HTTP Metrics¶

The following YAML fields are supported for configuration:

Parameter	Type	Default	Description
`address`	`<ip:port>`		The address to listen on for prometheus metrics. The value is an address:port string, in either v4 or v6 format. IPv6 addresses must be placed in square brackets like this `[::1]`.

Elasticsearch¶

The following YAML fields are supported for configuration:

Parameter	Type	Description
`addr`	`string`	The URL of the elasticsearch server
`api_key`	`string`	Alternative auth method
`cloud_id`	`string`	Alternative auth method
`index`	`string`	Pattern of the elasticsearch index to retrieve events from, e.g. logstash-*
`password`	`string`	The password to authenticate to elasticsearch
`tlsconfig`	TLS Config	TLS configuration for the connection to elasticsearch. Leave out if not using TLS
`user`	`string`	The username to authenticate to elasticsearch