Clever Cloud CreateDrain
CertifiedCreate a log drain forwarding a Clever Cloud application's logs
Clever Cloud CreateDrain
Create a log drain forwarding a Clever Cloud application's logs
Creates a drain that forwards an application's logs to an external observability platform, via POST /v4/drains/organisations/{organisationId}/applications/{applicationId}/drains.
Supported drainType values: RAW_HTTP, SYSLOG_TCP, SYSLOG_UDP, DATADOG, ELASTICSEARCH, NEWRELIC. There is no dedicated OVHCLOUD type on the Clever Cloud API: forward to OVHcloud (or any other generic HTTP or syslog ingestion endpoint) via RAW_HTTP or SYSLOG_TCP/SYSLOG_UDP.
This task returns as soon as the drain is created; it does not wait for it to reach the ENABLED status. organisationId is always required (no /self shortcut for personal accounts).
type: io.kestra.plugin.clevercloud.logs.CreateDrainExamples
Create a New Relic log drain
id: setup_log_drain
namespace: company.team
tasks:
- id: create_drain
type: io.kestra.plugin.clevercloud.logs.CreateDrain
apiToken: "{{ secret('CC_API_TOKEN') }}"
organisationId: "orga_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
applicationId: "app_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
drainType: NEWRELIC
url: "https://log-api.newrelic.com/log/v1"
newRelicApiKey: "{{ secret('NEWRELIC_API_KEY') }}"
Properties
apiToken *Requiredstring
API token
Bearer token for the Clever Cloud API. Store as a Kestra secret and reference with {{ secret('CC_API_TOKEN') }}.
applicationId *Requiredstring
Application ID
drainType *Requiredstring
RAW_HTTPSYSLOG_TCPSYSLOG_UDPDATADOGELASTICSEARCHNEWRELICRecipient type
One of RAW_HTTP, SYSLOG_TCP, SYSLOG_UDP, DATADOG, ELASTICSEARCH, NEWRELIC.
organisationId *Requiredstring
Organisation ID
The Clever Cloud organisation or personal account ID that owns the application (orga_xxx or user_xxx). Unlike the rest of this plugin, the v4 logs and log drain APIs have no /self shortcut, so this is always required.
url *Requiredstring
Destination URL to forward logs to
indexPrefix string
Elasticsearch index prefix
Only used when drainType is ELASTICSEARCH.
kind string
LOGLOGACCESSLOGAUDITLOGWhich log stream this drain forwards
One of LOG (application runtime logs), ACCESSLOG, AUDITLOG. Defaults to LOG.
newRelicApiKey string
New Relic API key
Only used when drainType is NEWRELIC.
options Non-dynamic
HTTP client options
Optional HttpConfiguration applied to every Clever Cloud API call, including timeouts and proxy settings.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
password string
Password for the destination
Only used when drainType is RAW_HTTP or ELASTICSEARCH.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
structuredDataParameters string
RFC 5424 structured data parameters
Only used when drainType is SYSLOG_TCP or SYSLOG_UDP.
username string
Username for the destination
Only used when drainType is RAW_HTTP or ELASTICSEARCH.
Outputs
id string
ID of the created log drain
kind string
Which log stream the drain forwards
status string
Drain status returned by the API
One of CREATED, ENABLING, ENABLED, DISABLING, DISABLED, DELETED, extracted from the nested status object the API returns.
