This topic describes how to collect NGINX logs and configure indexes. You can specify the required settings in the Log Service console.
The command log_format and access_log can be used to access NGINX logs. You can configure the commands in the /etc/nginx/nginx.conf file. The log_format command is used to specify the log format. The access_log command is used to specify the path at which the NGINX log files are saved.
- Log format
The following sample code shows the default format of the log_format command:
log_format main '$remote_addr - $remote_user [$time_local] "$request" ' '$request_time $request_length ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent"';The following sample code shows the default format of the access_log command:
access_log /var/logs/nginx/access.log main
The following table describes the parameters of the log format.
Field Description remote_addr The IP address of the client. remote_user The username of the client. request The request URL that is used to access the client. status HTTP status code. body_bytes_sent The number of bytes in the response that is returned to the client. The size of the response header is excluded. The value of this parameter is the same as the value of the bytes_sent parameter in the mod_log_config module of Apache. connection The serial number of the TCP connection. connection_requests The number of requests that is received over a TCP connection. msec The time when the log was written. Unit: seconds. It can be accurate to milliseconds. pipe Indicates whether the HTTP request is pipelined. If the HTTP request is pipelined, the parameter value is p. Otherwise, the parameter value is .. httpreferer The URL of the web page. The URL is linked to the resource that is requested. http_user_agent The browser information of the client. The information must be enclosed in double quotation marks ("). request_length The length of the request. The length includes the request line, request header, and request body. request_time The period of time used to process requests from the client. Unit: seconds. It can be accurate to milliseconds. The time period starts when the first byte is read from the client and ends when the log is written after the last byte is sent to the client. time_local The system time of the server. The parameter must be enclosed in brackets .
- Log sample entry
192.168.1.2 - - [10/Jul/2015:15:51:09 +0800] "GET /ubuntu.iso HTTP/1.0" 0.000 129 404 168 "-" "Wget/1.11.4 Red Hat modified"
- Log on to the Log Service console.
- In the Import Data section, select Nginx - Text Log.
- In the Specify Logstore step, select the target project and Logstore, and click Next.
You can also click Create Now to create a project and a Logstore. For more information, see Step 1: Create a project and a Logstore.
- In the Create Machine Group step, create a machine group.
- If a machine group is available, click Using Existing Machine Groups.
- If no machine group is available, perform the following steps. The following steps
take ECS instances as an example to describe how to create a machine group:
- Click the ECS Instances tab. On the tab, select the ECS instances that you want to add to a machine group
and then click Install.
If Logtail is installed on the ECS instances, click Complete Installation.Note
- If the ECS instances run Linux, click Install and Logtail is automatically installed on the ECS instances.
- If the ECS instances run Windows, you must manually install Logtail on the ECS instances. For more information, see Install Logtail in Windows.
- If you want to collect logs from a user-created cluster, you must manually install Logtail on the servers in the cluster. For more information, see Install Logtail in Linux or Install Logtail in Windows.
- After the installation is completed, click Complete Installation.
- On the page that appears, set relevant parameters for the machine group. For more information, see Create an IP address-based machine group or Create a custom ID-based machine group.
- Click the ECS Instances tab. On the tab, select the ECS instances that you want to add to a machine group and then click Install.
- In the Machine Group Settings step, apply Logtail configurations to the machine group.
Select the created machine group and move the group from Source Machine Groups to Applied Machine Groups.
- In the Logtail Config step, create a Logtail configuration.
Parameter Description Config Name The name of the Logtail configuration. The name cannot be modified after the Logtail configuration is created.
You can also click Import Other Configuration to import Logtail configurations from other projects.
Log Path The directory and name of the log file.The specified log file names can be complete file names or file names that contain wildcards. For more information about wildcards that can be used in patterns of directory and file names, visit Wildcard matching. The log files in all levels of subdirectories under the specified directory that match the specified pattern are monitored. Examples:
- /apsara/nuwa/ ... /*.log indicates the files whose extension is .log in the /apsara/nuwa directory and its subdirectories are monitored.
- /var/logs/app_* ... /*.log* indicates each file that meets the following conditions is monitored: The file name contains .log. The file is stored in a subdirectory (at any level) of the /var/logs directory. The name of the subdirectory matches the app_* pattern.
- A log file can be collected by using only one Logtail configuration file.
- You can include only asterisks (*) and question marks (?) as wildcard characters in the log path.
Blacklist If this switch is turned on, you can configure a blacklist in the Add Blacklist section. You can configure a blacklist to skip the specified directories or files during log data collection. The names of the specified directories and files support exact match and wildcard match. Examples:
- If you select Filter by Directory from the Filter Type drop-down list and enter /tmp/mydir in the Content column, all files in the directory are skipped.
- If you select Filter by File from the Filter Type drop-down list and enter /tmp/mydir/file in the Content column, only the specified file in the directory are skipped.
Docker File If the file in the Docker container is a log file, you can directly specify the log path and container tags. Logtail automatically monitors the creation and destruction of containers, and collects log entries of the specified containers based on the specified tags. For more information about container text logs, see Use the console to collect Kubernetes text logs in the DaemonSet mode. Mode The default value is NGINX Configuration Mode. You can select other modes. For more information about how to configure other modes, see Overview. NGINX Log Configuration Enter the log configuration section that is specified in a standard NGINX configuration file. The section starts with the
log_format main '$remote_addr - $remote_user [$time_local] "$request" ' '$request_time $request_length ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent"';
Regular expression Regular expression is automatically generated based on the contents that you entered for NGINX Log Configuration. Log sample entry Log sample entry is used to verify whether the NGINX log configuration matches the generated regular expression. Enter a sample NGINX log entry, and click Validate. If the validation is passed, the log sample entry is automatically extracted as the NGINX Key value. NGINX Key The NGINX key is automatically generated based on the NGINX log configuration. Drop Failed to Parse Logs
- If you turn on the Drop Failed to Parse Logs switch, logs that fail to be parsed cannot be uploaded to Log Service.
- If you turn off the Drop Failed to Parse Logs switch, raw logs are uploaded when the raw logs fail to be parsed.
Maximum Directory Monitoring Depth The maximum number of directory layers that can be recursively monitored during log collection. Valid values: 0 to 1000. The value 0 indicates that only the directory specified in the Log Path parameter is monitored.Specify Advanced Options based on your business requirements. We recommend that you do not modify the default settings unless otherwise required. Parameter Description Enable Plug-in Processing Specifies whether to use plug-ins for Logtail to process logs. If you turn on the switch, plug-ins are used to process logs. Upload Raw Log If you turn on this switch, raw logs are written to the __raw__ field and uploaded with the parsed logs. Topic Generation Mode
- Null - Do not generate topic: This mode is selected by default. In this mode, the topic field is set to an empty string and you can query logs without the need to enter a topic.
- Machine Group Topic Attributes: This mode is used to differentiate log data that is generated by different servers.
- File Path Regex: If you select File Path Regex for Topic Generation Mode, you must configure a regular expression in the Custom RegEx field. The part of a log path that matches the regular expression is used as the topic name. This mode is used to differentiate log data that is generated by different users or ECS instances.
Log File Encoding
- utf8: indicates UTF-8 encoding.
- gbk: indicates GBK encoding.
Timezone The time zone where logs are collected.
- System Timezone: This option is selected by default. It indicates that the time zone where logs are collected is the same as the time zone to which the server belongs.
- Custom: Select a time zone.
Timeout If a log file is not updated within the specified period of time, Logtail considers the file to be timed out.
- Never: All log files are continuously monitored and never time out.
- 30 Minute Timeout: If a log file is not updated within 30 minutes, Logtail considers
the log file to be timed out and no longer monitors the file.
If you select 30 Minute Timeout, you must set Maximum Timeout Directory Depth. Valid values: 1 to 3.
Filter Configuration Specifies to collect logs that match the filtering conditions. Examples:
- If you want to collect only the logs with the severity level of WARNING or ERROR, set the condition Key:level Regex:WARNING|ERROR. It indicates that logs with the severity level of WARNING or ERROR are collected.
- Filter logs that do not meet a condition:
- Set the condition to Key:level Regex:^(?!. *(INFO|DEBUG)). * if you want to filter out the logs with the severity level of INFO or DEBUG.
- Set the condition to Key:url Regex:. *^(?!.*(healthcheck)). * if you want to filter out the logs whose URL contains the keyword healthcheck. For example, logs in which the value of the url key is /inner/healthcheck/jiankong.html are not collected.
- In the Configure Query and Analysis step, set indexes.
Indexes are configured by default. You can reconfigure the indexes as needed. For more information, see Enable and configure the index feature for a Logstore.Note
- You must set Full Text Index or Field Search. If you set both of them, the settings of Field Search prevail.
- If the data type of an index is Long or Double, the Case Sensitive and Delimiter settings are unavailable.
After all configurations are completed, Log Service starts to collect logs.