The service log feature of Simple Log Service (SLS) records detailed, important, and task run logs. This topic describes the log fields for log types.
Log types
When you enable the service log feature, you can select the service log types to generate. The following table lists the available log types.
To ensure compatibility for your custom query statements, specify the log type by using __topic__: XXX.
|
Type |
Overview |
Logstore name |
Details |
Description |
|
Detailed logs |
Records operations performed on all resources in your project, including create, modify, update, delete, read, and write operations. Note
Access through the JDBC protocol is not logged. |
internal-operation_log |
Detailed operation logs for all API requests and operations, including requests from clients such as the console, consumer groups, and SDKs. |
|
|
important logs |
Includes Logstore-level consumer group delay logs, and Logtail error, heartbeat, and statistics logs. |
internal-diagnostic_log |
Consumer group delay logs are generated every 2 minutes. To query consumer group delay logs, specify |
|
|
Records Logtail errors. A log is generated every 30 seconds. If the same type of error occurs multiple times within this period, the system records only the total number of occurrences and one random error message. To query Logtail alert logs, specify |
||||
|
Records Logtail collection statistics. A log is generated every 10 minutes. To query Logtail collection logs, specify |
||||
|
Records periodic status logs from Logtail. A log is generated every minute. To query Logtail status logs, specify |
||||
|
operational logs |
Records the operational metrics and operational logs for data transformation, Scheduled SQL, data import, and data shipping jobs in a project. |
internal-diagnostic_log |
A log is generated for each Scheduled SQL instance after it completes. To query Scheduled SQL operational logs, specify |
|
|
Operational logs for data transformation, data import, and data shipping jobs |
Logs are generated every minute, but only if the job's data source contains data. To query these operational logs, specify |
Detailed logs
According to the Method field, detailed logs are divided into three categories: read operations, write operations, and resource operations.
|
Category |
Request method |
|
Read operation |
Read operation logs are generated when you call the following API operations:
|
|
Write operation |
Write operation logs are generated when you call the following API operations:
|
|
Resource operation |
All other API operations generate resource operation logs. For example, |
Common fields in detailed logs
|
Parameter |
Description |
Example |
|
APIVersion |
The API version. |
0.6.0 |
|
AccessKeyId |
The access key used to access Log Service. |
LTA****TRx |
|
CallerType |
The type of the API caller. |
Subuser |
|
InvokerUid |
The Alibaba Cloud account ID of the user who performed the operation. |
175****532 |
|
Latency |
The request latency. Unit: microseconds. |
123279 |
|
LogStore |
The name of the LogStore targeted by the operation. |
LogStore-1 |
|
Method |
The request method that generated the log. |
GetLogStoreLogs |
|
NetOutFlow |
The volume of read traffic. Unit: bytes. |
120 |
|
NetworkOut |
The volume of read traffic over the internet. Unit: bytes. |
10 |
|
Project |
The name of the Project targeted by the operation. |
project-1 |
|
RequestId |
The request ID. |
8AEADC8B0AF2FA2592C9**** |
|
SourceIP |
The source IP address of the client. |
47.100.**.** |
|
Status |
The status code returned in the response. |
200 |
|
UserAgent |
The user agent of the client. |
sls-java-sdk-v-0.6.1 |
Fields specific to read operation logs
|
Parameter |
Description |
Example |
|
BeginTime |
The start time of the request, represented as a UNIX timestamp. |
1523868463 |
|
DataStatus |
The data status of the response. Valid values include |
OK |
|
EndTime |
The end time of the request, represented as a UNIX timestamp. |
1523869363 |
|
Offset |
The line offset in a |
20 |
|
Query |
The original query statement. |
UserAgent: [consumer-group-java]* |
|
RequestLines |
The number of lines requested. |
100 |
|
ResponseLines |
The number of lines returned. |
100 |
|
Reverse |
The order in which logs are returned, based on their timestamps.
|
0 |
|
TermUnit |
The number of words in the query statement after tokenization. |
0 |
|
Topic |
The log topic. |
topic-1 |
Fields specific to write operation logs
|
Parameter |
Description |
Example |
|
InFlow |
The size of raw data written. Unit: bytes. |
200 |
|
InputLines |
The number of lines written in the request. |
10 |
|
NetInflow |
The size of the data written after compression. Unit: bytes. |
100 |
|
Shard |
The ID of the Shard where the data is written. |
1 |
|
Topic |
The log topic. |
topic-1 |
Consumer group lag logs
|
Parameter |
Description |
Example |
|
consumer_group |
The name of the consumer group. |
consumer-group-1 |
|
fallbehind |
The lag in seconds between the consumer's current position and the end of the log. |
12345 |
|
Logstore |
The name of the Logstore. |
LogStore-1 |
|
Project |
The name of the Project. |
project-1 |
|
shard |
The ID of the shard being consumed. |
1 |
Logtail alert logs
|
Parameter |
Description |
Example |
|
alarm_count |
The number of alerts within the time window. |
10 |
|
alarm_message |
A sample of the raw log that triggered the alert. |
M_INFO_COL,all_status_monitor,T22380,0,2018-04-17 10:48:25.0,AY66K,AM5,2018-04-17 10:48:25.0,2018-04-17 10:48:30.561,i-23xebl5ni.1569395.715455,901,00789b |
|
alarm_type |
The alert type. |
REGISTER_INOTIFY_FAIL_ALARM |
|
Logstore |
The name of the Logstore. |
Logstore-1 |
|
os |
The operating system, such as Linux or Windows. |
Linux |
|
Project |
The name of the Project. |
Project-1 |
|
source_ip |
The IP address of the server where Logtail is installed. |
47.100.. |
|
version |
The Logtail version. |
0.14.2 |
Logtail collection logs
Logtail collection logs are classified into two types based on the file_name field.
-
Collection statistics for a single log file.
-
Collection statistics for a Logstore, where the file_name field is set to
logstore_statistics.
This table describes the fields in Logtail collection logs.
|
Parameter |
Description |
Example |
|
Logstore |
The name of the Logstore. |
Logstore-1 |
|
config_name |
The name of the Logtail configuration. The name is globally unique and is formatted as |
##1.0##project-1$LogStore-1 |
|
error_line |
The raw log entry that caused the error. |
M_INFO_COL,all_status_monitor,T22380,0,2018-04-17 10:48:25.0,AY66K,AM5,2018-04-17 10:48:25.0,2018-04-17 10:48:30.561,i-23xebl5ni.1569395.715455,901,00789b |
|
file_dev |
The device ID of the log file. Note
This field is not applicable if the |
123 |
|
file_inode |
The inode of the log file. Note
This field is not applicable if the |
124 |
|
file_name |
The full path of the log file or the value |
/abc/file_1 |
|
file_size |
The size of the log file, in bytes. |
12345 |
|
history_data_failures |
The cumulative number of data processing failures. |
0 |
|
last_read_time |
The UNIX timestamp of the latest read operation within the time window. |
1525346677 |
|
Project |
The name of the Project. |
project-1 |
|
logtail_version |
The version of Logtail. |
0.14.2 |
|
os |
The operating system. |
Windows |
|
parse_failures |
The number of lines that failed to be parsed within the time window. |
12 |
|
read_avg_delay |
The average difference between the file size and the read offset for each read operation within the time window. |
65 |
|
read_count |
The number of read operations within the time window. |
10 |
|
read_offset |
The current read offset in the file, in bytes. |
12345 |
|
regex_match_failures |
The number of regular expression matching failures. |
1 |
|
send_failures |
The number of failed send operations within the time window. |
12 |
|
source_ip |
The IP address of the server where Logtail is installed. |
47.100.. |
|
succeed_lines |
The number of successfully processed log lines. |
123 |
|
time_format_failures |
The number of time format matching failures. |
122 |
|
total_bytes |
The total number of bytes read. |
12345 |
The following fields appear only in Logstore statistics, where the file_name field is set to logstore_statistics.
|
Parameter |
Description |
Example |
|
send_block_flag |
Indicates whether the send queue is blocked at the end of the time window. |
false |
|
send_discard_error |
The number of packets discarded within the time window due to data errors or insufficient permissions. |
0 |
|
send_network_error |
The number of packets that failed to be sent within the time window due to network errors. |
12 |
|
send_queue_size |
The number of unsent packets in the send queue at the end of the time window. |
3 |
|
send_quota_error |
The number of packets that failed to be sent within the time window because the quota was exceeded. |
0 |
|
send_success_count |
The number of packets successfully sent within the time window. |
12345 |
|
sender_valid_flag |
Indicates whether the send flag for the Logstore is valid at the end of the time window. Valid values:
|
true |
|
max_send_success_time |
The UNIX timestamp of the latest successful send operation within the time window. |
1525342763 |
|
max_unsend_time |
The UNIX timestamp of the most recent packet that failed to be sent from the send queue within the time window. The value is 0 if the queue is empty. |
1525342764 |
|
min_unsend_time |
The UNIX timestamp of the earliest packet that failed to be sent from the send queue within the time window. The value is 0 if the queue is empty. |
1525342764 |
Logtail status logs
|
Parameter |
Description |
Example |
|
cpu |
The CPU utilization of the Logtail process. |
0.001333156 |
|
hostname |
The hostname of the host. |
abc2.**** |
|
instance_id |
The instance ID, which is randomly generated. |
05AFE618-0701-11E8-A95B-00163E025256_10.11.12.13_151745**** |
|
ip |
The IP address of the host. |
47.100.. |
|
load |
The average system load. |
0.01 0.04 0.05 2/376 5277 |
|
memory |
The memory usage of the Logtail process, in MB. |
12 |
|
detail_metric |
The detailed metrics, in JSON format. For details, see detail_metric. |
|
|
os |
The operating system. |
Linux |
|
os_cpu |
Overall system CPU utilization. |
0.004120005 |
|
os_detail |
Detailed information about the operating system. |
2.6.32-220.23.8.tcp1.34.el6.x86_64 |
|
user |
The user name. |
user |
|
user_defined_id |
The user-defined ID. |
aliyun-log-id |
|
uuid |
The UUID of the host. |
64F28D10-D100-492C-8FDC-0C62907F**** |
|
version |
The Logtail version. |
0.14.2 |
|
project |
The Project that contains the Logtail configuration. |
my-project |
The detail_metric field is a JSON object with the following fields.
|
Parameter |
Description |
Example |
|
config_count |
The number of Logtail configurations. |
1 |
|
config_get_last_time |
The last time the Logtail configuration was fetched. |
2021-07-20 16:19:22 |
|
config_update_count |
The number of Logtail configuration updates since Logtail started. |
1 |
|
config_update_item_count |
The total number of Logtail configuration items updated since Logtail started. |
1 |
|
config_update_last_time |
The timestamp of the last Logtail configuration update. |
2021-07-20 16:18:42 |
|
env_config |
Indicates whether environment variables are used to create the Logtail configuration. |
false |
|
event_tps |
The number of events per second (TPS). |
1 |
|
last_read_event_time |
The timestamp of the last event read. |
2021-07-20 16:18:42 |
|
last_send_time |
The timestamp when data was last sent. |
2021-07-20 16:18:42 |
|
multi_config |
Indicates whether the same file is being collected by multiple Logtail configurations. |
false |
|
net_err_stat |
The number of network errors that occurred in the last 1, 5, and 15 minutes. |
0,0,0 |
|
open_fd |
The number of currently open file descriptors. |
1 |
|
plugin_enabled |
Indicates whether plugin functionality is enabled.
|
false |
|
poll_modify_size |
The number of files being monitored for modification events. |
1 |
|
polling_dir_cache |
The number of directories in the polling cache. |
1 |
|
polling_file_cache |
The number of files in the polling cache. |
1 |
|
process_bytes_ps |
The log volume processed per second, in bytes. |
1000 |
|
process_lines_ps |
The number of log lines processed per second. |
1000 |
|
process_queue_full |
The number of full processing queues. |
1 |
|
process_queue_total |
The number of processing queues. |
10 |
|
process_tps |
The number of processing transactions per second (TPS). |
0 |
|
reader_count |
The number of files currently being read. |
1 |
|
region |
The region where the host machine is located. |
cn-hangzhou |
|
register_handler |
The number of directories registered for monitoring. |
1 |
|
send_bytes_ps |
The volume of raw logs sent per second, in bytes. |
11111 |
|
send_lines_ps |
The number of log lines sent per second. |
1000 |
|
send_net_bytes_ps |
The volume of network traffic sent per second, in bytes. |
1000 |
|
send_queue_full |
The number of full send queues. |
1 |
|
send_queue_total |
The number of send queues. |
12 |
|
send_request_concurrency |
The maximum number of concurrent sending requests. |
10 |
|
send_tps |
The number of sending transactions per second (TPS). |
0.075 |
|
sender_invalid |
The number of send queues in an error state. |
0 |
|
start_time |
The startup time of the Logtail process. |
2021-07-20 16:19:22 |
|
used_sending_concurrency |
The current number of active sending requests. |
0 |
Scheduled SQL job run logs
|
Field |
Description |
Example |
|
__topic__ |
The log topic. Always |
scheduled_sql_alert |
|
project |
The project that contains the scheduled SQL job. |
my-project-name |
|
job_name |
The name of the scheduled SQL job. |
sql-16xxxxxxx-xxxxxx |
|
schedule_id |
The schedule ID. |
77****ca |
|
job_type |
The type of the scheduled SQL job. Always |
ScheduledSQL |
|
instance_id |
The ID of the instance. |
7e****dc |
|
create_time |
The creation time of the instance, as a UNIX timestamp in seconds. |
1652343365 |
|
schedule_time |
The scheduled time of the instance, as a UNIX timestamp in seconds. |
1652343360 |
|
trigger_time |
The time the instance was triggered to run, as a UNIX timestamp in seconds. |
1652343365 |
|
__time__ |
The end time of the instance run, as a UNIX timestamp in seconds. |
1652343366 |
|
status |
The execution status of the instance. Possible values are |
FAILED |
|
error_code |
The error code if the instance run failed. |
SQLFailed |
|
error_message |
The detailed error message if the instance run failed. |
sql syntax error |
|
fallbehind |
The execution latency in seconds, measured as the difference between |
85 |
|
succeed_lines |
|
100 |
Operational logs for ETL jobs
|
Parameter |
Description |
Example |
|
__topic__ |
The topic of the log. The value is always |
etl_metrics |
|
metric_type |
The type identifier of the operational log. The value is always |
ConnectorMetrics |
|
project |
The Project that contains the job. |
my-sls-project |
|
job_name |
The name of the job. |
job-16****53 |
|
instance_id |
The ID of the job instance. |
10e****b4f6 |
|
_etl_:connector_meta |
Metadata of the data source or destination. For more information, see _etl_:connector_meta. |
N/A |
|
_etl_:connector_metrics |
Operational metrics of the data source or destination. For more information, see _etl_:connector_metrics. |
N/A |
The _etl_:connector_meta field includes the following subfields.
|
Parameter |
Description |
Example |
|
action |
The operation the job performs. Valid values:
|
ingest |
|
connector |
The type of the data source or destination.
|
oss |
|
instance |
The name of the source or destination instance. |
my-oss-bucket |
|
task_id |
The task ID. |
1669277 |
|
task_name |
The task name. |
1652765276578_task_0 |
|
task_type |
The type of the task. The value is always |
CONNECTOR |
The _etl_:connector_metrics field includes the following subfields.
|
Parameter |
Description |
Example |
|
state |
The operational status of the job.
|
0 |
|
error |
The job's error message. This field is present only when an error occurs. |
fail to pull logs, unauthorized |
|
lags |
The progress of the job. The lags field is present in the logs only for data read jobs, that is, when the value of the action field is ingest. The value of this field is related to the data source type (the connector field).
|
0.813 |
|
desc |
For data read jobs, that is, when the action field is set to ingest, the desc field is present in the log. The value of this field is related to the data source type (the connector field).
|
s |
|
events |
The number of data entries processed in the reporting interval. |
13245 |
|
failed |
The number of data entries that failed to process in the reporting interval. |
3 |
|
native_bytes |
The raw size of the data processed in the reporting interval, in bytes. |
7539125 |
|
events_bytes |
The size of the parsed data processed in the reporting interval, in bytes. |
13295475 |
|
pub_net_bytes |
The Internet traffic generated by the data processed in the reporting interval, in bytes. |
45678 |
|
req_count |
The number of requests sent to the data source or destination in the reporting interval. |
89 |
|
rep_time |
The average request latency for the data source or destination in the reporting interval. |
38 |
|
rate_limit_hits |
The number of rate limit hits on the data source or destination in the reporting interval. |
1 |
|
extras |
Additional information. This field is included only if a value is present. The value of this field depends on the data source type (the connector field). |
{"events":"898","objectName":"shenzhen/2022/05/18/15/19_1652858350000000000_315eb857efeb9f00.snappy","objectSize":"212792"} |