Analyzer

class duetector.analyzer.base.Analyzer(config: Config | dict[str, Any] | None = None, *args, **kwargs)[source]

Bases: Configuable

A base class for all analyzers.

async analyze()[source]
async brief(tracers: list[str] | None = None, collector_ids: list[str] | None = None, start_datetime: datetime | None = None, end_datetime: datetime | None = None, with_details: bool = True, distinct: bool = False, inspect_type: bool = False) → AnalyzerBrief[source]

Get a brief of this analyzer.

Parameters:

  • tracers (Optional[List[str]], optional) – Tracers. Defaults to None, all tracers will be queried. If a specific tracer is not found, it will be ignored.

  • collector_ids (Optional[List[str]], optional) – Collector ids. Defaults to None, all collector ids will be queried. If a specific collector id is not found, it will be ignored.

  • start_datetime (Optional[datetime], optional) – Start time. Defaults to None.

  • end_datetime (Optional[datetime], optional) – End time. Defaults to None.

  • with_details (bool, optional) – With details. Defaults to True.

  • distinct (bool, optional) – Distinct. Defaults to False.

  • inspect_type (bool, optional) – Weather fileds’s value is type or type name. Defaults to False, type name.

Returns:

A brief of this analyzer.

Return type:

AnalyzerBrief

property config_scope

Config scope for this analyzer.

Subclasses cloud override this.

default_config = {'disabled': False}

Default config for Analyzer.

property disabled: bool

Weather this analyzer is disabled.

get_all_collector_ids() → list[str][source]

Get all collector id from storage.

Returns:

List of collector id.

Return type:

List[str]

get_all_tracers() → list[str][source]

Get all tracers from storage.

Returns:

List of tracer’s name.

Return type:

List[str]

async query(tracers: list[str] | None = None, collector_ids: list[str] | None = None, start_datetime: datetime | None = None, end_datetime: datetime | None = None, start: int = 0, limit: int = 20, columns: list[str] | None = None, where: dict[str, Any] | None = None, distinct: bool = False, order_by_asc: list[str] | None = None, order_by_desc: list[str] | None = None) → list[Tracking][source]

Query all tracking records from backend.

Note

Some storage implementations do not guarantee the correct implementation of all parameters. Some parameters may be ignored.

Parameters:

  • tracers (Optional[List[str]], optional) – Tracer’s name. Defaults to None, all tracers will be queried.

  • collector_ids (Optional[List[str]], optional) – Collector id. Defaults to None, all collector id will be queried.

  • start_datetime (Optional[datetime], optional) – Start time. Defaults to None.

  • end_datetime (Optional[datetime], optional) – End time. Defaults to None.

  • start (int, optional) – Start index. Defaults to 0.

  • limit (int, optional) – Limit of records, depends on backend implementations. Defaults to 20. 0 means no limit.

  • columns (Optional[List[str]], optional) – Columns to query. Defaults to None, all columns will be queried.

  • where (Optional[Dict[str, Any]], optional) – Where clause. Defaults to None.

  • distinct (bool, optional) – Distinct. Defaults to False.

  • order_by_asc (Optional[List[str]], optional) – Order by asc. Defaults to None.

  • order_by_desc (Optional[List[str]], optional) – Order by desc. Defaults to None.

Returns:

List of tracking records.

Return type:

List[duetector.analyzer.models.Tracking]

Avaliable Analyzer

Data Models