synology_apm.sdk.collections.logs module

LogCollection — collection interface for server-scoped log queries.

class synology_apm.sdk.collections.logs.LogCollection(session)

Bases: object

Collection interface for querying server-scoped logs in APM.

Accessed via APMClient.logs; should not be instantiated directly. All methods require a BackupServer to route the request to the correct backup server. Only BackupServerType.DP (ActiveProtect Appliance) servers support these log queries; the SDK does not pre-validate the server type before sending the request.

async list_activity(server, *, levels=None, log_type=None, since=None, until=None, keyword=None, limit=25, offset=0)

List activity logs from the specified backup server.

Parameters:

  • server (BackupServer) – Target backup server (obtained from BackupServerCollection).

  • levels (list[LogLevel] | None) – Filter by severity level; pass multiple values to include more than one.

  • log_type (APMActivityLogType | None) – Filter by log category. Single value only.

  • since (datetime | None) – Start of time range (inclusive).

  • until (datetime | None) – End of time range (inclusive).

  • keyword (str | None) – Keyword search string.

  • limit (int) – Maximum number of records to return (default 25).

  • offset (int) – Pagination start offset (default 0).

Returns:

(list of APMActivityLog, None — total count is not available for this log type)

Return type:

ListResult[APMActivityLog]

async list_drive(server, *, levels=None, since=None, until=None, keyword=None, location=None, limit=25, offset=0)

List drive information logs from the specified backup server.

Parameters:

  • server (BackupServer) – Target backup server (obtained from BackupServerCollection).

  • levels (list[LogLevel] | None) – Filter by severity level; pass multiple values to include more than one.

  • since (datetime | None) – Start of time range (inclusive).

  • until (datetime | None) – End of time range (inclusive).

  • keyword (str | None) – Keyword search string.

  • location (str | None) – Drive location filter.

  • limit (int) – Maximum number of records to return (default 25).

  • offset (int) – Pagination start offset (default 0).

Returns:

(list of DriveLog, total count)

Return type:

ListResult[DriveLog]

async list_connection(server, *, levels=None, since=None, until=None, keyword=None, limit=25, offset=0)

List connection logs from the specified backup server.

Parameters:

  • server (BackupServer) – Target backup server (obtained from BackupServerCollection).

  • levels (list[LogLevel] | None) – Filter by severity level; pass multiple values to include more than one.

  • since (datetime | None) – Start of time range (inclusive).

  • until (datetime | None) – End of time range (inclusive).

  • keyword (str | None) – Keyword search string.

  • limit (int) – Maximum number of records to return (default 25).

  • offset (int) – Pagination start offset (default 0).

Returns:

(list of ConnectionLog, total count)

Return type:

ListResult[ConnectionLog]

async list_system(server, *, levels=None, since=None, until=None, keyword=None, limit=25, offset=0)

List advanced system logs from the specified backup server.

Parameters:

  • server (BackupServer) – Target backup server (obtained from BackupServerCollection).

  • levels (list[LogLevel] | None) – Filter by severity level; pass multiple values to include more than one.

  • since (datetime | None) – Start of time range (inclusive).

  • until (datetime | None) – End of time range (inclusive).

  • keyword (str | None) – Keyword search string.

  • limit (int) – Maximum number of records to return (default 25).

  • offset (int) – Pagination start offset (default 0).

Returns:

(list of SystemLog, total count)

Return type:

ListResult[SystemLog]