SC-20508 Add sematext exporter #2
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Sematext Exporter | ||
| <!-- status autogenerated section --> | ||
| <!-- end autogenerated section --> | ||
|
|
||
| This exporter supports sending metrics to [Sematext Cloud](https://sematext.com/) in Influx line protocol format | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following configuration options are supported: | ||
|
|
||
| * `endpoint` (required) HTTP/S destination for metric receivers. It is dependent on the region: | ||
| - US: `spm-receiver.sematext.com` | ||
| - EU: `spm-receiver.eu.sematext.com` | ||
| * `timeout` (default = 5s) Timeout for requests | ||
| * `AppToken` App token is the token of Sematext Monitoring App to which you want to send the metrics. | ||
| * `Region` Region specifies the Sematext region the user is operating in; must be one of: | ||
Eromosele-SM marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * `US` | ||
| * `EU` | ||
| * `payload_max_lines` (default = 10_000) Maximum number of lines allowed per HTTP POST request | ||
| * `payload_max_bytes` (default = 10_000_000) Maximum number of bytes allowed per HTTP POST request | ||
|
There was a problem hiding this comment. @Eromosele-SM I'd check these defaults internally with Sematext first. There was a problem hiding this comment. There was a problem hiding this comment. That's the suggest for custom metrics. I'd ask STA devs what STA uses. |
||
| * `metrics_schema` (default = telegraf-prometheus-v2) The chosen metrics schema to write; must be one of: | ||
| * `otel-v1` | ||
| * `telegraf-prometheus-v2` | ||
|
There was a problem hiding this comment. @Eromosele-SM probably only one schema in the end. Also, this Exporter will end up shipping telemetry other than metrics. So maybe you want to structure the README in preparation for that. For example, this particular schema will be only for metrics. There was a problem hiding this comment. I can always edit the readme when we have logs support ready? There was a problem hiding this comment. Ofc. I hope the YAML is also structured in anticipation of Exporter sending other telemetry later (so other App tokens, other endpoints, although the region could probably remain general). |
||
| * `sending_queue` [details here](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.25.0/exporter/exporterhelper/README.md#configuration) | ||
| * `enabled` (default = true) | ||
| * `num_consumers` (default = 10) The number of consumers from the queue | ||
| * `queue_size` (default = 1000) Maximum number of batches allowed in queue at a given time | ||
| * `retry_on_failure` [details here](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.25.0/exporter/exporterhelper/README.md#configuration) | ||
| * `enabled` (default = true) | ||
| * `initial_interval` (default = 5s) Time to wait after the first failure before retrying | ||
| * `max_interval` (default = 30s) Upper bound on backoff interval | ||
| * `max_elapsed_time` (default = 120s) Maximum amount of time (including retries) spent trying to send a request/batch | ||
|
|
||
| The full list of settings exposed for this exporter are documented in [config.go](config.go). | ||
|
|
||
| Example: | ||
| ```yaml | ||
| endpoint: spm-receiver.sematext.com | ||
| timeout: 500ms | ||
| sending_queue: | ||
| enabled: true | ||
| num_consumers: 3 | ||
| queue_size: 10 | ||
| retry_on_failure: | ||
| enabled: true | ||
| initial_interval: 1s | ||
| max_interval: 3s | ||
| max_elapsed_time: 10s | ||
| region: US | ||
| app_token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| metrics_schema: telegraf-prometheus-v2 | ||
| payload_max_lines: 100 | ||
| payload_max_bytes: 1000 | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Eromosele-SM make it match STA timeout?