Документация / API / Json / Лог / GetLogs

---

Получение записей лога по критериям

АдресВашегоСервисаApi/GetLogs

Метод возвращает список записей лога, соответствующих указанным критериям.
Незаполненные критерии не учитываются.
Все критерии объединяются по условию "И" (AND).
Записи сортируются по возрастанию даты и порядка (поле Order). Максимум можно получить 1000 записей.

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "From": "2016-04-30T23:25:43.511Z",
        "To": "2016-04-30T23:25:43.511Z",
        "Levels": [
            "Info",
            ...
        ]
        "Context": "Context",
        "Message": "Message",
        "PropertyName": "Property name",
        "PropertyValue": "Property value",
        "MaxCount": 1000
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента, для которого ищутся записи лога.
• From (datetime) — Дата и время начала интервала поиска лога. Необязательная.
• To (datetime) — Дата и время окончания интервала поиска лога. Необязательная.
• Levels (datetime) — Набор уровней лога для поиска. Необязательный. Может иметь значения: Trace, Debug, Info, Warning, Error, Fatal.
• Context (string) — Контекст записи лога. Необязательный. Ищется по совпадению начала строки.
• Message (string) — Текст записи лога. Необязательный. Ищется по вхождению подстроки.
• PropertyName (string) — Название дополнительного свойства. Необязательное. Ищется по вхождению подстроки.
• PropertyValue (string) — Значение дополнительного свойства. Необязательное. Ищется по вхождению подстроки.
• MaxCount (int) — Максимальное количество записей в ответе. Необязательное. Не может быть больше 1000. Если не указано, будет равно 1000.

{
    "Data": [
        {
            "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "Date": "2016-04-30T23:25:43.511Z",
            "Order": 0,
            "Level": "Info",
            "Message": "Log message",
            "Context": "Context",
            "Properties": [
                {
                    "Name": "Property1",
                    "Value": "10.0",
                    "Type": "double"
                },
                ...
            ]
        },
        ...
    ]
    "Code": 10
}

Здесь:

• Id (guid) — Уникальный Id записи лога.
• Date (datetime) — Дата и время записи лога.
• Order (int) — Порядок записей для совпадающей даты и времени.
• Level (string) — Уровень записи лога. Может иметь значения: Trace, Debug, Info, Warning, Error, Fatal.
• Message (string) — Текст записи лога.
• Context (string) — Название контекста, для многопоточного лога.
• Properties (array) — Массив дополнительных свойств лога:
  • Name (string) — Название свойства.
  • Value — Значение свойства.
  • Type (string) — Тип свойства. Может быть одним из: Boolean, DateTime, Double, Int32, Int64, Binary, String, Guid.

Если компонент с указанным Id не существует, то Code будет равен 1100, а Data будет пустым.