From 4290622f3d42be83d2721d358f7c706a99542306 Mon Sep 17 00:00:00 2001 From: Dominik Rosiek <58699848+sumo-drosiek@users.noreply.github.com> Date: Thu, 16 Jul 2020 12:35:26 +0200 Subject: [PATCH] Add information about building the endpoint variable names (#771) * 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 --- deploy/docs/Terraform.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/deploy/docs/Terraform.md b/deploy/docs/Terraform.md index b8943bb146..e35a180973 100644 --- a/deploy/docs/Terraform.md +++ b/deploy/docs/Terraform.md @@ -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`, +where `` and `` 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)