kafka.log

LogManager

class LogManager extends Logging

The entry point to the kafka log management subsystem. The log manager is responsible for log creation, retrieval, and cleaning. All read and write operations are delegated to the individual log instances.

The log manager maintains logs in one or more directories. New logs are created in the data directory with the fewest logs. No attempt is made to move partitions after the fact or balance based on size or I/O rate.

A background thread handles log retention by periodically truncating excess log segments.

Inherited
  1. Hide All
  2. Show all
  1. Logging
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new LogManager(logDirs: Array[File], topicConfigs: Map[String, LogConfig], defaultConfig: LogConfig, cleanerConfig: CleanerConfig, flushCheckMs: Long, flushCheckpointMs: Long, retentionCheckMs: Long, scheduler: Scheduler, time: Time)

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. val InitialTaskDelayMs: Int

  9. val LockFile: String

  10. val RecoveryPointCheckpointFile: String

  11. def allLogs(): Iterable[Log]

    Get all the partition logs

    Get all the partition logs

  12. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  13. def checkpointRecoveryPointOffsets(): Unit

    Write out the current recovery point for all logs to a text file in the log directory to avoid recovering the whole log on startup.

    Write out the current recovery point for all logs to a text file in the log directory to avoid recovering the whole log on startup.

  14. val cleanerConfig: CleanerConfig

  15. def cleanupLogs(): Unit

    Delete any eligible logs.

    Delete any eligible logs. Return the number of segments deleted.

  16. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  17. def createLog(topicAndPartition: TopicAndPartition, config: LogConfig): Log

    Create a log for the given topic and the given partition If the log already exists, just return a copy of the existing log

    Create a log for the given topic and the given partition If the log already exists, just return a copy of the existing log

  18. def debug(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  19. def debug(e: ⇒ Throwable): Any

    definition classes: Logging
  20. def debug(msg: ⇒ String): Unit

    definition classes: Logging
  21. val defaultConfig: LogConfig

  22. def deleteLog(topicAndPartition: TopicAndPartition): Unit

    Delete a log.

    Delete a log.

  23. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  24. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  25. def error(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  26. def error(e: ⇒ Throwable): Any

    definition classes: Logging
  27. def error(msg: ⇒ String): Unit

    definition classes: Logging
  28. def fatal(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  29. def fatal(e: ⇒ Throwable): Any

    definition classes: Logging
  30. def fatal(msg: ⇒ String): Unit

    definition classes: Logging
  31. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  32. val flushCheckMs: Long

  33. val flushCheckpointMs: Long

  34. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  35. def getLog(topicAndPartition: TopicAndPartition): Option[Log]

    Get the log if it exists, otherwise return None

    Get the log if it exists, otherwise return None

  36. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  37. def info(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  38. def info(e: ⇒ Throwable): Any

    definition classes: Logging
  39. def info(msg: ⇒ String): Unit

    definition classes: Logging
  40. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  41. val logDirs: Array[File]

  42. var logIdent: String

    attributes: protected
    definition classes: Logging
  43. lazy val logger: Logger

    definition classes: Logging
  44. val loggerName: String

    definition classes: Logging
  45. def logsByTopicPartition: Map[TopicAndPartition, Log]

    Get a map of TopicAndPartition => Log

    Get a map of TopicAndPartition => Log

  46. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  47. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  48. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  49. val retentionCheckMs: Long

  50. def shutdown(): Unit

    Close all the logs

    Close all the logs

  51. def startup(): Unit

    Start the background threads to flush logs and do log cleanup

    Start the background threads to flush logs and do log cleanup

  52. def swallow(action: ⇒ Unit): Unit

    definition classes: Logging
  53. def swallowDebug(action: ⇒ Unit): Unit

    definition classes: Logging
  54. def swallowError(action: ⇒ Unit): Unit

    definition classes: Logging
  55. def swallowInfo(action: ⇒ Unit): Unit

    definition classes: Logging
  56. def swallowTrace(action: ⇒ Unit): Unit

    definition classes: Logging
  57. def swallowWarn(action: ⇒ Unit): Unit

    definition classes: Logging
  58. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  59. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  60. val topicConfigs: Map[String, LogConfig]

  61. def trace(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  62. def trace(e: ⇒ Throwable): Any

    definition classes: Logging
  63. def trace(msg: ⇒ String): Unit

    definition classes: Logging
  64. def truncateFullyAndStartAt(topicAndPartition: TopicAndPartition, newOffset: Long): Unit

    Delete all data in a partition and start the log at the new offset

    Delete all data in a partition and start the log at the new offset

    newOffset

    The new offset to start the log with

  65. def truncateTo(partitionAndOffsets: Map[TopicAndPartition, Long]): Unit

    Truncate the partition logs to the specified offsets and checkpoint the recovery point to this offset

    Truncate the partition logs to the specified offsets and checkpoint the recovery point to this offset

    partitionAndOffsets

    Partition logs that need to be truncated

  66. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  67. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  68. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  69. def warn(msg: ⇒ String, e: ⇒ Throwable): Unit

    definition classes: Logging
  70. def warn(e: ⇒ Throwable): Any

    definition classes: Logging
  71. def warn(msg: ⇒ String): Unit

    definition classes: Logging