Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sumologic/fluentd-output-sumologic

Fluentd output plugin to deliver logs or metrics to Sumo Logic.
https://github.com/sumologic/fluentd-output-sumologic

fluentd-output-plugin sumologic sumologic-collector

Last synced: 4 days ago
JSON representation

Fluentd output plugin to deliver logs or metrics to Sumo Logic.

Host: GitHub
URL: https://github.com/sumologic/fluentd-output-sumologic
Owner: SumoLogic
License: apache-2.0
Created: 2016-12-09T02:27:12.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2024-02-14T13:21:40.000Z (11 months ago)
Last Synced: 2024-04-14T06:09:12.880Z (9 months ago)
Topics: fluentd-output-plugin, sumologic, sumologic-collector
Language: Ruby
Homepage: https://rubygems.org/gems/fluent-plugin-sumologic_output
Size: 132 KB
Stars: 28
Watchers: 36
Forks: 28
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

[![Build Status](https://travis-ci.org/SumoLogic/fluentd-output-sumologic.svg?branch=master)](https://travis-ci.org/SumoLogic/fluentd-output-sumologic) [![Gem Version](https://badge.fury.io/rb/fluent-plugin-sumologic_output.svg)](https://badge.fury.io/rb/fluent-plugin-sumologic_output) ![](https://ruby-gem-downloads-badge.herokuapp.com/fluent-plugin-sumologic_output?type=total) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/SumoLogic/fluentd-output-sumologic/issues)

# fluent-plugin-sumologic_output, a plugin for [Fluentd](http://fluentd.org)

This plugin has been designed to output logs or metrics to [SumoLogic](http://www.sumologic.com) via a [HTTP collector endpoint](http://help.sumologic.com/Send_Data/Sources/02Sources_for_Hosted_Collectors/HTTP_Source)

## License
Released under Apache 2.0 License.

## Installation

gem install fluent-plugin-sumologic_output

## Configuration

Configuration options for fluent.conf are:

* `data_type` - The type of data that will be sent to Sumo Logic, either `logs` or `metrics` (Default is `logs `)
* `endpoint` - SumoLogic HTTP Collector URL
* `verify_ssl` - Verify ssl certificate. (default is `true`)
* `source_category`^* - Set _sourceCategory metadata field within SumoLogic (default is `nil`)
* `source_name`^* - Set _sourceName metadata field within SumoLogic - overrides source_name_key (default is `nil`)
* `source_name_key` - Set as source::path_key's value so that the source_name can be extracted from Fluentd's buffer (default `source_name`)
* `source_host`^* - Set _sourceHost metadata field within SumoLogic (default is `nil`)
* `log_format` - Format to post logs into Sumo. (default `json`)
* text - Logs will appear in SumoLogic in text format (taken from the field specified in `log_key`)
* json - Logs will appear in SumoLogic in json format.
* json_merge - Same as json but merge content of `log_key` into the top level and strip `log_key`
* `log_key` - Used to specify the key when merging json or sending logs in text format (default `message`)
* `open_timeout` - Set timeout seconds to wait until connection is opened.
* `receieve_timeout` - Set timeout seconds to wait for a response from SumoLogic in seconds. Don't modify unless you see `HTTPClient::ReceiveTimeoutError` in your Fluentd logs.
* `send_timeout` - Timeout for sending to SumoLogic in seconds. Don't modify unless you see `HTTPClient::SendTimeoutError` in your Fluentd logs. (default `120`)
* `add_timestamp` - Add `timestamp` (or `timestamp_key`) field to logs before sending to sumologic (default `true`)
* `timestamp_key` - Field name when `add_timestamp` is on (default `timestamp`)
* `proxy_uri` - Add the `uri` of the `proxy` environment if present.
* `metric_data_format` - The format of metrics you will be sending, either `graphite` or `carbon2` or `prometheus` (Default is `graphite `)
* `disable_cookies` - Option to disable cookies on the HTTP Client. (Default is `false `)
* `compress` - Option to enable compression (default `true`)
* `compress_encoding` - Compression encoding format, either `gzip` or `deflate` (default `gzip`)
* `custom_fields` - Comma-separated key=value list of fields to apply to every log. [more information](https://help.sumologic.com/Manage/Fields#http-source-fields)
* `custom_dimensions` - Comma-separated key=value list of dimensions to apply to every metric. [more information](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/HTTP-Source/Upload-Metrics-to-an-HTTP-Source#supported-http-headers)
* `use_internal_retry` - Enable custom retry mechanism. As this is `false` by default due to backward compatibility,
we recommend to enable it and configure the following parameters (`retry_min_interval`, `retry_max_interval`, `retry_timeout`, `retry_max_times`)
* `retry_min_interval` - Minimum interval to wait between sending tries (default is `1s`)
* `retry_max_interval` - Maximum interval to wait between sending tries (default is `5m`)
* `retry_timeout` - Time after which the data is going to be dropped (default is `72h`) (`0s` means that there is no timeout)
* `retry_max_times` - Maximum number of retries (default is `0`) (`0` means that there is no max retry times, retries will happen forever)
* `max_request_size` - Maximum request size (before applying compression). Default is `0k` which means no limit

__NOTE:__ ^* [Placeholders](https://docs.fluentd.org/v1.0/articles/buffer-section#placeholders) are supported

### Example Configuration
Reading from the JSON formatted log files with `in_tail` and wildcard filenames:
```

@type tail
format json
time_key time
path /path/to/*.log
pos_file /path/to/pos/ggcp-app.log.pos
time_format %Y-%m-%dT%H:%M:%S.%NZ
tag appa.*
read_from_head false

@type sumologic
endpoint https://collectors.sumologic.com/receiver/v1/http/XXXXXXXXXX
log_format json
source_category prod/someapp/logs
source_name AppA
open_timeout 10

```

Sending metrics to Sumo Logic using `in_http`:
```

@type http
port 8888
bind 0.0.0.0

@type sumologic
endpoint https://endpoint3.collection.us2.sumologic.com/receiver/v1/http/ZaVnC4dhaV1hYfCAiqSH-PDY6gUOIgZvO60U_-y8SPQfK0Ks-ht7owrbk1AkX_ACp0uUxuLZOCw5QjBg1ndVPZ5TOJCFgNGRtFDoTDuQ2hzs3sn6FlfBSw==
data_type metrics
metric_data_format carbon2
flush_interval 1s

```

## Example input/output

Assuming following inputs are coming from a log file named `/var/log/appa_webserver.log`
```
{"asctime": "2016-12-10 03:56:35+0000", "levelname": "INFO", "name": "appa", "funcName": "do_something", "lineno": 29, "message": "processing something", "source_ip": "123.123.123.123"}
```

Then output becomes as below within SumoLogic
```
{
"timestamp":1481343785000,
"asctime":"2016-12-10 03:56:35+0000",
"levelname":"INFO",
"name":"appa",
"funcName":"do_something",
"lineno":29,
"message":"processing something",
"source_ip":"123.123.123.123"
}
```

## Dynamic Configuration within log message

The plugin supports overriding SumoLogic metadata and log_format parameters within each log message by attaching the field `_sumo_metadata` to the log message.

NOTE: The `_sumo_metadata` field will be stripped before posting to SumoLogic.

Example

```
{
"name": "appa",
"source_ip": "123.123.123.123",
"funcName": "do_something",
"lineno": 29,
"asctime": "2016-12-10 03:56:35+0000",
"message": "processing something",
"_sumo_metadata": {
"category": "new_sourceCategory",
"source": "override_sourceName",
"host": "new_sourceHost",
"log_format": "merge_json_log"
},
"levelname": "INFO"
}
```

## Retry Mechanism

`retry_min_interval`, `retry_max_interval`, `retry_timeout`, `retry_max_times` are not the [buffer retries parameters][buffer_retries].
Due to technical reason, this plugin implements it's own retrying back-off exponential mechanism.
It is disabled by default, but we recommend to enable it by setting `use_internal_retry` to `true`.

[buffer_retries]: https://docs.fluentd.org/configuration/buffer-section#retries-parameters

### TLS 1.2 Requirement

Sumo Logic only accepts connections from clients using TLS version 1.2 or greater. To utilize the content of this repo, ensure that it's running in an execution environment that is configured to use TLS 1.2 or greater.