tencent cloud

Tencent Cloud EdgeOne

Release Notes and Announcements
Release Notes
Security Announcement
Announcements
Product Introduction
Overview
Strengths
Use Cases
Comparison Between EdgeOne and CDN Products
Use Limits
Purchase Guide
Description of Trial Plan Experience Benefits
Free Plan Guide
Billing Overview
Billing Items
Subscriptions
Renewals
Instructions for overdue and refunds
Comparison of EdgeOne Plans
About "clean traffic" billing instructions
DDoS Protection Capacity Description
Getting Started
Choose business scenario
Quick access to website security acceleration
Quick deploying a website with Pages
Domain Service&Origin Configuration
Domain Service
HTTPS Certificate
Origin Configuration
Site Acceleration
Overview
Access Control
Smart Acceleration
Cache Configuration
File Optimization
Network Optimization
URL Rewrite
Modifying Header
Modify the response content
Rule Engine
Image&Video Processing
Speed limit for single connection download
DDoS & Web Protection
Overview
DDoS Protection
Web Protection
Bot Management
API Discovery（Beta）
Edge Functions
Overview
Getting Started
Operation Guide
Runtime APIs
Sample Functions
Best Practices
Pages
L4 Proxy
Overview
Creating an L4 Proxy Instance
Modifying an L4 Proxy Instance
Disabling or Deleting an L4 Proxy Instance
Batch Configuring Forwarding Rules
Obtaining Real Client IPs
Data Analysis&Log Service
Log Service
Data Analysis
Alarm Service
Site and Billing Management
Billing Management
Site Management
Version Management
General Policy
General Reference
Configuration Syntax
Request and Response Actions
Country/region and Corresponding Codes
Terraform
Overview
Installing and Configuring Terraform
Practical Tutorial
EdgeOne Skill User Guide
Automatic Warm-up/Cache Purge
Resource Abuse/hotlinking Protection Practical
HTTPS Related Practices
Acceleration Optimization
Scheduling Traffic
Data Analysis and Alerting
Log Platform Integration Practices
Configuring Origin Servers for Cloud Object Storage (Such As COS)
CORS Response Configuration
API Documentation
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
FAQs
Product Features FAQs
DNS Record FAQs
Domain Configuration FAQs
Site Acceleration FAQs
Data and Log FAQs
Security Protection-related Queries
Origin Configuration FAQs
Troubleshooting
Reference for Abnormal Status Codes
Troubleshooting Guide for EdgeOne 4XX/5XX Status Codes
520/524 Status Code Troubleshooting Guide
521/522 Status Code Troubleshooting Guide
Tool Guide
Agreements
Service Level Agreement
Origin Protection Enablement Conditions of Use
TEO Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationTencent Cloud EdgeOneData Analysis&Log ServiceLog ServiceRelated ReferencesCustomizing Log Output Formats

Customizing Log Output Formats

PDF
Focus Mode
Font Size
Last updated: 2024-09-24 18:10:15

Overview

Users can customize log output formats, including selecting different logging styles (such as JSON Lines or CSV) and defining the prefix and suffix of batches and single logs, as well as the delimiter between log records or fields. The default format for real-time and offline logs is JSON Lines.
Note:
Currently, only real-time logs - site acceleration logs support configuring the log output format.

Configuration Item

Log output format: Preset output format type for log shipping.
JSON Lines: Fields in a single log are presented as key-value pairs.
CSV: Only field values are presented in a single log, without displaying field names.
Batch prefix & suffix: Users can define prefixes and suffixes for log batches. A batch refers to a single log push request. Each log shipping batch may contain multiple log records.
Prefix: A string added before each log shipping batch.
Suffix: A string appended after each log shipping batch.
Single log record prefix & suffix:
Prefix: A string added before each log record.
Suffix: A string appended after each log record.
Note:
When log sampling or filtering is not enabled, for domain name business, one HTTP request corresponds to one log record.
Log record delimiter: A string inserted between log records as a delimiter.
Field delimiter: A string inserted between fields within a single log record as a delimiter.

Sample Configuration

The following are log samples corresponding to different log output formats.

JSON Lines

Configuration Example

Configuration Item
Value
Log output format
JSON Lines
Single log record prefix
{
Single log record suffix
}
Log record delimiter
\\n
Field delimiter
,

Log Output Sample

{"SecurityAction":"Deny","RequestID":"14941044941971548881","RequestTime":"2024-08-12T08:12:15Z","ClientIP":"1.1.1.1"}
{"SecurityAction":"Deny","RequestID":"14941045941971548882","RequestTime":"2024-08-12T08:12:30Z","ClientIP":"2.2.2.2"}

CSV

Configuration Example

Configuration Item
Value
Log output format
csv
Log record delimiter
\\n
Field delimiter
,

Log Output Sample

Deny,14941044941971548881,2024-08-12T08:12:15Z,1.1.1.1
Deny,14941045941971548882,2024-08-12T08:12:30Z,2.2.2.2

JSON Lines Variants

JSON Array Format Configuration Example

Configuration Item
Value
Log output format
JSON Lines
Batch prefix
[
Batch suffix
]
Single log record prefix
{
Single log record suffix
}
Log record delimiter
,
Field delimiter
,

JSON Array Format Log Output Sample

[
    {"SecurityAction":"Deny","RequestID":"14941044941971548881","RequestTime":"2024-08-12T08:12:15Z","ClientIP":"1.1.1.1"},
    {"SecurityAction":"Deny","RequestID":"14941045941971548882","RequestTime":"2024-08-12T08:12:30Z","ClientIP":"2.2.2.2"},
    {"SecurityAction":"Allow","RequestID":"14941046941971548883","RequestTime":"2024-08-12T08:12:45Z","ClientIP":"3.3.3.3"}
]

Embedded JSON Object Format Configuration Example

Configuration Item
Value
Log output format
JSON Lines
Batch prefix
{"events":[
Batch suffix
]}
Single log record prefix
{"info":{
Single log record suffix
}}
Log record delimiter
,
Field delimiter
,

Embedded JSON Object Format Log Output Sample

{"events": [
        {"info": {"SecurityAction":"Deny","RequestID":"14941044941971548881","RequestTime":"2024-08-12T08:12:15Z","ClientIP":"1.1.1.1"}},
        {"info": {"SecurityAction":"Deny","RequestID":"14941045941971548882","RequestTime":"2024-08-12T08:12:30Z","ClientIP":"2.2.2.2"}}
]}

CSV Variants

CSV with Header Format Configuration Example

Configuration Item
Value
Log output format
csv
Batch prefix
SecurityAction,RequestID,RequestTime,ClientIP\\n
Log record delimiter
\\n
Field delimiter
,

CSV with Header Format Log Output Sample

SecurityAction,RequestID,RequestTime,ClientIP
Deny,14941044941971548881,2024-08-12T08:12:15Z,1.1.1.1
Deny,14941045941971548882,2024-08-12T08:12:30Z,2.2.2.2
Allow,14941046941971548883,2024-08-12T08:12:45Z,3.3.3.3

TSV Format Configuration Example

Configuration Item
Value
Log output format
csv
Log record delimiter
\\n
Field delimiter
\\t

TSV Format Log Output Sample

Deny  14941044941971548881  2024-08-12T08:12:15Z  1.1.1.1
Deny  14941045941971548882  2024-08-12T08:12:30Z  2.2.2.2
Allow  14941046941971548883  2024-08-12T08:12:45Z  3.3.3.3


Previous Topic: Custom Log Push FieldsNext Topic: Overview

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback