bmSearch  0.0.4
Public Member Functions | Static Public Attributes | List of all members
bmSearch.bmSearch Class Reference

Public Member Functions

def __init__ (self, kwargs)
 

Static Public Attributes

 logger
 
 p
 

Detailed Description

bmSearch Class 
        main class from which we call all methods/classes to parse, retrieve pertinent values and post then to an Elasticsearch engine.        

Constructor & Destructor Documentation

def bmSearch.bmSearch.__init__ (   self,
  kwargs 
)
__init__ :
        constructor accept kwargs

        **kwargs: 
                file   : path to file to parse. I can be plain text, gzip or bzip2 compressed. By default what configured in /etc/bmSearch/config.py

                method : how to read the file, 2 possibilities
                        - "file" : read the file and exit after reach end file. By default.
                        - "stream" : connect to the file and stream data. No exit while programm running

                action : tell what to do, 2 cases
                        - "storeToELK"  : to store in Elasticsearch instance configured in /etc/bmSearch/config.py
                        - "updateToELK" : to update in Elasticsearch instance data (deliveredRecip)
        
        Constructor call mailLogParser(**kwargs), mailLogParser().getFileContent(), mailLogParser().parseContent() and mailLogParser().updateEntry()
31  def __init__(self,**kwargs):
32  """
33  __init__ :
34  constructor accept kwargs
35 
36  **kwargs:
37  file : path to file to parse. I can be plain text, gzip or bzip2 compressed. By default what configured in /etc/bmSearch/config.py
38 
39  method : how to read the file, 2 possibilities
40  - "file" : read the file and exit after reach end file. By default.
41  - "stream" : connect to the file and stream data. No exit while programm running
42 
43  action : tell what to do, 2 cases
44  - "storeToELK" : to store in Elasticsearch instance configured in /etc/bmSearch/config.py
45  - "updateToELK" : to update in Elasticsearch instance data (deliveredRecip)
46 
47  Constructor call mailLogParser(**kwargs), mailLogParser().getFileContent(), mailLogParser().parseContent() and mailLogParser().updateEntry()
48  """
49 

Member Data Documentation

bmSearch.bmSearch.logger
static
LOGGER
bmSearch.bmSearch.p
static

The documentation for this class was generated from the following file: