Skip to content

feat(log): add nested log format support for logger plugins#12697

Merged
Baoyuantop merged 8 commits into
apache:masterfrom
TaeyeongKwak:feat-support-nested-log-format
Dec 15, 2025
Merged

feat(log): add nested log format support for logger plugins#12697
Baoyuantop merged 8 commits into
apache:masterfrom
TaeyeongKwak:feat-support-nested-log-format

Conversation

@TaeyeongKwak

@TaeyeongKwak TaeyeongKwak commented Oct 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This PR adds support for nested log format in logger plugins. Previously, the log_format configuration only supported flat key-value structures. This feature allows users to more efficiently organize and group log fields by defining hierarchical/overlapping log structures.

For example, user can set log_format as below:

{
    "log_format": {
        "host": "$host",
        "client_ip": "$remote_addr",
        "request": {
            "method": "$request_method",
            "uri": "$request_uri",
            "headers": {
                "user_agent": "$http_user_agent"
            }
        },
        "response": {
            "status": "$status"
        }
    }
}

Output Example:

{
    "response": {
        "status": 200
    },
    "route_id": "1",
    "client_ip": "127.0.0.1",
    "request": {
        "method": "GET",
        "uri": "/",
        "headers": {
            "user_agent": "curl/8.5.0"
        }
    },
    "host": "127.0.0.1"
}

Which issue(s) this PR fixes:

Fixes #

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Oct 24, 2025
@Baoyuantop

Baoyuantop commented Oct 28, 2025

Copy link
Copy Markdown
Contributor

Hi @TaeyeongKwak, do we need to limit the maximum nesting level? In addition, you need to add the corresponding documentation content.

@TaeyeongKwak

TaeyeongKwak commented Oct 28, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Hi @TaeyeongKwak, do we need to limit the maximum nesting level? In addition, you need to add the corresponding documentation content.

Hi @Baoyuantop, Thank you for your comment.
Come to think of it, I agree that we should set a maximum depth as you mentioned.
Considering typical use cases, I think allowing a maximum depth of five levels would be sufficient.
I'll apply this change and update the documentation accordingly.

And currently, I've only added test cases to some plugins. Should I add test cases for the other plugins too?

@Baoyuantop

Baoyuantop commented Nov 10, 2025

Copy link
Copy Markdown
Contributor

Hi @TaeyeongKwak, I think creating a test for just one plugin is sufficient.

@Baoyuantop Baoyuantop added the wait for update wait for the author's response in this issue/PR label Nov 10, 2025
@TaeyeongKwak

TaeyeongKwak commented Nov 10, 2025

Copy link
Copy Markdown
Contributor Author

Hi @TaeyeongKwak, I think creating a test for just one plugin is sufficient.

@Baoyuantop
Got it. I’ll keep only the tests I’ve written so far.

I notice some CI checks are currently failing, but they don’t seem related to the changes in this PR. Is there anything I might be missing?

@Baoyuantop

Baoyuantop commented Nov 13, 2025

Copy link
Copy Markdown
Contributor

Hi @TaeyeongKwak, I saw some errors related to sls-logger. Could you run a test locally to check? You can refer to http://apisix.apache.org/docs/apisix/build-apisix-dev-environment-devcontainers/

@Baoyuantop Baoyuantop removed wait for update wait for the author's response in this issue/PR user responded labels Nov 13, 2025
@TaeyeongKwak

TaeyeongKwak commented Nov 14, 2025

Copy link
Copy Markdown
Contributor Author

Hi @TaeyeongKwak, I saw some errors related to sls-logger. Could you run a test locally to check? You can refer to http://apisix.apache.org/docs/apisix/build-apisix-dev-environment-devcontainers/

Hi @Baoyuantop,
Thank you for the suggestion. I've tested sls-logger locally following the guide you provided, and the tests passed successfully:

root@a1bd1377d5dd:/workspace# git branch --show-current
feat-support-nested-log-format
root@a1bd1377d5dd:/workspace# FLUSH_ETCD=1 prove -Itest-nginx/lib -I. -r t/plugin/sls-logger.t
t/plugin/sls-logger.t .. ok    
All tests successful.
Files=1, Tests=49, 32 wallclock secs ( 0.02 usr  0.00 sys +  1.00 cusr  0.91 csys =  1.93 CPU)
Result: PASS

Is there anything I might have missed while performing the test?

@Baoyuantop

Baoyuantop commented Nov 21, 2025

Copy link
Copy Markdown
Contributor

Hi @TaeyeongKwak, we've made some test fixes in the main branch; you can merge the code from the main branch.

membphis
membphis approved these changes Dec 9, 2025
View reviewed changes

@membphis membphis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice PR

@Baoyuantop

Baoyuantop commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

The failed CI was unrelated to the changes in this PR.

@membphis

membphis commented Dec 9, 2025

Copy link
Copy Markdown
Member
  • CI / build (ubuntu-latest, linux_openresty, lua-resty-worker-events, t/plugin/[l-z]*) (pull_request)

two ways we can make a try:

  1. rerun the failed test case
  2. merge the latest master branch

@Baoyuantop
Baoyuantop merged commit d520a84 into apache:master Dec 15, 2025
52 of 58 checks passed
wistefan pushed a commit to wistefan/apisix that referenced this pull request Jun 16, 2026
@TaeyeongKwak @wistefan
feat(log): add nested log format support for logger plugins (apache#1…
f52f28e 
…2697)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@membphis membphis membphis approved these changes
@nic-6443 nic-6443 nic-6443 approved these changes
@Baoyuantop Baoyuantop Baoyuantop approved these changes
@AlinsRan AlinsRan Awaiting requested review from AlinsRan

Assignees

No one assigned

Labels

enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@TaeyeongKwak @Baoyuantop @membphis @nic-6443