ai.databand

Class DbndClient

java.lang.Object

ai.databand.DbndClient

public class DbndClient
extends java.lang.Object

DBND tracking API client.

Constructor Summary

Constructors

Constructor and Description
DbndClient(DbndConfig dbndConfig)

Method Summary

Modifier and Type	Method and Description
TaskRunsInfo	addTaskRuns(java.lang.String rootRunUid, java.lang.String runId, java.util.List<TaskRun> taskRuns, java.util.List<TaskDefinition> taskDefinitions, java.util.List<java.util.List<java.lang.String>> parentChildMap, java.util.List<java.util.List<java.lang.String>> upstreamsMap) Add task runs (method executions).
DbndApi	api() API client.
java.lang.String	initRun(java.lang.String jobName, java.lang.String runId, java.lang.String user, java.lang.String runName, TaskRunsInfo taskRunsInfo, AirflowTaskContext airflowTaskContext, RootRun root) Init new DBND run.
java.lang.String	initRun(java.lang.String jobName, java.lang.String runId, java.lang.String user, java.lang.String runName, TaskRunsInfo taskRunsInfo, AirflowTaskContext airflowTaskContext, RootRun root, java.lang.String source, TrackingSource trackingSource, java.lang.String projectName) Init new DBND run.
void	logDatasetOperations(TaskRun taskRun, java.util.List<LogDataset> datasets) Log task dataset operations.
void	logMetric(TaskRun taskRun, java.lang.String key, java.lang.String value, java.lang.String source) Log task metrics.
void	logMetrics(TaskRun taskRun, java.util.Map<java.lang.String,java.lang.Object> metrics, java.lang.String source) Log task metrics.
void	logTargets(TaskRun taskRun, java.util.List<LogTarget> targets) Log task targets.
protected java.util.Optional<java.lang.Object>	safeExecuteVoid(retrofit2.Call<java.lang.Void> call) Wrap retrofit exception and response handling for Void calls.
protected java.util.Optional<java.lang.Object>	safeExecuteVoid(retrofit2.Call<java.lang.Void> call, boolean logToStdout) Wrap retrofit exception and response handling for Void calls.
void	saveExternalLinks(java.lang.String taskRunAttemptUid, java.util.Map<java.lang.String,java.lang.String> linksDict) Save task run attempt external link.
void	saveExternalLinks(java.lang.String taskRunAttemptUid, java.lang.String name, java.lang.String url) Save task run attempt external link.
void	saveTaskLog(java.lang.String taskRunUid, java.lang.String taskRunAttemptUid, java.lang.String logBody) Save task logs.
void	setRunState(java.lang.String runUid, java.lang.String state) Set run state.
void	updateTaskRunAttempt(java.lang.String taskRunUid, java.lang.String taskRunAttemptUid, java.lang.String state, ErrorInfo errorInfo, java.time.ZonedDateTime startDate) Update task run attempts with given state.
void	updateTaskRunAttempt(java.lang.String taskRunUid, java.lang.String taskRunAttemptUid, java.lang.String state, ErrorInfo errorInfo, java.time.ZonedDateTime startDate, java.util.Map<java.lang.String,java.lang.String> linksDict) Update task run attempts with given state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbndClient

public DbndClient(DbndConfig dbndConfig)

Method Detail

initRun

public java.lang.String initRun(java.lang.String jobName,
                                java.lang.String runId,
                                java.lang.String user,
                                java.lang.String runName,
                                TaskRunsInfo taskRunsInfo,
                                AirflowTaskContext airflowTaskContext,
                                RootRun root)

Init new DBND run.

Parameters:

jobName - job name

runId - rui id

user - user

taskRunsInfo - task runs info

airflowTaskContext - airflow task context

root - root run definition

Returns:

runUid of created run

initRun

public java.lang.String initRun(java.lang.String jobName,
                                java.lang.String runId,
                                java.lang.String user,
                                java.lang.String runName,
                                TaskRunsInfo taskRunsInfo,
                                AirflowTaskContext airflowTaskContext,
                                RootRun root,
                                java.lang.String source,
                                TrackingSource trackingSource,
                                java.lang.String projectName)

Init new DBND run.

Parameters:

jobName - job name

runId - rui id

user - user

taskRunsInfo - task runs info

airflowTaskContext - airflow task context

root - root run definition

source - tracking source: "airflow" or "azkaban"

trackingSource - tracking source definition

Returns:

runUid of created run

addTaskRuns

