config

Configuration wrappers for the main Logstash configuration file.

To import...

from dynamite_nsm.services.logstash import config as logstash_config

ConfigManager

__init__(self, configuration_directory, verbose=False, stdout=True) special

Manage Logstash Configuration

Parameters:

Name	Type	Description	Default
configuration_directory	str	Path to the configuration directory (E.G /etc/dynamite/logstash/)	required
stdout	Optional[bool]	Print output to console	True
verbose	Optional[bool]	Include detailed debug messages	False

Returns:

Type	Description
	None

Source code in dynamite_nsm/services/logstash/config.py

def __init__(self, configuration_directory: str, verbose: Optional[bool] = False, stdout: Optional[bool] = True):
    """Manage Logstash Configuration
    Args:
        configuration_directory: Path to the configuration directory (E.G /etc/dynamite/logstash/)
        stdout: Print output to console
        verbose: Include detailed debug messages
    Returns:
        None
    """
    extract_tokens = {
        'node_name': ('node.name',),
        'path_data': ('path.data',),
        'path_logs': ('path.logs',),
        'pipeline_batch_size': ('pipeline.batch.size',),
        'pipeline_batch_delay': ('pipeline.batch.delay',)
    }

    self.node_name = None
    self.path_data = None
    self.path_logs = None
    self.pipeline_batch_size = None
    self.pipeline_batch_delay = None
    self.configuration_directory = configuration_directory
    self.logstash_config_path = f'{self.configuration_directory}/logstash.yml'

    with open(self.logstash_config_path) as configyaml:
        self.config_data_raw = load(configyaml, Loader=Loader)
    super().__init__(self.config_data_raw, name='logstash.config', verbose=verbose, stdout=stdout, **extract_tokens)
    self.parse_yaml_file()

commit(self, out_file_path=None, backup_directory=None, top_text=None)

Write out an updated configuration file, and optionally backup the old one.

:param out_file_path: The path to the output file; if none given overwrites existing :param backup_directory: The path to the backup directory

Source code in dynamite_nsm/services/logstash/config.py

def commit(self, out_file_path: Optional[str] = None, backup_directory: Optional[str] = None,
           top_text: Optional[str] = None) -> None:
    """
    Write out an updated configuration file, and optionally backup the old one.

    :param out_file_path: The path to the output file; if none given overwrites existing
    :param backup_directory: The path to the backup directory
    """
    if not out_file_path:
        out_file_path = self.logstash_config_path

    super(ConfigManager, self).commit(out_file_path, backup_directory)

JavaHeapOptionsConfigManager

__init__(self, configuration_directory, verbose=False, stdout=True) special

:param configuration_directory: Path to the configuration directory (E.G /etc/dynamite/logstash/) :param stdout: Print output to console :param verbose: Include detailed debug messages

Source code in dynamite_nsm/services/logstash/config.py

def __init__(self, configuration_directory, verbose: Optional[bool] = False, stdout: Optional[bool] = True):
    """
    :param configuration_directory: Path to the configuration directory (E.G /etc/dynamite/logstash/)
    :param stdout: Print output to console
    :param verbose: Include detailed debug messages
    """
    self.configuration_directory = configuration_directory
    self.logstash_jvm_config_path = f'{self.configuration_directory}/jvm.options'
    with open(self.logstash_jvm_config_path) as jvm_config:
        data = {'data': jvm_config.readlines()}
    super().__init__(data, name='logstash.java', verbose=verbose, stdout=stdout)

commit(self, out_file_path=None, backup_directory=None)

Write out an updated configuration file, and optionally backup the old one.

:param out_file_path: The path to the output file; if none given overwrites existing :param backup_directory: The path to the backup directory

Source code in dynamite_nsm/services/logstash/config.py

def commit(self, out_file_path: Optional[str] = None, backup_directory: Optional[str] = None) -> None:
    """
    Write out an updated configuration file, and optionally backup the old one.

    :param out_file_path: The path to the output file; if none given overwrites existing
    :param backup_directory: The path to the backup directory
    """
    if not out_file_path:
        out_file_path = self.logstash_jvm_config_path
    super(JavaHeapOptionsConfigManager, self).commit(out_file_path, backup_directory)