# {py:mod}`arelle.logging.handlers.StructuredMessageLogHandler`

```{py:module} arelle.logging.handlers.StructuredMessageLogHandler
```

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`StructuredMessageLogHandler <arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`REFS <arelle.logging.handlers.StructuredMessageLogHandler.REFS>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.REFS
    :summary:
    ```
* - {py:obj}`MSG <arelle.logging.handlers.StructuredMessageLogHandler.MSG>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.MSG
    :summary:
    ```
* - {py:obj}`MESSAGE_CODE <arelle.logging.handlers.StructuredMessageLogHandler.MESSAGE_CODE>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.MESSAGE_CODE
    :summary:
    ```
* - {py:obj}`LEVELNAME <arelle.logging.handlers.StructuredMessageLogHandler.LEVELNAME>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.LEVELNAME
    :summary:
    ```
* - {py:obj}`ARGS <arelle.logging.handlers.StructuredMessageLogHandler.ARGS>`
  - ```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.ARGS
    :summary:
    ```
````

### API

````{py:data} REFS
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.REFS
:value: >
   'refs'

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.REFS
```

````

````{py:data} MSG
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.MSG
:value: >
   'msg'

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.MSG
```

````

````{py:data} MESSAGE_CODE
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.MESSAGE_CODE
:value: >
   'messageCode'

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.MESSAGE_CODE
```

````

````{py:data} LEVELNAME
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.LEVELNAME
:value: >
   'levelname'

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.LEVELNAME
```

````

````{py:data} ARGS
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.ARGS
:value: >
   'args'

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.ARGS
```

````

`````{py:class} StructuredMessageLogHandler(cntlr: arelle.Cntlr.Cntlr | None = None)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler

Bases: {py:obj}`arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler`

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.__init__
```

````{py:method} flush() -> None
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.flush

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.flush
```

````

````{py:method} emit(logRecord: logging.LogRecord) -> None
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.emit

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.emit
```

````

````{py:method} get_message(log_record: logging.LogRecord) -> str | tuple[object, ...] | collections.abc.Mapping[str, object] | None
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.get_message
:staticmethod:

```{autodoc2-docstring} arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.get_message
```

````

````{py:attribute} logRecordBuffer
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.logRecordBuffer
:type: list[logging.LogRecord]
:value: >
   None

````

````{py:attribute} cntlr
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.cntlr
:type: arelle.Cntlr.Cntlr | None
:value: >
   None

````

````{py:attribute} filename
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.filename
:type: str | None
:value: >
   None

````

````{py:attribute} filemode
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.filemode
:type: str
:value: >
   None

````

````{py:attribute} htmlTitle
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.htmlTitle
:type: str
:value: >
   'Arelle Message Log'

````

````{py:method} clearLogBuffer() -> None
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.clearLogBuffer

````

````{py:method} getXml(clearLogBuffer: bool = True, includeDeclaration: bool = True) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.getXml

````

````{py:method} getJson(clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.getJson

````

````{py:method} getHtml(clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.getHtml

````

````{py:method} getLines(clearLogBuffer: bool = True) -> list[str]
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.getLines

````

````{py:method} getText(separator: str = '\n', clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.getText

````

````{py:attribute} logTextMaxLength
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.logTextMaxLength
:type: int
:value: >
   None

````

````{py:method} recordToXml(logRec: logging.LogRecord) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.recordToXml

````

````{py:method} recordToJson(logRec: logging.LogRecord) -> dict[str, typing.Any]
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.recordToJson

````

````{py:method} recordToHtml(logRec: logging.LogRecord) -> str
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.recordToHtml

````

````{py:method} get_name()
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.get_name

````

````{py:method} set_name(name)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.set_name

````

````{py:attribute} name
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.name
:value: >
   'property(...)'

````

````{py:method} createLock()
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.createLock

````

````{py:method} acquire()
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.acquire

````

````{py:method} release()
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.release

````

````{py:method} setLevel(level)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.setLevel

````

````{py:method} format(record)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.format

````

````{py:method} handle(record)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.handle

````

````{py:method} setFormatter(fmt)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.setFormatter

````

````{py:method} close()
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.close

````

````{py:method} handleError(record)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.handleError

````

````{py:method} addFilter(filter)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.addFilter

````

````{py:method} removeFilter(filter)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.removeFilter

````

````{py:method} filter(record)
:canonical: arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler.filter

````

`````