Logstash
Collect logs from a Logstash agent
status: beta
role: sidecar
role: aggregator
delivery: best effort
acknowledgements: yes
egress: stream
state: stateless
output: log
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "logstash",
"acknowledgements": null,
"address": "0.0.0.0:5044"
}
}
}
[sources.my_source_id]
type = "logstash"
address = "0.0.0.0:5044"
---
sources:
my_source_id:
type: logstash
acknowledgements: null
address: 0.0.0.0:5044
{
"sources": {
"my_source_id": {
"type": "logstash",
"acknowledgements": null,
"address": "0.0.0.0:5044",
"receive_buffer_bytes": 65536,
"keepalive": null,
"tls": null,
"connection_limit": null
}
}
}
[sources.my_source_id]
type = "logstash"
address = "0.0.0.0:5044"
receive_buffer_bytes = 65_536
---
sources:
my_source_id:
type: logstash
acknowledgements: null
address: 0.0.0.0:5044
receive_buffer_bytes: 65536
keepalive: null
tls: null
connection_limit: null
acknowledgements
common optional objectControls how acknowledgements are handled by this source. These settings override the global
acknowledgement
settings. This setting is deprecated in favor of enabling acknowledgements
in the destination sink.acknowledgements.enabled
optional boolControls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default:
false
connection_limit
optional uintThe max number of TCP connections that will be processed.
Relevant when:
mode = `tcp`
keepalive
optional objectConfigures the TCP keepalive behavior for the connection to the source.
keepalive.time_secs
optional uintThe time a connection needs to be idle before sending TCP keepalive probes.
receive_buffer_bytes
optional uintConfigures the receive buffer size using the
SO_RCVBUF
option on the socket.tls
optional objectConfigures the TLS options for incoming connections.
tls.ca_file
optional string literalAbsolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.
tls.crt_file
optional string literalAbsolute path to a certificate file used to identify this server, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive,
key_file
must also be set. This is required if enabled
is set to true
.tls.enabled
optional boolRequire TLS for incoming connections. If this is set, an identity certificate is also required.
default:
false
tls.key_file
optional string literalAbsolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.
tls.key_pass
optional string literalPass phrase used to unlock the encrypted key file. This has no effect unless
key_file
is set.tls.verify_certificate
optional boolIf
true
, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false
(the default), Vector will not request a certificate from the client.default:
false
Outputs
<component_id>
Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.
Output Data
Logs
Line
A Logstash message
*
required
string
literal
In addition to the defined fields, all fields from the Logstash message are inserted as root level fields.
Examples
hello world
host
required
string
literal
The IP address the Logstash message was sent from.
Examples
127.0.0.1
timestamp
required
timestamp
The timestamp field will be set to the first one found of the following:
- The
timestamp
field on the event - The
@timestamp
field on the event if it can be parsed as a timestamp - The current timestamp
The assigned field, timestamp
, could be different depending if you have configured
log_schema.timestamp_key
.
Examples
2020-10-10T17:07:36.452332Z
Telemetry
Metrics
linkcomponent_received_bytes_total
counterThe number of raw bytes accepted by this component from source origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_received_events_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_sent_event_bytes_total
counterThe total number of event bytes emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
component_sent_events_total
counterThe total number of events emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
connection_errors_total
counterThe total number of connection errors for this Vector instance.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
connection_send_ack_errors_total
counterThe total number of protocol acknowledgement errors for this Vector instance for source protocols that support acknowledgements.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
decode_errors_total
counterThe total number of decode errors seen when decoding data in a source component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
events_in_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
This metric is deprecated and will be removed in a future version.
Use
component_received_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
events_out_total
counterThe total number of events emitted by this component.
This metric is deprecated and will be removed in a future version.
Use
component_sent_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
open_connections
gaugeThe number of current open connections to Vector.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
processed_bytes_total
counterThe number of bytes processed by the component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the bytes originate.
file
optional
The file from which the bytes originate.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the bytes originate.
peer_path
optional
The pathname from which the bytes originate.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the bytes originate.
uri
optional
The sanitized URI from which the bytes originate.
processed_events_total
counterThe total number of events processed by this component.
This metric is deprecated in place of using
component_received_events_total
and
component_sent_events_total
metrics.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
Examples
Logstash message from generator input
Given this event...Logstash input config:
```text
input {
generator {
count => 1
}
}
```
Output if sent to stdout logstash output:
```text
{ "@version" => "1", "@timestamp" => 2021-06-14T20:57:14.230Z, "host" => "c082bb583445", "sequence" => 0, "message" => "Hello world!" }
```
[sources.my_source_id]
type = "logstash"
---
sources:
my_source_id:
type: logstash
{
"sources": {
"my_source_id": {
"type": "logstash"
}
}
}
{
"host": "34.33.222.212",
"line": "2021-06-14T20:57:14.230Z c082bb583445 hello world"
}
Message from Elastic Beat Heartbeat agent
Given this event...Heartbeat input config:
```yaml
heartbeat.config.monitors:
path: ${path.config}/monitors.d/*.yml
reload.enabled: false
reload.period: 5s
heartbeat.monitors:
- type: http
schedule: '@every 5s'
urls:
- http://google.com
```
Output if sent to stdout output:
```json
{"@timestamp":"2021-06-14T21:25:37.058Z","@metadata":{"beat":"heartbeat","type":"_doc","version":"7.12.1"},"url":{"full":"http://google.com","scheme":"http","domain":"google.com","port":80},"tcp":{"rtt":{"connect":{"us":18504}}},"event":{"dataset":"uptime"},"ecs":{"version":"1.8.0"},"resolve":{"rtt":{"us":7200},"ip":"172.217.4.174"},"summary":{"up":1,"down":0},"http":{"response":{"mime_type":"text/html; charset=utf-8","headers":{"Content-Length":"219","Date":"Mon, 14 Jun 2021 21:25:37 GMT","Server":"gws","X-Xss-Protection":"0","Location":"http://www.google.com/","Expires":"Wed, 14 Jul 2021 21:25:37 GMT","Content-Type":"text/html; charset=UTF-8","Cache-Control":"public, max-age=2592000","X-Frame-Options":"SAMEORIGIN"},"status_code":301,"body":{"hash":"2178eedd5723a6ac22e94ec59bdcd99229c87f3623753f5e199678242f0e90de","bytes":219}},"rtt":{"response_header":{"us":51481},"validate":{"us":52664},"content":{"us":1182},"total":{"us":71585},"write_request":{"us":134}}},"monitor":{"type":"http","status":"up","duration":{"us":79517},"check_group":"0c8c908a-cd57-11eb-85a4-025000000001","ip":"172.217.4.174","timespan":{"gte":"2021-06-14T21:25:37.137Z","lt":"2021-06-14T21:25:42.137Z"},"id":"auto-http-0X993E1F882355CFD2","name":""},"agent":{"hostname":"docker-desktop","ephemeral_id":"9e15e5bc-86d6-4d47-9067-4262b00c5cce","id":"404c8975-a41b-45bd-8d93-3f6c4449e973","name":"docker-desktop","type":"heartbeat","version":"7.12.1"}}
```
[sources.my_source_id]
type = "logstash"
---
sources:
my_source_id:
type: logstash
{
"sources": {
"my_source_id": {
"type": "logstash"
}
}
}
{
"@metadata": {
"beat": "heartbeat",
"type": "_doc",
"version": "7.12.1"
},
"@timestamp": "2021-06-14T21:25:37.058Z",
"agent": {
"ephemeral_id": "9e15e5bc-86d6-4d47-9067-4262b00c5cce",
"hostname": "docker-desktop",
"id": "404c8975-a41b-45bd-8d93-3f6c4449e973",
"name": "docker-desktop",
"type": "heartbeat",
"version": "7.12.1"
},
"ecs": {
"version": "1.8.0"
},
"event": {
"dataset": "uptime"
},
"host": "34.33.222.212",
"http": {
"response": {
"body": {
"bytes": 219,
"hash": "2178eedd5723a6ac22e94ec59bdcd99229c87f3623753f5e199678242f0e90de"
},
"headers": {
"Cache-Control": "public, max-age=2592000",
"Content-Length": "219",
"Content-Type": "text/html; charset=UTF-8",
"Date": "Mon, 14 Jun 2021 21:25:37 GMT",
"Expires": "Wed, 14 Jul 2021 21:25:37 GMT",
"Location": "http://www.google.com/",
"Server": "gws",
"X-Frame-Options": "SAMEORIGIN",
"X-Xss-Protection": "0"
},
"mime_type": "text/html; charset=utf-8",
"status_code": 301
},
"rtt": {
"content": {
"us": 1182
},
"response_header": {
"us": 51481
},
"total": {
"us": 71585
},
"validate": {
"us": 52664
},
"write_request": {
"us": 134
}
}
},
"monitor": {
"check_group": "0c8c908a-cd57-11eb-85a4-025000000001",
"duration": {
"us": 79517
},
"id": "auto-http-0X993E1F882355CFD2",
"ip": "172.217.4.174",
"name": "",
"status": "up",
"timespan": {
"gte": "2021-06-14T21:25:37.137Z",
"lt": "2021-06-14T21:25:42.137Z"
},
"type": "http"
},
"resolve": {
"ip": "172.217.4.174",
"rtt": {
"us": 7200
}
},
"summary": {
"down": 0,
"up": 1
},
"tcp": {
"rtt": {
"connect": {
"us": 18504
}
}
},
"timestamp": "2021-06-14T21:25:37.058Z",
"url": {
"domain": "google.com",
"full": "http://google.com",
"port": 80,
"scheme": "http"
}
}
How it works
Acknowledgement support
Currently, this source will acknowledge events to the sender once the event has been sent to the next
component in the topology. In the future, this source will utilize Vector’s support for end-to-end
acknowledgements.
Sending data from logstash agents to Vector aggregators
If you are already running an Elastic agent (Logstash or Elastic Beats) in your infrastructure, this
source can make it easy to start getting that data into Vector.
Elastic Beats configuration
To configure one of the Elastic Beats agents to forward to a Vector instance, you can use the following output configuration:
output.logstash:
# update these to point to your vector instance
hosts: ["127.0.0.1:5044"]
Logstash configuration
To configure Logstash to forward to a Vector instance, you can use the following output configuration:
output {
lumberjack {
# update these to point to your vector instance
hosts => ["127.0.0.1"]
port => 5044
ssl_certificate => "/path/to/certificate.crt"
}
}
Note that Logstash requires SSL to be configured.
Transport Layer Security (TLS)
Vector uses OpenSSL for TLS protocols. You can
adjust TLS behavior via the
tls.*
options.