Complimentary Gartner® Report! 'A CTO's Guide to Open-Source Software: Answering the Top 10 FAQs.'Read more

Sumo Logic

warning

This destination has been deprecated and replaced with a new Sumo Logic destination. While it will continue to function, it will no longer receive any enhancements and you should migrate to the new destination. For more information about the new destination, see this documentation.

Description

This Sumo Logic destination can be configured to send logs and metrics data to a Sumo Logic HTTP logs and metrics source.

Prerequisites

A pre-existing Sumo Logic HTTP logs and metrics source needs to be configured for the exporter to work. Read more.

Supported Types

LogsMetricsTracesBindplane Agent
v1.37.0+

Configuration

FieldDescription
Choose Telemetry TypeSelect which types of telemetry to export. Logs and metrics are supported.
EndpointEndpoint for the Sumo Logic HTTP logs and metrics source. See the Sumo Logic documentation for more information.
CompressionCompression algorithm to use when sending data to Sumo Logic.
Max Request Body SizeMaximum HTTP request body size in bytes (1048576 = 1MiB) before compression is applied.
Metadata AttributesList of regex(s) for attributes that should be sent as metadata.
Log FormatFormat to send logs in to Sumo Logic. Available formats are JSON and text.
Metric FormatFormat to send metrics in to Sumo Logic. See the Sumo Logic documentation for more information.
Graphite TemplateAvailable when Metric Format is set to graphite. Template to be used for metric names. Default is just the metric name which is templated as %{_metric_}.
Source CategoryTemplate that overrides the source category label configured for the Sumo Logic HTTP logs and metrics source.
Source NameTemplate that overrides the source name label configured for the Sumo Logic HTTP logs and metrics source.
Source HostTemplate that overrides the source host label configured for the Sumo Logic HTTP logs and metrics source.
TimeoutTimeout limit for each attempt to send data to Sumo Logic in seconds. Maximum timeout limit is 55s.

note

For more information on the templated fields (graphite, source category, source name, and source host) refer to the exporter documentation for more information.

This destination supports the following retry and queuing settings:

Sending QueuePersistent QueueRetry on Failure

Example Configuration

The following example configuration will send logs and metrics. Default compression and max request body size will be used. Logs will be sent as JSON and metrics will be sent as Graphite and utilize the Graphite template to alter the metric names. The source host template will be used as well to override the one on the Sumo Logic HTTP logs and metrics source. Sending and persistent queues will be used as well as retry on failure.

Web Interface

observIQ docs - Sumo Logic Destination - image 1
observIQ docs - Sumo Logic Destination - image 2

Standalone Destination

yaml
1apiVersion: bindplane.observiq.com/v1
2kind: Destination
3metadata:
4  id: sumo_logic
5  name: sumo_logic
6spec:
7  type: sumo_logic
8  parameters:
9    - name: telemetry_types
10      value: ['Logs', 'Metrics']
11    - name: endpoint
12      value: 'https://host:1234/some/endpoint/for/sumo-logic'
13    - name: compression
14      value: 'gzip'
15    - name: max_request_body_size
16      value: '1048576'
17    - name: log_format
18      value: 'json'
19    - name: metric_format
20      value: 'graphite'
21    - name: graphite_template
22      value: 'graphite_metric_%{_metric_}'
23    - name: source_host
24      value: 'my_new_source_host_name'
25    - name: sending_queue_enabled
26      value: 'true'
27    - name: persistent_queue_enabled
28      value: 'true'
29    - name: retry_on_failure_enabled
30      value: 'true'