GCP Operations (formerly Stackdriver) logs
Deliver logs to GCP’s Cloud Operations suite
Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "gcp_stackdriver_logs",
"inputs": [
"my-source-or-transform-id"
],
"credentials_path": "/path/to/credentials.json",
"log_id": "vector-logs",
"project_id": "vector-123456",
"resource": {
"type": "gce_instance",
"instance_id": "Twilight",
"zone": "us-central1-a"
},
"acknowledgements": null,
"encoding": null,
"healthcheck": null
}
}
}
[sinks.my_sink_id]
type = "gcp_stackdriver_logs"
inputs = [ "my-source-or-transform-id" ]
credentials_path = "/path/to/credentials.json"
log_id = "vector-logs"
project_id = "vector-123456"
[sinks.my_sink_id.resource]
type = "gce_instance"
instance_id = "Twilight"
zone = "us-central1-a"
---
sinks:
my_sink_id:
type: gcp_stackdriver_logs
inputs:
- my-source-or-transform-id
credentials_path: /path/to/credentials.json
log_id: vector-logs
project_id: vector-123456
resource:
type: gce_instance
instance_id: Twilight
zone: us-central1-a
acknowledgements: null
encoding: null
healthcheck: null
{
"sinks": {
"my_sink_id": {
"type": "gcp_stackdriver_logs",
"inputs": [
"my-source-or-transform-id"
],
"billing_account_id": "012345-6789AB-CDEF01",
"credentials_path": "/path/to/credentials.json",
"folder_id": "My Folder",
"log_id": "vector-logs",
"organization_id": "622418129737",
"project_id": "vector-123456",
"resource": {
"type": "gce_instance",
"instance_id": "Twilight",
"zone": "us-central1-a"
},
"buffer": null,
"acknowledgements": null,
"batch": null,
"encoding": null,
"healthcheck": null,
"request": null,
"tls": null,
"proxy": null,
"severity_key": "severity"
}
}
}
[sinks.my_sink_id]
type = "gcp_stackdriver_logs"
inputs = [ "my-source-or-transform-id" ]
billing_account_id = "012345-6789AB-CDEF01"
credentials_path = "/path/to/credentials.json"
folder_id = "My Folder"
log_id = "vector-logs"
organization_id = "622418129737"
project_id = "vector-123456"
severity_key = "severity"
[sinks.my_sink_id.resource]
type = "gce_instance"
instance_id = "Twilight"
zone = "us-central1-a"
---
sinks:
my_sink_id:
type: gcp_stackdriver_logs
inputs:
- my-source-or-transform-id
billing_account_id: 012345-6789AB-CDEF01
credentials_path: /path/to/credentials.json
folder_id: My Folder
log_id: vector-logs
organization_id: "622418129737"
project_id: vector-123456
resource:
type: gce_instance
instance_id: Twilight
zone: us-central1-a
buffer: null
acknowledgements: null
batch: null
encoding: null
healthcheck: null
request: null
tls: null
proxy: null
severity_key: severity
acknowledgements
common optional objectacknowledgement
settings.acknowledgements.enabled
optional boolfalse
batch
optional objectbatch.max_bytes
optional uintbatch.max_events
optional uintbatch.timeout_secs
optional float1
(seconds)billing_account_id
optional string literalThe billing account ID to which to publish logs.
Exactly one of must be set: billing_account_id
, folder_id
, organization_id
,
or project_id
.
buffer
optional objectbuffer.max_events
optional uinttype = "memory"
500
(events)buffer.type
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
credentials_path
common optional string literalThe filename for a Google Cloud service account credentials JSON file used to authenticate access to the
Stackdriver Logging API. If this is unset, Vector checks the GOOGLE_APPLICATION_CREDENTIALS
environment variable for a filename.
If no filename is named, Vector attempts to fetch an instance service account for the compute instance the program is running on. If Vector is not running on a GCE instance, you must define a credentials file as above.
encoding
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
folder_id
optional string literalThe folder ID to which to publish logs.
See the Google Cloud Platform folder documentation for more details.
Exactly one of billing_account_id
, folder_id
, organization_id
, or project_id
must be set.
inputs
required [string]A list of upstream source or transform
IDs. Wildcards (*
) are supported.
See configuration for more info.
log_id
required string templateorganization_id
optional string literalThe organization ID to which to publish logs. This would be the identifier assigned to your organization on Google Cloud Platform.
Exactly one of billing_account_id
, folder_id
, organization_id
, or project_id
must be set.
project_id
required string literalThe project ID to which to publish logs. See the Google Cloud Platform project management documentation for more details.
Exactly one of billing_account_id
, folder_id
, organization_id
, or project_id
must be set.
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 |
request
optional objectrequest.adaptive_concurrency
optional objectrequest.adaptive_concurrency.decrease_ratio
optional float0.9
request.adaptive_concurrency.ewma_alpha
optional float0.7
request.adaptive_concurrency.rtt_deviation_scale
optional float2
request.concurrency
optional uintrequest.rate_limit_duration_secs
optional uintrate_limit_num
option.1
(seconds)request.rate_limit_num
optional uintrate_limit_duration_secs
time window.1000
request.retry_attempts
optional uint1.8446744073709552e+19
request.retry_initial_backoff_secs
optional uint1
(seconds)request.retry_max_duration_secs
optional uint3600
(seconds)request.timeout_secs
optional uint60
(seconds)resource
required objectresource.*
optional string templateValues for all of the labels listed in the associated monitored resource descriptor.
For example, Compute Engine VM instances use the labels instance_id
and zone
.
resource.type
optional string literalThe monitored resource type. For example, the type of a Compute Engine VM instance is
gce_instance
.
See the Google Cloud Platform monitored resource documentation for more details.
severity_key
optional string literalThe field of the log event from which to take the outgoing log’s severity
field. The named field is
removed from the log event if present, and must be either an integer between 0 and 800 or a string
containing one of the severity level names (case is ignored) or a
common prefix such as err
.
If no severity key is specified, the severity of outgoing records is set to 0 (DEFAULT
).
See the GCP Stackdriver Logging LogSeverity description for more
details on the value of the severity
field.
tls
optional objecttls.ca_file
optional string literaltls.crt_file
optional string literalkey_file
must also be set.tls.key_file
optional string literalcrt_file
must also be set.tls.key_pass
optional string literalkey_file
is set.tls.verify_certificate
optional booltrue
(the default), Vector will validate the TLS certificate of the remote host.true
tls.verify_hostname
optional booltrue
(the default), Vector will validate the configured remote host name against the remote host’s TLS certificate. Do NOT set this to false
unless you understand the risks of not verifying the remote hostname.true
Environment variables
GOOGLE_APPLICATION_CREDENTIALS
common optional 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_bytes_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
.events_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.events_out_total
countercomponent_sent_events_total
instead.component_id
instead. The value is the same as component_id
.utilization
gaugecomponent_id
instead. The value is the same as component_id
.Permissions
Policy | Required for | Required when |
---|---|---|
logging.logEntries.create |
|
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.
GCP Authentication
GCP offers a variety of authentication methods and Vector is concerned with the server to server methods and will find credentials in the following order:
- If the
credentials_path
option is set. - If the
api_key
option is set. - If the
GOOGLE_APPLICATION_CREDENTIALS
environment variable is set. - Finally, Vector will check for an instance service account.
If credentials aren’t found, Vector’s health checks fail and an error is logged.
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
.Partitioning
Vector supports dynamic configuration values through a simple template syntax. If an option supports templating, it will be noted with a badge and you can use event fields to create dynamic values. For example:
[sinks.my-sink]
dynamic_option = "application={{ application_id }}"
In the above example, the application_id
for each event will be
used to partition outgoing data.
Rate limits & adaptive concurrency
Adaptive Request Concurrency (ARC)
Adaptive Request Concurrency is a feature of Vector that does away with static concurrency limits and automatically optimizes HTTP concurrency based on downstream service responses. The underlying mechanism is a feedback loop inspired by TCP congestion control algorithms. Checkout the announcement blog post,
We highly recommend enabling this feature as it improves performance and reliability of Vector and the systems it communicates with. As such, we have made it the default, and no further configuration is required.
Static concurrency
If Adaptive Request Concurrency is not for you, you can manually set static concurrency
limits by specifying an integer for request.concurrency
:
[sinks.my-sink]
request.concurrency = 10
Rate limits
In addition to limiting request concurrency, you can also limit the overall request
throughput via the request.rate_limit_duration_secs
and request.rate_limit_num
options.
[sinks.my-sink]
request.rate_limit_duration_secs = 1
request.rate_limit_num = 10
These will apply to both adaptive
and fixed request.concurrency
values.
Retry policy
request.retry_attempts
and
request.retry_backoff_secs
options.Severity Level Mapping
If a severity_key
is configured, outgoing log records have their
severity
header field set from the named field in the Vector
event. However, the required values for
this field may be inconvenient to produce, typically requiring a custom
mapping using an additional transform. To assist with this, this sink
remaps certain commonly used words to the required numbers as in the
following table. Note that only the prefix is compared, such that a
value of emergency
matches emerg
, and the comparison ignores case.
Prefix | Value |
---|---|
emerg | 800 |
fatal | 800 |
alert | 700 |
crit | 600 |
err | 500 |
warn | 400 |
notice | 300 |
info | 200 |
debug | 100 |
trace | 100 |