POST лога нагрузки - История изменений

IKuznetsov в 11:33, 29 декабря 2024

2024-12-29T11:33:27Z

← Предыдущая версия		Версия от 11:33, 29 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Мониторинг логов / POST лога нагрузки'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%84%D0%B0%D0%B9%D0%BB%D0%B0-,%D0%9C%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%20%D0%BB%D0%BE%D0%B3%D0%BE%D0%B2,-GET%20%D0%BB%D0%BE%D0%B3%D0%B0%20%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0 Мониторинг логов] / POST лога нагрузки'''''

	Отправляет пользовательские логи в АппОптима.		Отправляет пользовательские логи в АппОптима.
Строка 259:		Строка 259:
	"content": "Exception: Custom error log sent via Generic Log Ingest"		"content": "Exception: Custom error log sent via Generic Log Ingest"
	}		}
	]~~</code>~~		]
	==Ответ==		==Ответ==
	===Коды ответов===		===Коды ответов===
Строка 330:		Строка 330:
	"message": "string"		"message": "string"
	}		}
	}~~</code>~~		}

IKuznetsov в 15:06, 26 декабря 2024

2024-12-26T15:06:42Z

← Предыдущая версия		Версия от 15:06, 26 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / ~~[[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|~~Эндпойнты среды]] / ~~[[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5\|~~Развёртывание]] / Мониторинг логов / POST лога нагрузки'''''		'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Мониторинг логов / POST лога нагрузки'''''

	Отправляет пользовательские логи в ~~Ключ-АСТРОМ~~.		Отправляет пользовательские логи в АппОптима.

	Для этой конечной точки требуется АктивныйШлюз с включенным модулем сбора аналитики логов . Этот модуль включен по умолчанию на всех ваших АктивныхШлюзах.		Для этой конечной точки требуется АктивныйШлюз с включенным модулем сбора аналитики логов . Этот модуль включен по умолчанию на всех ваших АктивныхШлюзах.
Строка 239:		Строка 239:
	===JSON-модель тела запроса===		===JSON-модель тела запроса===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~[		<[
	{		{
	"content": "Exception: Custom error log sent via Generic Log Ingest",		"content": "Exception: Custom error log sent via Generic Log Ingest",
Строка 325:		Строка 325:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"details": {		"details": {
	"code": 1,		"code": 1,

ENetrebin в 15:26, 28 июня 2024

2024-06-28T15:26:45Z

← Предыдущая версия		Версия от 15:26, 28 июня 2024
Строка 1:		Строка 1:
	'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5\|Развёртывание]] ~~/ Расширения 2.0~~ / Мониторинг логов / POST лога нагрузки'''''		'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5\|Развёртывание]] / Мониторинг логов / POST лога нагрузки'''''

	Отправляет пользовательские логи в Ключ-АСТРОМ.		Отправляет пользовательские логи в Ключ-АСТРОМ.

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-27T17:54:20Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

Новая страница

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / Расширения 2.0 / Мониторинг логов / POST лога нагрузки'''''

Отправляет пользовательские логи в Ключ-АСТРОМ.

Для этой конечной точки требуется АктивныйШлюз с включенным модулем сбора аналитики логов . Этот модуль включен по умолчанию на всех ваших АктивныхШлюзах.

Запрос использует один из следующих типов полезной нагрузки:
*<code>text/plain</code>— ограничено одним событием в логе.
*<code>application/json</code>— поддерживает несколько событий лога в одной полезной нагрузке.
Обязательно установите правильный заголовок Content-Type и закодируйте полезную нагрузку с помощью UTF-8 : <code>application/json; charset=utf-8</code>.

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
|POST
|
*Среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}:9999/e/{идентификатор-вашей-среды}/api/v2/logs/ingest</nowiki>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение '''Ingest logs''' ( <code>logs.ingest</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|LogMessageJson
|Тело запроса. Содержит одно или несколько событий лога для приема.
Конечная точка принимает один из следующих типов полезной нагрузки, определенных заголовком Accept :
*<code>text/plain</code>: поддерживает только одно событие журнала.
*<code>application/json</code>: поддерживает несколько событий журнала в одной полезной нагрузке.
|body
|по желанию
|}
===Объекты тела запроса===
====Объект <code>LogMessageJson</code>====
Сообщение лога в формате JSON. Используйте один объект, представляющий одно событие, или массив объектов, представляющих несколько событий.

