Metaplane Get
CertifiedGet the latest result of a Metaplane monitor
Metaplane Get
Get the latest result of a Metaplane monitor
Reads the current status of a monitor from the Metaplane API. This is a pure read: it never fails or halts the flow because of an anomaly, it only reports the status. Use a downstream task, such as io.kestra.plugin.core.execution.Fail with a condition on the status output, to gate the pipeline.
Fails with a clear error if the monitor has never been run (HTTP 404).
type: io.kestra.plugin.metaplane.GetExamples
Run a Metaplane monitor, wait for it to complete, then gate the pipeline on its result
id: metaplane_gate
namespace: company.team
tasks:
- id: run_monitor
type: io.kestra.plugin.metaplane.Run
apiToken: "{{ secret('METAPLANE_API_TOKEN') }}"
monitorIds:
- "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- id: wait_for_monitor_run
type: io.kestra.plugin.core.flow.Pause
# Run only enqueues the monitor and does not wait for completion; this pause gives it
# time to finish before Get reads its status. For a guaranteed-fresh result instead of
# a fixed wait, react to io.kestra.plugin.metaplane.MonitorResultTrigger in a separate flow.
pauseDuration: PT1M
- id: get_result
type: io.kestra.plugin.metaplane.Get
apiToken: "{{ secret('METAPLANE_API_TOKEN') }}"
monitorId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- id: halt_on_anomaly
type: io.kestra.plugin.core.execution.Fail
condition: "{{ outputs.get_result.status == 'FAIL' }}"
Properties
apiToken *Requiredstring
Metaplane API token
API token used to authenticate against the Metaplane API. Generate one at https://app.metaplane.dev/account/manage-tokens and store it as a Kestra secret.
monitorId *Requiredstring
Monitor ID
UUID of the Metaplane monitor to read the status of.
baseUrl string
https://dev.api.metaplane.devMetaplane API base URL
Base endpoint for all Metaplane API calls. Defaults to https://dev.api.metaplane.dev.
options Non-dynamic
HTTP client options
Optional HTTP configuration (timeouts, proxy, SSL) applied to every Metaplane API call.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
checkedAt string
date-timeTimestamp of the monitor's most recent run, if reported by the API
monitorId string
Monitor ID that was read
series array
Per-series status
Status of each of the monitor's group-by series.
io.kestra.plugin.metaplane.SeriesStatus
Group-by values identifying this series
Shape not documented by Metaplane, kept opaque.
com.fasterxml.jackson.databind.JsonNode
Lower bound of the expected range for this series
IDs of incidents currently open for this series
Observed value for this series
PASSIN_TRAININGNOT_ENOUGH_DATAFAILED_TO_PREDICTINVALID_INPUTERRORFAILUNKNOWNStatus of this series
Upper bound of the expected range for this series
status string
PASSIN_TRAININGNOT_ENOUGH_DATAFAILED_TO_PREDICTINVALID_INPUTERRORFAILUNKNOWNOverall monitor status
The worst status across all of the monitor's group-by series, or ERROR if the underlying query itself failed. One of PASS (no anomaly), FAIL (anomaly detected), IN_TRAINING, NOT_ENOUGH_DATA, FAILED_TO_PREDICT, INVALID_INPUT, ERROR, or UNKNOWN for any value not recognized by this task.
