Packages

trait DeltaLogging extends DeltaProgressReporter with DatabricksLogging

Convenience wrappers for logging that include delta specific options and avoids the need to predeclare all operations. Metrics in Delta should respect the following conventions:

  • Tags should identify the context of the event (which shard, user, table, machine, etc).
  • All actions initiated by a user should be wrapped in a recordOperation so we can track usage latency and failures. If there is a significant (more than a few seconds) subaction like identifying candidate files, consider nested recordOperation.
  • Events should be used to return detailed statistics about usage. Generally these should be defined with a case class to ease analysis later.
  • Events can also be used to record that a particular codepath was hit (i.e. a checkpoint failure, a conflict, or a specific optimization).
  • Both events and operations should be named hierarchically to allow for analysis at different levels. For example, to look at the latency of all DDL operations we could scan for operations that match "delta.ddl.%".

Underneath these functions use the standard usage log reporting defined in com.databricks.spark.util.DatabricksLogging.

Linear Supertypes
DatabricksLogging, DeltaProgressReporter, LoggingShims, Logging, AnyRef, Any
Known Subclasses
VacuumTableCommand, CheckpointProvider, Checkpoints, Checkpoints, ColumnMappingPreDowngradeCommand, ColumnWithDefaultExprUtils, CoordinatedCommitsPreDowngradeCommand, DeltaAnalysis, DeltaColumnMapping, DeltaColumnMappingBase, DeltaConfigs, DeltaConfigsBase, DeltaErrors, DeltaErrorsBase, DeltaHistoryManager, DeltaHistoryManager, DeltaLog, DeltaLog, DeltaOptions, DeltaRelation, DeltaTableIdentifier, DeltaTableUtils, DeltaTimeTravelSpec, DeltaUnsupportedOperationsCheck, DomainMetadataUtils, DomainMetadataUtilsBase, DummySnapshot, FileMetadataMaterializationTracker, GeneratedColumn, IcebergCompat, IcebergCompat, IcebergCompatV1, IcebergCompatV2, IdentityColumn, IdentityOverflowLogger, InCommitTimestampsPreDowngradeCommand, MetadataCleanup, OptimisticTransaction, OptimisticTransactionImpl, PreloadedCheckpointProvider, PreprocessTableMerge, PreprocessTableUpdate, ReadChecksum, RecordChecksum, Snapshot, Snapshot, SnapshotStateManager, TestReaderWriterFeaturePreDowngradeCommand, TestWriterFeaturePreDowngradeCommand, TestWriterWithHistoryValidationFeaturePreDowngradeCommand, TypeWideningPreDowngradeCommand, UniversalFormat, UpdateExpressionsSupport, V2CheckpointPreDowngradeCommand, V2CheckpointProvider, VacuumProtocolCheckPreDowngradeCommand, ValidateChecksum, DropTableFeatureUtils, DeltaCatalog, DeltaTableV2, AlterDeltaTableCommand, AlterTableAddColumnsDeltaCommand, AlterTableAddConstraintDeltaCommand, AlterTableChangeColumnDeltaCommand, AlterTableClusterByDeltaCommand, AlterTableConstraintDeltaCommand, AlterTableDropColumnsDeltaCommand, AlterTableDropConstraintDeltaCommand, AlterTableDropFeatureDeltaCommand, AlterTableReplaceColumnsDeltaCommand, AlterTableSetLocationDeltaCommand, AlterTableSetPropertiesDeltaCommand, AlterTableUnsetPropertiesDeltaCommand, CloneTableBase, CloneTableBaseUtils, CloneTableCommand, ConvertToDeltaCommand, ConvertToDeltaCommand, ConvertToDeltaCommandBase, CreateDeltaTableCommand, DMLWithDeletionVectorsHelper, DeleteCommand, DeletionVectorUtils, DeletionVectorUtils, DeletionVectorWriter, DeltaCommand, DeltaGenerateCommand, DeltaReorgTableCommand, DescribeDeltaDetailCommand, DescribeDeltaHistory, DescribeDeltaHistoryCommand, LastVacuumInfo, MergeIntoCommand, MergeIntoCommandBase, OptimizeExecutor, OptimizeTableCommand, OptimizeTableCommandBase, ReorgTableForUpgradeUniformHelper, RestoreTableCommand, ShowDeltaTableColumnsCommand, UpdateCommand, VacuumCommand, VacuumCommandImpl, WriteIntoDelta, BackfillBatch, BackfillCommand, BackfillExecutor, RowTrackingBackfillBatch, RowTrackingBackfillCommand, RowTrackingBackfillExecutor, CDCReader, CDCReaderImpl, RemoveColumnMappingCommand, CatalogFileManifest, ConvertUtils, ConvertUtilsBase, ManualListingFileManifest, MetadataLogFileManifest, ParquetTable, MergeIntoMaterializeSource, CoordinatedCommitsUtils, DeletionVectorStoredBitmap, DeltaSourceSnapshot, TransactionalWrite, AutoCompact, AutoCompactBase, AutoCompactUtils, ChecksumHook, WriteChecksum, GenerateSymlinkManifest, GenerateSymlinkManifestImpl, GenerateSymlinkManifestUtils, HudiConverterHook, IcebergConverterHook, UpdateCatalog, UpdateCatalogBase, DeltaOptimizedWriterExec, ImplicitMetadataOperation, SchemaUtils, ClusteredTableUtils, ClusteredTableUtilsBase, ClusteringColumnInfo, DeltaDataSource, DeltaSink, DeltaSource, DeltaSourceBase, DeltaSourceMetadataEvolutionSupport, DataSkippingReader, DataSkippingReaderBase, PrepareDeltaScan, PrepareDeltaScanBase, PreparedDeltaFileIndex, StatisticsCollection, StatisticsCollection, DelegatingLogStore, DeletionVectorStore, HadoopFileSystemDVStore, DeltaFileOperations, StateCache, NonFateSharingFuture, ZCubeInfo
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaLogging
  2. DatabricksLogging
  3. DeltaProgressReporter
  4. LoggingShims
  5. Logging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    LoggingShims

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def deltaAssert(check: ⇒ Boolean, name: String, msg: String, deltaLog: DeltaLog = null, data: AnyRef = null, path: Option[Path] = None): Unit

    Helper method to check invariants in Delta code.

    Helper method to check invariants in Delta code. Fails when running in tests, records a delta assertion event and logs a warning otherwise.

    Attributes
    protected
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
  12. def getErrorData(e: Throwable): Map[String, Any]
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  15. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  18. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  19. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  20. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  21. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  22. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  25. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  26. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  29. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  30. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  33. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  34. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  35. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  38. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  39. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. def recordDeltaEvent(deltaLog: DeltaLog, opType: String, tags: Map[TagDefinition, String] = Map.empty, data: AnyRef = null, path: Option[Path] = None): Unit

    Used to record the occurrence of a single event or report detailed, operation specific statistics.

    Used to record the occurrence of a single event or report detailed, operation specific statistics.

    path

    Used to log the path of the delta table when deltaLog is null.

    Attributes
    protected
  45. def recordDeltaOperation[A](deltaLog: DeltaLog, opType: String, tags: Map[TagDefinition, String] = Map.empty)(thunk: ⇒ A): A

    Used to report the duration as well as the success or failure of an operation on a deltaLog.

    Used to report the duration as well as the success or failure of an operation on a deltaLog.

    Attributes
    protected
  46. def recordDeltaOperationForTablePath[A](tablePath: String, opType: String, tags: Map[TagDefinition, String] = Map.empty)(thunk: ⇒ A): A

    Used to report the duration as well as the success or failure of an operation on a tahoePath.

    Used to report the duration as well as the success or failure of an operation on a tahoePath.

    Attributes
    protected
  47. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  48. def recordFrameProfile[T](group: String, name: String)(thunk: ⇒ T): T
    Attributes
    protected
  49. def recordOperation[S](opType: OpType, opTarget: String = null, extraTags: Map[TagDefinition, String], isSynchronous: Boolean = true, alwaysRecordStats: Boolean = false, allowAuthTags: Boolean = false, killJvmIfStuck: Boolean = false, outputMetric: MetricDefinition = METRIC_OPERATION_DURATION, silent: Boolean = true)(thunk: ⇒ S): S
    Definition Classes
    DatabricksLogging
  50. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  51. def recordProductUsage(metric: MetricDefinition with CentralizableMetric, quantity: Double, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, forceSample: Boolean = false, trimBlob: Boolean = true, silent: Boolean = false): Unit
    Definition Classes
    DatabricksLogging
  52. def recordUsage(metric: MetricDefinition, quantity: Double, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, forceSample: Boolean = false, trimBlob: Boolean = true, silent: Boolean = false): Unit
    Definition Classes
    DatabricksLogging
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  58. def withStatusCode[T](statusCode: String, defaultMessage: String, data: Map[String, Any] = Map.empty)(body: ⇒ T): T

    Report a log to indicate some command is running.

    Report a log to indicate some command is running.

    Definition Classes
    DeltaProgressReporter

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from LoggingShims

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped