Collect logs in Apache mode

Procedure

1. Log on to the Log Service console.
2. In the Import Data section, click Apache - Text Log.
3. Select a destination project and Logstore, and then click Next.
   You can also click Create Now to create a project and a Logstore.
4. Create a machine group.
   • If a machine group is available, click Using Existing Machine Groups.
   • If no machine groups are available, perform the following steps to create a machine group. An ECS instance is used as an example.
     1. On the ECS Instances tab, select the destination ECS instance and click Execute Now.

        For more information, see Install Logtail on ECS instances.

        Note If you need to collect logs from self-managed clusters or servers of third-party cloud service providers, you must install Logtail. For more information, see Install Logtail in Linux or Install Logtail in Windows.
     2. After the installation, click Complete Installation.
     3. Create a machine group and click Next.

        Log Service allows you to create IP address-based machine groups and custom ID-based machine groups. For more information, see Create an IP address-based machine group and Create a custom ID-based machine group.

5. Select and move the destination machine group from Source Server Groups to Applied Server Groups, and then click Next.
   Notice If you want to apply a machine group immediately after it is created, the heartbeat status of the machine group may be FAIL. This is because the machine group has not been connected to Log Service. In this case, you can click Automatic Retry. If the problem persists, see What can I do if the Logtail client has no heartbeat?
6. In the Logtail Config step, create a Logtail configuration file.
   

   Parameter	Description
   Config Name	The name of the Logtail configuration file. The name must be unique in a project and cannot be modified after the file is created. You can also click Import Other Configuration to import a Logtail configuration file from another project.
   Log Path	The directories and files from which logs are collected. The file names can be complete names or names that contain wildcards. For more information, see Wildcard matching. The log files in all levels of subdirectories under a specified directory are monitored if the log files match the specified pattern. Examples: /apsara/nuwa/… /*.log indicates that the files whose extension is .log in the /apsara/nuwa directory and its subdirectories are monitored. /var/logs/app_*/*.log indicates that each file that meets the following conditions is monitored: The file name contains .log. The file is stored in a subdirectory (at all levels) of the /var/logs directory. The name of the subdirectory matches the app_* pattern. Note By default, each log file can be collected by using only one Logtail configuration file. To use multiple Logtail configuration files to collect one log file, we recommend that you create a symbolic link that points to the directory where the file is located. For example, assume that you want to collect two copies of the log.log file from the /home/log/nginx/log/log.log directory. You can run the following command to create a symbolic link that points to the directory. When you configure the Logtail configuration files, use the original path in one Logtail configuration file and use the symbolic link in the other Logtail configuration file. ln -s /home/log/nginx/log /home/log/nginx/link_log You can include only asterisks (*) and question marks (?) as wildcard characters in the log path.
   Blacklist	If you turn on the Blacklist switch, you can configure a blacklist to skip the specified directories or files when you collect logs. You can use exact match or wildcard match to specify directories and files. 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 is skipped.
   Docker File	If you collect logs from Docker containers, you can turn on the Docker File switch and configure the paths and tags of the containers. Logtail monitors the containers when they are created and destroyed, filters the logs of the containers by tag, and collects the filtered logs. For more information, see Use the console to collect Kubernetes text logs in DaemonSet mode.
   Mode	The default mode is Apache Configuration Mode. You can change the mode.
   Log format	Select a log format based on the format specified in the Apache configuration file. Valid values: common, combined, and Custom.
   APACHE Logformat Configuration	Enter the log configuration section that is specified in the Apache configuration file. The section starts with LogFormat. For more information, see Appendix: log formats and sample logs. If the specified Log Format is common or combined, this field value is automatically generated. Check whether the log format is the same as that specified in the Apache configuration file. Enter a value if the specified Log Format is Custom. For example, you can enter LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %D %f %k %p %q %R %T %I %O" customized.
   APACHE Key Name	Log Service reads the Apache key names from the content in the APACHE Logformat Configuration field.
   Drop Failed to Parse Logs	Specifies whether to discard logs that fail to be parsed: 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 is skipped.
   Maximum Directory Monitoring Depth	The maximum depth at which the specified log directory is monitored. Valid values: 0 to 1000. The value 0 indicates that only the directory specified in the log path is monitored.

   You can configure advanced options based on your business requirements. We recommend that you do not modify the settings. The following table describes the parameters in the advanced options.

   Parameter	Description
   Enable Plug-in Processing	If you turn on the Enable Plug-in Processing switch, you can configure the Logtail plug-in to process logs. For more information, see Overview. Note If you turn on the Enable Plug-in Processing switch, the Upload Raw Log, Timezone, Drop Failed to Parse Logs, Filter Configuration, and Incomplete Entry Upload (Delimiter mode) fields become unavailable.
   Upload Raw Log	If you turn on the Upload Raw Log switch, each raw log is uploaded to Log Service as a value of the __raw__ field together with the parsed log.
   Topic Generation Mode	Sets the topic generation mode. For more information, see Configure a log topic. Null - Do not generate topic: This mode is selected by default. In this mode, the topic field is set to an empty string. You do not need to enter a topic to query logs. Machine Group Topic Attributes: This mode is used to differentiate logs that are generated by different servers. File Path RegEx: In this 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 logs that are generated by different users or instances.
   Log File Encoding	The encoding format of the log file. Valid values: utf8 and gbk.
   Timezone	The time zone where logs are collected. Valid values: 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	The timeout period of log files. If a log file is not updated within the specified period, Logtail considers the file to be timed out. Valid values: 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 file to be timed out and no longer monitors the file. If you select 30 Minute Timeout, you must specify the Maximum Timeout Directory Depth parameter. Valid values: 1 to 3.
   Filter Configuration	The filter conditions that are used to collect logs. Only logs that match the specified filter conditions are collected. Examples: Collect logs that meet a condition: If you set Key to level and Regex to WARNING|ERROR, only WARNING-level and ERROR-level logs are collected. Filter out logs that do not meet a condition. For more information, see Regular-Expressions.info. If you set Key to level and Regex to ^(?!. *(INFO|DEBUG)). *, INFO-level or DEBUG-level logs are not collected. If you set Key to url and Regex to . *^(?!.*(healthcheck)). *, logs whose URL contain healthcheck are not collected. For example, the log entry is not collected if the value of the Key field is url and the value of the Vaue field is /inner/healthcheck/jiankong.html. For more examples, see regex-exclude-word and regex-exclude-pattern.

   Click Next to complete the configuration and use Logtail to collect logs.

   Note

   • The Logtail configurations require at most 3 minutes to take effect.
   • If an error occurs when you use Logtail to collect logs, see Diagnose collection errors.
7. Preview the data, configure indexes, and then click Next.
   By default, Log Service enables the Full Text Index to query and analyze logs. You can also manually or automatically configure Field Search. For more information, see Enable and configure the indexing feature for a Logstore.

   Note

   • To query and analyze logs, you must enable the Full Text Index or Field Search. If you configure both of them, the settings of Field Search prevail.
   • If the data type of the index is long or double, the case sensitive and delimiter settings are unavailable.

Appendix: log formats and sample logs

Before you collect Apache logs, you must specify the print format, log path, and log file name. For example, CustomLog "/var/log/apache2/access_log" combined indicates that the combined format is used when logs are printed. The log file path is /var/log/apache2/access_log. The following information shows the log formats and sample logs:

• Log formats
  • The combined log format:

    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined

  • The common log format:

    LogFormat "%h %l %u %t \"%r\" %>s %b" 

  • A custom log format:

    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %D %f %k %p %q %R %T %I %O" customized

  The following table describes the fields of these log formats. For more information, see mod_log_config.

  Format field	Key name	Description
  %a	client_addr	The IP address of the client.
  %A	local_addr	The local IP address.
  %b	response_size_bytes	The number of bytes of the response. A hyphen (-) is displayed if this value is empty.
  %B	response_bytes	The number of bytes of the response. The digit 0 is displayed if this value is empty.
  %D	request_time_msec	The duration in which a request is processed. Unit: microseconds.
  %f	filename	The name of the file.
  %h	remote_addr	The name of the remote host.
  %H	request_protocol_supple	The request protocol.
  %I	bytes_received	The number of bytes that are received by the server. To use this field, you must enable the mod_logio module.
  %k	keep_alive	The number of keep-alive requests.
  %l	remote_ident	The identification information that is provided by the remote host.
  %m	request_method_supple	The HTTP request method.
  %O	bytes_sent	The number of bytes that are sent by the server. To use this field, you must enable the mod_logio module.
  %p	remote_port	The port number of the server.
  %P	child_process	The ID of the child process.
  %q	request_query	The query string. An empty string is displayed if no query strings exist.
  %r	request	The content of the request. The content includes the method name, address, and the HTTP protocol.
  %R	response_handler	The type of the handler that generates the response on the server.
  %s	status	The initial HTTP status of the response.
  %>s	status	The final HTTP status of the response.
  %t	time_local	The local time when the server receives the request.
  %T	request_time_sec	The duration in which a request is processed. Unit: seconds.
  %u	remote_user	The username of the client.
  %U	request_uri_supple	The URI of the request. The URI does not include the string that is used to query logs.
  %v	server_name	The name of the server.
  %V	server_name_canonical	The name of the server. The name is specified by using the UseCanonicalName directive.
  “%{User-Agent}i”	http_user_agent	The information of the client.
  "%{Rererer}i"	http_referer	The URL of the web page. The URL is linked to the resource that is being requested.

• Sample logs

  192.168.1.2 - - [02/Feb/2020:17:44:13 +0800] "GET /favicon.ico HTTP/1.1" 404 209 "http://localhost/x1.html" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.97 Safari/537.36"