Skip to content

Commit

Permalink
Add information about building the endpoint variable names (#771)
Browse files Browse the repository at this point in the history
* Add information about building the endpoint variable names

Co-authored-by: Marcin Stozek <58700054+perk-sumo@users.noreply.github.com>
Co-authored-by: David Duke <drduke1@gmail.com>
  • Loading branch information
3 people authored Jul 16, 2020
1 parent 428c227 commit 4290622
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions deploy/docs/Terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ sumologic:
# ref: https://www.terraform.io/docs/providers/sumologic/r/collector.html
```

### Usage

Source endpoints are exposed in FluentD and the OpenTelemetry collector as environmental variables.
The variable name is built using the schema `SUMO_ENDPOINT_<source name>_<source type>_SOURCE`,
where `<source name>` and `<source type>` are in uppercase and dashes are replaced with underscores.

Examples:
- `sumologic.sources.logs.example-source` becomes `SUMO_ENDPOINT_EXAMPLE_SOURCE_LOGS_SOURCE`
- `sumologic.sources.traces.default` becomes `SUMO_ENDPOINT_DEFAULT_TRACES_SOURCE`

### Properties

You can set all of the source [properties](https://www.terraform.io/docs/providers/sumologic/r/http_source.html#argument-reference)
Expand Down

0 comments on commit 4290622

Please sign in to comment.