Package kieker.monitoring.writer.filesystem

Class FileWriter

java.lang.Object
kieker.monitoring.writer.AbstractMonitoringWriter
kieker.monitoring.writer.filesystem.FileWriter
All Implemented Interfaces:
kieker.common.registry.IRegistryListener<java.lang.String>
public class FileWriter
extends AbstractMonitoringWriter
implements kieker.common.registry.IRegistryListener<java.lang.String>
Generic file writer which can be used to write any type of serialization. Presently, two serialization methods exist.
Since:
1.14

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String CONFIG_BUFFERSIZE
    The name of the configuration key for the buffer size.
    static java.lang.String CONFIG_CHARSET_NAME
    The name of the configuration for the charset name used to store strings (e.g.
    static java.lang.String CONFIG_COMPRESSION_FILTER
    The name of the configuration key to select a compression for the record log files.
    static java.lang.String CONFIG_FLUSH
    The name of the configuration key determining to always flush the output file stream after writing each record.
    static java.lang.String CONFIG_LOG_POOL_FILE_HANDLER
    The name of the configuration to define the handler of the file pool.
    static java.lang.String CONFIG_LOG_STREAM_HANDLER
    The name of the configuration to define the handler of the log stream.
    static java.lang.String CONFIG_MAP_FILE_HANDLER
    The name of the configuration to switch for the map file handler; default TextMapFileHandler.
    static java.lang.String CONFIG_MAXENTRIESINFILE
    The name of the configuration determining the maximal number of entries in a file.
    static java.lang.String CONFIG_MAXLOGFILES
    The name of the configuration determining the maximal number of log files.
    static java.lang.String CONFIG_MAXLOGSIZE
    The name of the configuration determining the maximal size of the files in MiB.
    static java.lang.String CONFIG_PATH
    The name of the configuration for the custom storage path if the writer is advised not to store in the temporary directory.
    static java.lang.String PREFIX  

    Fields inherited from class kieker.monitoring.writer.AbstractMonitoringWriter

    configuration

  • Constructor Summary

    Constructors 
    Constructor Description
    FileWriter​(kieker.common.configuration.Configuration configuration)
    Create a generic file writer.

  • Method Summary

    Modifier and Type Method Description
    void onNewRegistryEntry​(java.lang.String value, int id)  
    void onStarting()
    This event fires when Kieker has been initialized and is ready to monitor.
    void onTerminating()
    This event fires when Kieker has been notified to terminate.
    java.lang.String toString()
    Returns a textual representation of the writer's configuration.
    void writeMonitoringRecord​(kieker.common.record.IMonitoringRecord record)
    This event fires when Kieker has received a new record.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PREFIX

      public static final java.lang.String PREFIX

    • CONFIG_PATH

      public static final java.lang.String CONFIG_PATH
      The name of the configuration for the custom storage path if the writer is advised not to store in the temporary directory.

    • CONFIG_CHARSET_NAME

      public static final java.lang.String CONFIG_CHARSET_NAME
      The name of the configuration for the charset name used to store strings (e.g. "UTF-8").

    • CONFIG_MAXENTRIESINFILE

      public static final java.lang.String CONFIG_MAXENTRIESINFILE
      The name of the configuration determining the maximal number of entries in a file.

    • CONFIG_MAXLOGSIZE

      public static final java.lang.String CONFIG_MAXLOGSIZE
      The name of the configuration determining the maximal size of the files in MiB.

    • CONFIG_MAXLOGFILES

      public static final java.lang.String CONFIG_MAXLOGFILES
      The name of the configuration determining the maximal number of log files.

    • CONFIG_MAP_FILE_HANDLER

      public static final java.lang.String CONFIG_MAP_FILE_HANDLER
      The name of the configuration to switch for the map file handler; default TextMapFileHandler.

    • CONFIG_LOG_POOL_FILE_HANDLER

      public static final java.lang.String CONFIG_LOG_POOL_FILE_HANDLER
      The name of the configuration to define the handler of the file pool.

    • CONFIG_LOG_STREAM_HANDLER

      public static final java.lang.String CONFIG_LOG_STREAM_HANDLER
      The name of the configuration to define the handler of the log stream.

    • CONFIG_FLUSH

      public static final java.lang.String CONFIG_FLUSH
      The name of the configuration key determining to always flush the output file stream after writing each record.

    • CONFIG_COMPRESSION_FILTER

      public static final java.lang.String CONFIG_COMPRESSION_FILTER
      The name of the configuration key to select a compression for the record log files.

    • CONFIG_BUFFERSIZE

      public static final java.lang.String CONFIG_BUFFERSIZE
      The name of the configuration key for the buffer size.

  • Constructor Details

    • FileWriter

      public FileWriter​(kieker.common.configuration.Configuration configuration) throws java.io.IOException
      Create a generic file writer.
      Parameters:
      configuration - Kieker configuration object.
      Throws:
      java.io.IOException

  • Method Details