Sematext metrics
Publish metric events to Sematext
Warnings
counter
and gauge
metrics are supported. If you’d like to ingest other
metric types please consider using the metric_to_log
transform
with the sematext_logs
sink.Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "sematext_metrics",
"inputs": [
"my-source-or-transform-id"
],
"region": "us",
"default_namespace": "service",
"acknowledgements": null,
"encoding": null,
"healthcheck": null,
"token": "${SEMATEXT_TOKEN}"
}
}
}
[sinks.my_sink_id]
type = "sematext_metrics"
inputs = [ "my-source-or-transform-id" ]
region = "us"
default_namespace = "service"
token = "${SEMATEXT_TOKEN}"
---
sinks:
my_sink_id:
type: sematext_metrics
inputs:
- my-source-or-transform-id
region: us
default_namespace: service
acknowledgements: null
encoding: null
healthcheck: null
token: ${SEMATEXT_TOKEN}
{
"sinks": {
"my_sink_id": {
"type": "sematext_metrics",
"inputs": [
"my-source-or-transform-id"
],
"endpoint": "http://127.0.0.1",
"region": "us",
"default_namespace": "service",
"buffer": null,
"acknowledgements": null,
"batch": null,
"encoding": null,
"healthcheck": null,
"proxy": null,
"token": "${SEMATEXT_TOKEN}"
}
}
}
[sinks.my_sink_id]
type = "sematext_metrics"
inputs = [ "my-source-or-transform-id" ]
endpoint = "http://127.0.0.1"
region = "us"
default_namespace = "service"
token = "${SEMATEXT_TOKEN}"
---
sinks:
my_sink_id:
type: sematext_metrics
inputs:
- my-source-or-transform-id
endpoint: http://127.0.0.1
region: us
default_namespace: service
buffer: null
acknowledgements: null
batch: null
encoding: null
healthcheck: null
proxy: null
token: ${SEMATEXT_TOKEN}
acknowledgements
common optional objectacknowledgement
settings.acknowledgements.enabled
common optional boolfalse
batch
optional objectbatch.max_bytes
common optional uintbatch.max_events
common optional uintbatch.timeout_secs
common optional float1
(seconds)buffer
optional objectbuffer.max_events
common optional uinttype = "memory"
500
(events)buffer.max_size
required uintThe maximum size of the buffer on the disk. Must be at least 128 megabytes (134217728 bytes).
Note that during normal disk buffer operation, the disk buffer can create one additional 128 megabyte block so the minimum disk space required is actually 256 megabytes.
type = "disk"
buffer.type
common optional string literal enumOption | Description |
---|---|
disk | Stores the sink’s buffer on disk. This is less performant, but durable. Data will not be lost between restarts. Will also hold data in memory to enhance performance. WARNING: This may stall the sink if disk performance isn’t on par with the throughput. For comparison, AWS gp2 volumes are usually too slow for common cases. |
memory | Stores the sink’s buffer in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully. |
memory
buffer.when_full
optional string literal enumOption | Description |
---|---|
block | Applies back pressure when the buffer is full. This prevents data loss, but will cause data to pile up on the edge. |
drop_newest | Drops new data as it’s received. This data is lost. This should be used when performance is the highest priority. |
block
default_namespace
required string literalencoding
common optional objectConfigures the encoding specific sink behavior.
Note: When data in encoding
is malformed, currently only a very generic error “data did not match any variant of untagged enum EncodingConfig” is reported. Follow this issue to track progress on improving these error messages.
encoding.except_fields
optional [string]encoding.only_fields
optional [string]encoding.timestamp_format
optional string literal enumOption | Description |
---|---|
rfc3339 | Formats as a RFC3339 string |
unix | Formats as a unix timestamp |
rfc3339
healthcheck
common optional objecthealthcheck.enabled
common optional booltrue
inputs
required [string]A list of upstream source or transform
IDs. Wildcards (*
) are supported.
See configuration for more info.
proxy
optional objectproxy.http
optional string literalproxy.https
optional string literalproxy.no_proxy
optional [string]A list of hosts to avoid proxying. Allowed patterns here include:
Pattern | Example match |
---|---|
Domain names | example.com matches requests to example.com |
Wildcard domains | .example.com matches requests to example.com and its subdomains |
IP addresses | 127.0.0.1 matches requests to 127.0.0.1 |
CIDR blocks | 192.168.0.0./16 matches requests to any IP addresses in this range |
Splat | * matches all hosts |
region
required string literal enumOption | Description |
---|---|
eu | Europe |
us | United States |
endpoint is not set
token
required string literalTelemetry
Metrics
linkbuffer_byte_size
gaugecomponent_id
instead. The value is the same as component_id
.buffer_discarded_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_events
gaugecomponent_id
instead. The value is the same as component_id
.buffer_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_received_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.component_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_events_count
histogramcomponent_id
instead. The value is the same as component_id
.component_received_events_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.encode_errors_total
counterevents_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.processing_errors_total
countercomponent_id
instead. The value is the same as component_id
.utilization
gaugecomponent_id
instead. The value is the same as component_id
.How it works
Buffers and batches
This component buffers & batches data as shown in the diagram above. You’ll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.
Batches are flushed when 1 of 2 conditions are met:
- The batch age meets or exceeds the configured
timeout_secs
. - The batch size meets or exceeds the configured
max_bytes
ormax_events
.
Buffers are controlled via the buffer.*
options.
Health checks
Require health checks
If you’d like to exit immediately upon a health check failure, you can pass the
--require-healthy
flag:
vector --config /etc/vector/vector.toml --require-healthy
Disable health checks
healthcheck
option to
false
.