public TaskRunsInfo addTaskRuns(java.lang.String rootRunUid,
                                java.lang.String runId,
                                java.util.List<TaskRun> taskRuns,
                                java.util.List<TaskDefinition> taskDefinitions,
                                java.util.List<java.util.List<java.lang.String>> parentChildMap,
                                java.util.List<java.util.List<java.lang.String>> upstreamsMap)

Add task runs (method executions).

Parameters:

rootRunUid - root run uid to add tasks to

runId - run id

taskRuns - task graph

taskDefinitions - task definitions list

parentChildMap - parent-child map

upstreamsMap - upstreams map

Returns:

TaskRunsInfo object

updateTaskRunAttempt

public void updateTaskRunAttempt(java.lang.String taskRunUid,
                                 java.lang.String taskRunAttemptUid,
                                 java.lang.String state,
                                 ErrorInfo errorInfo,
                                 java.time.ZonedDateTime startDate)

Update task run attempts with given state.

Parameters:

taskRunUid - task run UID

taskRunAttemptUid - task run attempt UID

state - state: RUNNING, FAILED, SUCCESS

errorInfo - error details in case of failure

startDate - task start date—required for proper task duration calculation

updateTaskRunAttempt

public void updateTaskRunAttempt(java.lang.String taskRunUid,
                                 java.lang.String taskRunAttemptUid,
                                 java.lang.String state,
                                 ErrorInfo errorInfo,
                                 java.time.ZonedDateTime startDate,
                                 java.util.Map<java.lang.String,java.lang.String> linksDict)

Update task run attempts with given state.

Parameters:

taskRunUid - task run UID

taskRunAttemptUid - task run attempt UID

state - state: RUNNING, FAILED, SUCCESS

errorInfo - error details in case of failure

startDate - task start date—required for proper task duration calculation

linksDict - external links, e.g. Airflow or Azkaban run, Spark History server

setRunState

public void setRunState(java.lang.String runUid,
                        java.lang.String state)

Set run state.

Parameters:

runUid - task run UID

state - state: RUNNING, FAILED, SUCCESS

logMetric

public void logMetric(TaskRun taskRun,
                      java.lang.String key,
                      java.lang.String value,
                      java.lang.String source)

Log task metrics.

Parameters:

taskRun - task run

key - metric key

value - metric value

source - metric source, e.g. "user", "system", "spark"

logMetrics

public void logMetrics(TaskRun taskRun,
                       java.util.Map<java.lang.String,java.lang.Object> metrics,
                       java.lang.String source)

Log task metrics.

Parameters:

taskRun - task run

metrics - metrics map

source - metrics source, e.g. "user", "system", "spark"

logTargets

public void logTargets(TaskRun taskRun,
                       java.util.List<LogTarget> targets)

Log task targets.

Parameters:

taskRun - task run

targets - targets to log

logDatasetOperations

public void logDatasetOperations(TaskRun taskRun,
                                 java.util.List<LogDataset> datasets)

Log task dataset operations.

Parameters:

taskRun - task run

datasets - dataset operations to log

saveExternalLinks

public void saveExternalLinks(java.lang.String taskRunAttemptUid,
                              java.lang.String name,
                              java.lang.String url)

Save task run attempt external link.

Parameters:

taskRunAttemptUid - task run attempt UID

name - link name, e.g. "Azkaban execution"

url - link URL

saveExternalLinks

public void saveExternalLinks(java.lang.String taskRunAttemptUid,
                              java.util.Map<java.lang.String,java.lang.String> linksDict)

Save task run attempt external link.

Parameters:

taskRunAttemptUid - task run attempt UID

linksDict - links map

saveTaskLog

public void saveTaskLog(java.lang.String taskRunUid,
                        java.lang.String taskRunAttemptUid,
                        java.lang.String logBody)

Save task logs.

Parameters:

taskRunAttemptUid - task run attempt UID

logBody - log body

safeExecuteVoid

protected java.util.Optional<java.lang.Object> safeExecuteVoid(retrofit2.Call<java.lang.Void> call)

Wrap retrofit exception and response handling for Void calls.

Parameters:

call - prepared Retrofit HTTP call

Returns:

execute result wrapped in Optional

safeExecuteVoid

protected java.util.Optional<java.lang.Object> safeExecuteVoid(retrofit2.Call<java.lang.Void> call,
                                                               boolean logToStdout)

Wrap retrofit exception and response handling for Void calls.

Parameters:

call - prepared Retrofit HTTP call

logToStdout - set to true if logging to stdout is required, e.g. when log system isn't initialized

Returns:

execute result wrapped in Optional

api

public DbndApi api()

API client.

Returns:

API client.