Zum Hauptinhalt springen

DefaultPipelineDebugger

Namespace: Meshmakers.Octo.Sdk.Common.EtlDataPipeline.Debugger

Implements a default pipeline debugger

public class DefaultPipelineDebugger : IPipelineDebugger

Inheritance Object → DefaultPipelineDebugger
Implements IPipelineDebugger

Fields​

InputRootPath​

JSONPath root of the input snapshot in the debug point delivered to Studio (handover §11).

public static string InputRootPath;

OutputRootPath​

JSONPath root of the output snapshot in the debug point delivered to Studio (handover §11).

public static string OutputRootPath;

DryRunIntentRootPath​

JSONPath root of the dry-run intent of a debug point.

public static string DryRunIntentRootPath;

Properties​

Logger​

public IPipelineLogger Logger { get; }

Property Value​

IPipelineLogger

Constructors​

DefaultPipelineDebugger(ILoggerFactory)​

Creates a new instance of DefaultPipelineDebugger

public DefaultPipelineDebugger(ILoggerFactory loggerFactory)

Parameters​

loggerFactory ILoggerFactory

Methods​

RegisterPipelineRtEntityId(RtEntityId, Guid)​

public void RegisterPipelineRtEntityId(RtEntityId pipelineRtEntityId, Guid pipelineExecutionId)

Parameters​

pipelineRtEntityId RtEntityId

pipelineExecutionId Guid

AddSecretRegistry(PipelineSecretRegistry)​

public void AddSecretRegistry(PipelineSecretRegistry registry)

Parameters​

registry PipelineSecretRegistry

BeginPipelineExecution()​

public void BeginPipelineExecution()

EndPipelineExecutionAsync()​

public Task EndPipelineExecutionAsync()

Returns​

Task

LogInput(String, NodePath, String, UInt32, JsonNode)​

public void LogInput(string id, NodePath path, string description, uint sequenceNumber, JsonNode inputData)

Parameters​

id String

path NodePath

description String

sequenceNumber UInt32

inputData JsonNode

LogOutput(String, NodePath, String, UInt32, JsonNode)​

public void LogOutput(string id, NodePath path, string description, uint sequenceNumber, JsonNode outputData)

Parameters​

id String

path NodePath

description String

sequenceNumber UInt32

outputData JsonNode

RecordDryRunIntent(String, NodePath, String, UInt32, String, JsonNode)​

public void RecordDryRunIntent(string id, NodePath path, string description, uint sequenceNumber, string nodeTypeName, JsonNode intentData)

Parameters​

id String

path NodePath

description String

sequenceNumber UInt32

nodeTypeName String

intentData JsonNode

GetRedactedPaths(String)​

Returns the JSONPaths of the values that were masked as *** in the snapshots of debug point nodeId (AB#5538, handover §11, Q12): rooted at the snapshot object (DefaultPipelineDebugger.InputRootPath, DefaultPipelineDebugger.OutputRootPath, DefaultPipelineDebugger.DryRunIntentRootPath), a string with a secret masked inside it listed with its own path. null when nothing was masked.

public IReadOnlyList<string> GetRedactedPaths(string nodeId)

Parameters​

nodeId String
The debug point (node) id

Returns​

IReadOnlyList<String>
The paths, ordinal-sorted, or null

GetDebugInformation()​

public DebugInformationRoot GetDebugInformation()

Returns​

DebugInformationRoot