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

---

Отправка одной записи лога

Для оптимизации рекомендуется кешировать лог на стороне клиента и отправлять сразу набор записей с помощью метода SendLogs.

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "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"
            },
            ...
        ]
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента, для которого отправляется лог.
• Date (datetime) — Дата и время записи лога. Необязательная. Если не указана, будет использовано текущее значение на стороне сервиса.
• Order (int) — Порядок записей для совпадающей даты и времени. Может получиться так, что на один и тот же момент времени приходится несколько записей лога. Чтобы хранить их в нужном порядке, используется это поле. Большее значение означает более позднюю запись. Необязательный, по умолчанию равен 0.
• Level (string) — Уровень записи лога. Может иметь значения: Trace, Debug, Info, Warning, Error, Fatal. Необязательный, по умолчанию равен Info.
• Message (string) — Текстовое описание события. Максимальная длина 4000 символов.
• Context (string) — Название контекста, для многопоточного лога. Необязательное. Максимальная длина 255 символов.
• Properties (array) — Массив дополнительных свойств лога:
  • Name (string) — Название свойства.
  • Value — Значение свойства.
  • Type (string) — Тип свойства. Может быть одним из: Boolean, DateTime, Double, Int32, Int64, Binary, String, Guid.
  При наличии в событии стека рекомендуется записывать его в свойство с названием stack.

{
    "Data": "",
    "Code": 10
}

В ответе возвращается только код результата.

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