Chronosphere Logs destination plugin

The Chronosphere Logs destination plugin lets you configure your Telemetry Pipeline to output log data to Chronosphere.

Configuration parameters

The Chronosphere Logs destination plugin provides these configuration parameters. Items in the Name column display in the Calyptia Dashboard. Items in the Key column are the YAML keys to use in pipeline configuration files.

Metadata

Name	Key	Description	Default
Name	`Name`	Plugin instance name for identification purposes.	none

General

Name	Key	Description	Default
Host	`host`	Required. Your Observability Platform instance.	`ADDRESS``.ingest.logs.chronosphere.io`
Port	`port`	Required. The port to communicate with Observability Platform.	`443`
Key	`header`	Required. The header type to include with your request.	`Authorization`
Value	`header`	Required. Your ingest API token to authenticate with Chronosphere.	`Bearer` `API_TOKEN`

Replace ADDRESS with your company name prefixed to your Observability Platform instance that ends in ingest.logs.chronosphere.io. For example, MY_COMPANY.ingest.logs.chronosphere.io.
Replace API_TOKEN with your ingest API token.

Advanced

Name	Key	Description	Default
URI	`uri`	Optional. HTTP URI for the web server. For example, `/api/v1/ingest/json`.	`/api/v1/ingest/json`
Format	`format`	The data format to use in the HTTP request.	`json`
Compress	`compress`	Sets payload compression, which can be `none` or `gzip`.	none
HTTP Proxy	`proxy`	Specify an HTTP proxy. The expected format is `http://host:port`.	none
JSON Date Format	`json_date_format`	Specify the date format, which can be one of `double`, `iso8601` (such as `2018-05-30T09:39:52.000681Z`), `java_sql_timestamp` (such as `2018-05-30 09:39:52.000681`), and `epoch`.	`iso8601`
JSON Date Key	`json_date_key`	Specify the name of the date field in output.	`_time`
Body Key	`body_key`	Specify the key which contains the body.	none
Header Tag	`header_tag`	Set an HTTP header whose value is the tag of the record.	none
Header Key	`headers_key`	Specify the key which contains the headers.	none

Security and TLS

Name	Key	Description	Default
TLS	`tls`	Enable or disable TLS/SSL support.	none
TLS Certificate Validation	`tls.verify`	Turn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled.	`on`
TLS Debug Level	`tls.debug`	Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational), `4` (Verbose).	`1`
CA Certificate File Path	`tls.ca_file`	Absolute path to CA certificate file.	none
Certificate File Path	`tls.crt_file`	Absolute path to certificate file.	none
Private Key File Path	`tls.key_file`	Absolute path to private key file.	none
Private Key Path Password	`tls.key_passwd`	Optional password for `tls.key_file` file.	none
TLS SNI Hostname Extension	`tls.vhost`	Hostname to be used for TLS SNI extension.	none

Advanced Networking

Name	Key	Description	Default
DNS Mode	`net.dns.mode`	Select the primary DNS connection type, which can be `TCP` or `UDP`.	none
DNS Resolver	`net.dns.resolver`	Select the primary DNS connection type, which can be `LEGACY` or `ASYNC`.	none
Prefer IPv4	`net.dns.prefer_ipv4`	Prioritize IPv4 DNS results when trying to establish a connection. Valid values are `true` or `false`.	none
Keepalive	`net.keepalive`	Enable or disable Keepalive support. Valid values are `true` or `false`.	`true`
Keepalive Idle Timeout	`net.keepalive_idle_timeout`	Set maximum time allowed for an idle Keepalive connection.	`30s`
Max Connect Timeout	`net.connect_timeout`	Set maximum time allowed to establish a connection, which includes the TLS handshake.	`10s`
Max Connect Timeout Log Error	`net.connect_timeout_log_error`	On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message. Valid values are `true` or `false`.	`true`
Max Keepalive Recycle	`net.keepalive_max_recycle`	Set maximum number of times a keepalive connection can be used before it is retired.	`2000`
Source Address	`net.source_address`	Specify network address to bind for data traffic.	none

Basic Authentication

Name	Key	Description	Default
HTTP Username	`http_user`	Basic Auth Username.	none
HTTP Password	`http_password`	Basic Auth Password. Requires `http_user` to be set.	none

Example

The following YAML configuration defines a Fluent Bit input and a Chronosphere Logs output.

pipeline:
  inputs:
    - Name: forward
      alias: Fluent_Bit
      port: "5170"
      tls.verify: on
      tls.debug: "1"
      tag: forward.cb3bae48-0000-4a51-0000-f6ccd3f0ed0c
  filters:
    - Name: lua
      match: forward.cb3bae48-0000-4a51-0000-f6ccd3f0ed0c
      active: "false"
  outputs:
    - Name: http
      alias: Chronosphere
      host: MY_COMPANY.ingest.logs.chronosphere.io
      port: "443"
      header:
        - Authorization Bearer
          f31b...ed7t292
      uri: /api/v1/ingest/json
      format: json
      compress: on
      json_date_format: iso8601
      json_date_key: _time
      tls: true
      tls.verify: on
      tls.debug: "1"
      net.keepalive: true
      net.keepalive_idle_timeout: 30s
      net.connect_timeout: 10s
      net.connect_timeout_log_error: true
      net.keepalive_max_recycle: "2000"
      core.metadata:
        name: Chronosphere Logs ingest
      Match_Regex: .{0,}

Azure Sentinel Clickhouse