Объект может содержать следующие типы ключей без учета регистра (возможные значения ключей перечислены ниже):
*Отметка времени:
**Самая ранняя отметка времени для события лога — это текущее время минус 24 часа. Если событие лога содержит отметку времени раньше, чем текущее время минус 24 часа, событие отбрасывается, а универсальный API приема лога возвращает <code>400</code>код ответа.
**Последняя отметка времени для события лога — это текущее время плюс 12 часов. Если событие лога содержит отметку времени позже, чем текущее время плюс 12 часов, событие отбрасывается, а универсальный API приема лога возвращает <code>400</code>код ответа.
**Поддерживаются следующие форматы: миллисекунды UTC, RFC3339 и RFC3164. Для отсутствующей метки времени используется текущая метка времени. Для неподдерживаемого формата временной метки используется текущая временная метка, а значение неподдерживаемого формата временной метки сохраняется в неиндексированном <code>unparsed_timestamp</code>атрибуте.
*Строгость. Если не установлено, <code>NONE</code>используется.
*Содержание. Если ключ содержимого не задан, весь JSON анализируется как содержимое.
*Семантический признак. Поддерживаются только значения этого <code>String</code>типа. Семантические атрибуты индексируются и могут использоваться в запросах. Они также отображаются в агрегатах (фасетах). Если встречается неподдерживаемый ключ, он не индексируется и не может использоваться в индексировании и агрегировании.
Значением объекта может быть одна константа или, в случае семантического атрибута, массив констант. Длина значения ограничена. Любой контент, превышающий лимит, обрезается. Ограничения по умолчанию:
*Атрибуты: до 50 атрибутов.
*Содержимое: 8 192 байта.
*Семантический атрибут: 250 байт на значение, до 32 значений атрибута
Поддерживаемые ключи отметки времени:
*@timestamp
*_timestamp
*date
*eventtime
*published_date
*syslog.timestamp
*timestamp
Поддерживаемые ключи содержимого:
*body
*content
*message
*payload
Поддерживаемые ключи серьезности:
*level
*loglevel
*severity
*status
*syslog.severity
Поддерживаемые ключи семантических атрибутов:
*audit.action
*audit.identity
*audit.result
*aws.account.id
*aws.arn
*aws.log_group
*aws.log_stream
*aws.region
*aws.resource.id
*aws.resource.type
*aws.service
*azure.location
*azure.resource.group
*azure.resource.id
*azure.resource.name
*azure.resource.type
*azure.subscription
*cloud.account.id
*cloud.availability_zone
*cloud.provider
*cloud.region
*container.image.name
*container.image.tag
*container.name
*db.cassandra.keyspace
*db.connection_string
*db.hbase.namespace
*db.jdbc.driver_classname
*db.mongodb.collection
*db.mssql.instance_name
*db.name
*db.operation
*db.redis.database_index
*db.statement
*db.system
*db.user
*device.address
*dt.active_gate.group.name
*dt.active_gate.id
*dt.code.filepath
*dt.code.func
*dt.code.lineno
*dt.code.ns
*dt.ctg.calltype
*dt.ctg.extendmode
*dt.ctg.gatewayurl
*dt.ctg.program
*dt.ctg.rc
*dt.ctg.requesttype
*dt.ctg.serverid
*dt.ctg.termid
*dt.ctg.transid
*dt.ctg.userid
*dt.entity.cloud_application
*dt.entity.cloud_application_instance
*dt.entity.cloud_application_namespace
*dt.entity.container_group
*dt.entity.container_group_instance
*dt.entity.custom_device
*dt.entity.host
*dt.entity.kubernetes_cluster
*dt.entity.kubernetes_node
*dt.entity.process_group
*dt.entity.process_group_instance
*dt.event.group_label
*dt.event.key
*dt.events.root_cause_relevant
*dt.exception.messages
*dt.exception.serialized_stacktraces
*dt.exception.types
*dt.extension.config.id
*dt.extension.ds
*dt.extension.name
*dt.extension.status
*dt.host.ip
*dt.host.smfid
*dt.host.snaid
*dt.host_group.id
*dt.http.application_id
*dt.http.context_root
*dt.kubernetes.cluster.id
*dt.kubernetes.cluster.name
*dt.kubernetes.config.id
*dt.kubernetes.event.involved_object.kind
*dt.kubernetes.event.involved_object.name
*dt.kubernetes.event.reason
*dt.kubernetes.node.name
*dt.kubernetes.node.system_uuid
*dt.kubernetes.topmost_controller.kind
*dt.kubernetes.workload.kind
*dt.kubernetes.workload.name
*dt.network_zone.id
*dt.os.description
*dt.os.type
*dt.process.commandline
*dt.process.executable
*dt.process.name
*dt.source_entity
*dt.source_entity_name
*dt.source_entity_type
*faas.id
*faas.instance
*faas.name
*faas.version
*gcp.instance.id
*gcp.instance.name
*gcp.project.id
*gcp.region
*gcp.resource.type
*host.hostname
*host.id
*host.image.id
*host.image.name
*host.image.version
*host.name
*host.type
*http.client_ip
*http.flavor
*http.host
*http.method
*http.route
*http.scheme
*http.server_name
*http.status_code
*http.status_text
*http.target
*http.url
*k8s.cluster.name
*k8s.container.name
*k8s.cronjob.name
*k8s.cronjob.uid
*k8s.daemonset.name
*k8s.daemonset.uid
*k8s.deployment.name
*k8s.deployment.uid
*k8s.job.name
*k8s.job.uid
*k8s.namespace.name
*k8s.pod.name
*k8s.pod.uid
*k8s.replicaset.name
*k8s.replicaset.uid
*k8s.statefulset.name
*k8s.statefulset.uid
*log.source
*net.host.ip
*net.host.name
*net.host.port
*net.peer.ip
*net.peer.name
*net.peer.port
*net.transport
*process.technology
*service.instance.id
*service.name
*service.namespace
*service.version
*snmp.trap_oid
*span_id
*trace_id
*winlog.eventid
*winlog.level
*winlog.opcode
*winlog.provider
*winlog.task
Объект не предоставляет никаких параметров.
===JSON-модель тела запроса===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>[
{
"content": "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog",
"timestamp": "2022-01-17T22:12:31.0000",
"severity": "error",
"custom.attribute": "attribute value"
},
{
"content": "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog",
"timestamp": "2022-01-17T22:12:35.0000"
},
{
"content": "Exception: Custom error log sent via Generic Log Ingest",
"log.source": "/var/log/syslog"
},
{
"content": "Exception: Custom error log sent via Generic Log Ingest"
}
]</code>
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|SuccessEnvelope
|Только часть входных событий была принята из-за ограничений размера события или проблем с анализом JSON.
|-
|204
|
|Успех. Ответ не имеет тела.
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|-
|402
|ErrorEnvelope
|Не удалось. Вы не можете добавить больше логов в хранилище, так как закончились единицы данных ИИ (DDU). Приобретите дополнительные DDU.
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует. Это может произойти, если АктивныйШлюз недоступен с включенным модулем Log Analytics Collector.
|-
|413
|ErrorEnvelope
|Не удалось. Размер полезной нагрузки запроса слишком велик. Это может произойти, когда размер полезной нагрузки в байтах превышает ограничение или когда принятые полезные данные представляют собой массив JSON, размер которого превышает ограничение.
|-
|429
|ErrorEnvelope
|Не удалось. Слишком много запросов. Это происходит, когда прием логов отключен.
|-
|501
|ErrorEnvelope
|Не удалось. Сервер либо не распознает метод запроса, либо не может выполнить запрос. Может произойти, если не включено индексированное хранилище логов.
|}
===Объекты тела ответа===
====Объект <code>SuccessEnvelope</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|details
|Success
| -
|}
====Объект <code>Success</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|code
|integer
|Код состояния HTTP
|-
|message
|string
|Подробное сообщение
|}
===JSON-модель тела ответа===
<code>{
"details": {
"code": 1,
"message": "string"
}
}</code>