Skip to content

Commit

Permalink
docs(sumologicexporter): deprecate endpoint and add configuration wit…
Browse files Browse the repository at this point in the history
…h extension (#169)

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>
  • Loading branch information
sumo-drosiek authored Aug 27, 2021
1 parent aa4ff00 commit e38ff8e
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion pkg/exporter/sumologicexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

This exporter supports sending logs and metrics data to [Sumo Logic](https://www.sumologic.com/).

We are strongly recommend to use this exporter with [sumologicextension](../../extension/sumologicextension/README.md).

Configuration is specified via the yaml in the following structure:

```yaml
exporters:
# ...
sumologic:
# unique URL generated for your HTTP Source, this is the address to send data to
# (required, unless configured with sumologicextension)
# deprecated, please use sumologicextension to manage your endpoints
# if sumologicextension is not being used, the endpoint is required
endpoint: <HTTP_Source_URL>
# Compression encoding format, empty string means no compression, default = gzip
compress_encoding: {gzip, deflate, ""}
Expand Down Expand Up @@ -171,6 +174,39 @@ For example, `%{existing_attr}/%{nonexistent_attr}` becomes `value-of-existing-a

## Example Configuration

### Example with sumologicextension

```yaml
extensions:
sumologic:
access_id: aaa
access_key: bbbbbbbbbbbbbbbbbbbbbb
collector_name: my_collector
receivers:
hostmetrics:
collection_interval: 30s
scrapers:
load:
exporters:
sumologic:
source_category: "custom category"
source_name: "custom name"
source_host: "custom host"
metadata_attributes:
- k8s.*
service:
extensions: [sumologic]
pipelines:
metrics:
receivers: [hostmetrics]
exporters: [sumologic]
```

### Example without sumologicextension

```yaml
exporters:
sumologic:
Expand Down

0 comments on commit e38ff8e

Please sign in to comment.