-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ed09990
commit b2bc999
Showing
1 changed file
with
61 additions
and
0 deletions.
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,61 @@ | ||
# Sematext Exporter | ||
<!-- status autogenerated section --> | ||
| Status | | | ||
| ------------- |-----------| | ||
| Stability | [development]: metrics | | ||
| Distributions | [contrib] | | ||
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aexporter%2Fsematext%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aexporter%2Fsematext) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aexporter%2Fsematext%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aexporter%2Fsematext) | | ||
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@Eromosele-SM](https://www.github.com/Eromosele-SM) | | ||
|
||
[development]: https://github.com/open-telemetry/opentelemetry-collector#development | ||
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib | ||
<!-- 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 specifies the token of Sematext Monitoring App to which the user wants to send metrics to. | ||
* `Region` Region specifies the Sematext region the user is operating in; must be one of: | ||
* `US` | ||
* `EU` | ||
* `payload_max_lines` (default = 1_000) Maximum number of lines allowed per HTTP POST request | ||
* `payload_max_bytes` (default = 300_000) Maximum number of bytes allowed per HTTP POST request | ||
* `metrics_schema` (default = telegraf-prometheus-v2) The chosen metrics schema to write | ||
* `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 | ||
``` |