LogShipper
LogShipper
yaml
type: "io.kestra.plugin.ee.core.log.LogShipper"Examples
yaml
id: logShipper
namespace: system
tasks:
- id: shipLogs
type: io.kestra.plugin.ee.core.log.LogShipper
logLevelFilter: INFO
lookbackPeriod: P1D
offsetKey: logShipperOffset
delete: false
logExporters:
- id: file
type: io.kestra.plugin.ee.core.log.FileLogExporter
- id: awsCloudWatch
type: io.kestra.plugin.ee.aws.cloudwatch.LogExporter
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: us-east-1
logGroupName: kestra
logStreamName: production
- id: S3LogExporter
type: io.kestra.plugin.ee.aws.s3.LogExporter
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "{{ vars.region }}"
format: JSON
bucket: logbucket
logFilePrefix: kestra-log-file
maxLinesPerFile: 1000000
- id: googleOperationalSuite
type: io.kestra.plugin.ee.gcp.operationalsuite.LogExporter
projectId: my-gcp-project
- id: gcs
type: io.kestra.plugin.ee.gcp.gcs.LogExporter
projectId: myProjectId
format: JSON
maxLinesPerFile: 10000
bucket: my-bucket
logFilePrefix: kestra-log-file
chunk: 1000
- id: azureMonitor
type: io.kestra.plugin.ee.azure.monitor.LogExporter
endpoint: https://endpoint-host.ingest.monitor.azure.com
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
ruleId: dcr-69f0b123041d4d6e9f2bf72aad0b62cf
streamName: kestraLogs
- id: azureBlobStorage
type: io.kestra.plugin.ee.azure.storage.LogExporter
endpoint: https://myblob.blob.core.windows.net/
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
containerName: logs
format: JSON
logFilePrefix: kestra-log-file
maxLinesPerFile: 1000000
chunk: 1000
- id: datadog
type: io.kestra.plugin.ee.datadog.LogExporter
basePath: https://http-intake.logs.datadoghq.eu
apiKey: "{{ secret('DATADOG_API_KEY') }}"
- id: elasticsearch
type: io.kestra.plugin.ee.elasticsearch.LogExporter
indexName: kestra-logs
connection:
basicAuth:
password: "{{ secret('ES_PASSWORD') }}"
username: kestra_user
hosts:
- https://elastic.example.com:9200
- id: opensearch
type: io.kestra.plugin.ee.opensearch.LogExporter
indexName: kestra-logs
connection:
basicAuth:
password: "{{ secret('ES_PASSWORD') }}"
username: kestra_user
hosts:
- https://elastic.example.com:9200
- id: newRelic
type: io.kestra.plugin.ee.newrelic.LogExporter
basePath: https://log-api.newrelic.com
apiKey: "{{ secret('NEWRELIC_API_KEY') }}"
- id: openTelemetry
type: io.kestra.plugin.ee.opentelemetry.LogExporter
otlpEndpoint: http://otel-collector:4318/v1/logs
authorizationHeaderName: Authorization
authorizationHeaderValue: "Bearer {{ secret('OTEL_TOKEN') }}"
triggers:
- id: dailySchedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 0 * * *"
disabled: true
Properties
logExporters *RequiredNon-dynamic
Min items
1 Definitions
Ship logs to a file inside Kestra's internal storage.
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
formatstring
Default
IONPossible Values
IONJSONlogFilePrefixstring
Default
kestra-log-filemaxLinesPerFileintegerstring
Export logs to Splunk
host*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1token*Requiredstring
type*Requiredobject
chunkintegerstring
Default
1000options
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
Format
durationreadIdleTimeoutstring
Default
PT5MFormat
durationsourcestring
Default
KestraExport logs to a Google Cloud Storage
bucket*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000formatstring
Default
JSONPossible Values
IONJSONimpersonatedServiceAccountstring
logFilePrefixstring
Default
kestra-log-filemaxLinesPerFileintegerstring
Default
100000projectIdstring
scopesarray
SubTypestring
Default
["https://www.googleapis.com/auth/cloud-platform"]serviceAccountstring
Export logs to a Google Operational Suite
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000impersonatedServiceAccountstring
projectIdstring
scopesarray
SubTypestring
Default
["https://www.googleapis.com/auth/cloud-platform"]serviceAccountstring
Ship logs to a Datadog instance.
apiKey*Requiredstring
basePath*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000options
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
Format
durationreadIdleTimeoutstring
Default
PT5MFormat
durationservicestring
Default
LogExportersourcestring
Default
KestraShip logs to Opensearch
connection*Required
io.kestra.plugin.ee.opensearch.OpensearchConnection
hosts*Requiredarray
SubTypestring
basicAuth
io.kestra.plugin.ee.opensearch.OpensearchConnection-BasicAuth
passwordstring
usernamestring
headersarray
SubTypestring
pathPrefixstring
strictDeprecationModebooleanstring
trustAllSslbooleanstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1indexName*Requiredstring
type*Requiredobject
chunkintegerstring
Default
1000Export logs to Graylog
endpoint*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000graylogHoststring
Default
Kestraoptions
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
Format
durationreadIdleTimeoutstring
Default
PT5MFormat
durationExport logs to Azure Monitor
endpoint*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1ruleId*Requiredstring
streamName*Requiredstring
type*Requiredobject
chunkintegerstring
Default
1000clientIdstring
clientSecretstring
pemCertificatestring
tenantIdstring
Export logs to Azure Blob Storage
containerName*Requiredstring
endpoint*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000clientIdstring
clientSecretstring
connectionStringstring
formatstring
Default
JSONPossible Values
IONJSONlogFilePrefixstring
Default
kestra-log-filemaxLinesPerFileintegerstring
Default
100000pemCertificatestring
sasTokenstring
sharedKeyAccountAccessKeystring
sharedKeyAccountNamestring
tenantIdstring
Ship logs to Elasticsearch
connection*Required
io.kestra.plugin.ee.elasticsearch.ElasticsearchConnection
hosts*Requiredarray
SubTypestring
Min items
1basicAuth
io.kestra.plugin.ee.elasticsearch.ElasticsearchConnection-BasicAuth
passwordstring
usernamestring
headersarray
SubTypestring
pathPrefixstring
strictDeprecationModebooleanstring
trustAllSslbooleanstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1indexName*Requiredstring
type*Requiredobject
chunkintegerstring
Default
1000Export logs to an Opentelemetry collector
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1otlpEndpoint*Requiredstring
type*Requiredobject
authorizationHeaderNamestring
authorizationHeaderValuestring
chunkintegerstring
Default
1000Ship logs to New Relic
apiKey*Requiredstring
basePath*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1type*Requiredobject
chunkintegerstring
Default
1000options
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailedbooleanstring
Default
falseallowedResponseCodesarray
SubTypeinteger
auth
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type*Requiredobject
passwordstring
usernamestring
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type*Requiredobject
tokenstring
basicAuthPasswordDeprecatedstring
basicAuthUserDeprecatedstring
connectTimeoutDeprecatedstring
Format
durationconnectionPoolIdleTimeoutDeprecatedstring
Format
durationdefaultCharsetstring
Default
UTF-8java.nio.charset.Charset
followRedirectsbooleanstring
Default
truelogLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDlogsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYmaxContentLengthDeprecatedinteger
proxy
io.kestra.core.http.client.configurations.ProxyConfiguration
addressstring
passwordstring
portintegerstring
typestring
Default
DIRECTPossible Values
DIRECTHTTPSOCKSusernamestring
proxyAddressDeprecatedstring
proxyPasswordDeprecatedstring
proxyPortDeprecatedinteger
proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKSproxyUsernameDeprecatedstring
readIdleTimeoutDeprecatedstring
Format
durationreadTimeoutDeprecatedstring
Format
durationssl
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificatesbooleanstring
timeout
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeoutstring
Format
durationreadIdleTimeoutstring
Default
PT5MFormat
durationExport logs to AWS CloudWatch
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1logGroupName*Requiredstring
logStreamName*Requiredstring
region*Requiredstring
type*Requiredobject
accessKeyIdstring
chunkintegerstring
Default
1000endpointOverridestring
secretKeyIdstring
sessionTokenstring
stsEndpointOverridestring
stsRoleArnstring
stsRoleExternalIdstring
stsRoleSessionDurationstring
Default
PT15MFormat
durationstsRoleSessionNamestring
Export logs to S3
bucket*Requiredstring
id*Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]*Min length
1region*Requiredstring
type*Requiredobject
accessKeyIdstring
chunkintegerstring
Default
1000endpointOverridestring
formatstring
Default
JSONPossible Values
IONJSONlogFilePrefixstring
Default
kestra-log-filemaxLinesPerFileintegerstring
Default
100000secretKeyIdstring
sessionTokenstring
stsEndpointOverridestring
stsRoleArnstring
stsRoleExternalIdstring
stsRoleSessionDurationstring
Default
PT15MFormat
durationstsRoleSessionNamestring
delete booleanstring
executionId string
flowId string
logLevelFilter string
Default
INFOlookbackPeriod string
Default
P1DFormat
durationmaximumMessageSize integerstring
namespace string
offsetKey string
Outputs
endFetchedDate string
Format
date-timeoutputs object
Definitions