61 lines
2.0 KiB
Plaintext
61 lines
2.0 KiB
Plaintext
---
|
|
title: IgnisLogReader
|
|
description: API reference for qiskit.ignis.logging.IgnisLogReader
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit.ignis.logging.IgnisLogReader
|
|
---
|
|
|
|
# IgnisLogReader
|
|
|
|
<Class id="qiskit.ignis.logging.IgnisLogReader" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.7/qiskit/ignis/logging/ignis_logging.py" signature="IgnisLogReader" modifiers="class">
|
|
Bases: `object`
|
|
|
|
Class to read from Ignis log files
|
|
|
|
Reads and constructs tabular representation of logged data based on date/time and key criteria
|
|
|
|
## Methods
|
|
|
|
### get\_log\_files
|
|
|
|
<Function id="qiskit.ignis.logging.IgnisLogReader.get_log_files" signature="IgnisLogReader.get_log_files()">
|
|
Get Names of all log files (several may be present due to logging file rotation). File names are sorted by modification time.
|
|
|
|
**Returns**
|
|
|
|
list of all log file names
|
|
|
|
**Return type**
|
|
|
|
list
|
|
</Function>
|
|
|
|
### read\_values
|
|
|
|
<Function id="qiskit.ignis.logging.IgnisLogReader.read_values" signature="IgnisLogReader.read_values(log_files=None, keys=None, from_datetime=None, from_datetime_format=None, to_datetime=None, to_datetime_format=None)">
|
|
Retrieve log lines using key and date/time filtering criteria
|
|
|
|
#### Params:
|
|
|
|
log\_files: List of log files to read from keys: Retrieve only key value pairs of corresponding to keys A row with no matching keys will not be retrieved. If not specified, all keys are retrieved (optional)
|
|
|
|
from\_datetime(None): Retrieve only rows newer than the given date and time
|
|
|
|
from\_datetime\_format(None): datetime format string. If not specified will assume “%Y/%m/%d %H:%M:%S”
|
|
|
|
to\_datetime(None): Retrieve only rows older than the given date and time
|
|
|
|
to\_datetime\_format(None): datetime format string. If not specified will assume “%Y/%m/%d %H:%M:%S”
|
|
|
|
**Returns**
|
|
|
|
A list containing the retrieved rows of key pair values
|
|
|
|
**Return type**
|
|
|
|
list
|
|
</Function>
|
|
</Class>
|
|
|