Thanks to visit codestin.com
Credit goes to github.com

Skip to content

server: Remove session-wide logging, add session_uuid to message logs #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 4, 2024
Merged

server: Remove session-wide logging, add session_uuid to message logs #1025

merged 1 commit into from
Nov 4, 2024
+27 −2

Conversation

@nitnelave
Copy link
Member

When clients keep long-running LDAP sessions, the logs get endlessly buffered, turning into a slow memory leak. This change removes the session-long span, in favor of adding a session UUID to identify requests from the same UUID.

Sample non-verbose log:

2024-11-04T20:20:55.440854116+00:00  INFO     LDAP request [ 646ms | 100.00% ] session_id: d27e7230-19fe-4697-bb7c-a0ac732482d3
2024-11-04T20:20:55.442111783+00:00  INFO     ┕━ ｉ [info]: Login attempt for "admin"
2024-11-04T20:20:56.087854432+00:00  INFO     LDAP request [ 80.2ms | 100.00% ] session_id: d27e7230-19fe-4697-bb7c-a0ac732482d3
2024-11-04T20:20:56.169710414+00:00  INFO     LDAP request [ 23.9µs | 100.00% ] session_id: d27e7230-19fe-4697-bb7c-a0ac732482d3
2024-11-04T20:20:56.169840501+00:00  INFO     ｉ [info]: LDAP session end: d27e7230-19fe-4697-bb7c-a0ac732482d3

Sample verbose log:

2024-11-04T20:21:08.559247278+00:00  INFO     LDAP request [ 638ms | 0.00% / 100.00% ] session_id: ec554aee-9f47-471e-822c-0509fcbdc276
2024-11-04T20:21:08.559323675+00:00  DEBUG    ┝━ 🐛 [debug]:  | msg: LdapMsg { msgid: 1, op: BindRequest(LdapBindRequest { dn: "cn=admin,ou=people,dc=example,dc=com", cred: LdapBindCred::Simple }), ctrl: [] }
2024-11-04T20:21:08.559372395+00:00  DEBUG    ┝━ do_bind [ 638ms | 0.00% / 100.00% ] dn: cn=admin,ou=people,dc=example,dc=com
2024-11-04T20:21:08.559467153+00:00  DEBUG    │  ┝━ bind [ 636ms | 0.00% / 99.79% ]
2024-11-04T20:21:08.559520140+00:00  DEBUG    │  │  ┝━ get_password_file_for_user [ 1.01ms | 0.16% ] user_id: "admin"
2024-11-04T20:21:08.560691612+00:00  INFO     │  │  ┝━ ｉ [info]: Login attempt for "admin"
2024-11-04T20:21:08.560725174+00:00  DEBUG    │  │  ┕━ passwords_match [ 635ms | 99.64% ] username: admin
2024-11-04T20:21:09.196188979+00:00  DEBUG    │  ┝━ get_user_groups [ 1.31ms | 0.21% ] user_id: "admin"
2024-11-04T20:21:09.198078090+00:00  DEBUG    │  │  ┕━ 🐛 [debug]:  | return: {GroupDetails { group_id: 1, display_name: "lldap_admin", creation_date: 2024-10-03T13:50:59.506334784, uuid: "7497eefb-5fc8-3e79-aa1d-8ffb0a7d8117", attributes: [] }}
2024-11-04T20:21:09.198127365+00:00  DEBUG    │  ┕━ 🐛 [debug]: Success!
2024-11-04T20:21:09.198162609+00:00  DEBUG    ┕━ 🐛 [debug]:  | response: BindResponse(LdapBindResponse { res: LdapResult { code: Success, matcheddn: "", message: "", referral: [] }, saslcreds: None })
2024-11-04T20:21:09.198627777+00:00  INFO     LDAP request [ 2.06ms | 0.00% / 100.00% ] session_id: ec554aee-9f47-471e-822c-0509fcbdc276
2024-11-04T20:21:09.198645352+00:00  DEBUG    ┝━ 🐛 [debug]:  | msg: LdapMsg { msgid: 2, op: SearchRequest(LdapSearchRequest { base: "ou=people,dc=example,dc=com", scope: Subtree, aliases: Never, sizelimit: 0, timelimit: 0, typesonly: false, filter: Equality("uid", "bob"), attrs: [] }), ctrl: [] }
2024-11-04T20:21:09.198659713+00:00  DEBUG    ┝━ do_search [ 2.06ms | 39.54% / 100.00% ]
2024-11-04T20:21:09.200802449+00:00  DEBUG    │  ┝━ 🐛 [debug]:  | request.base: "ou=people,dc=example,dc=com" | scope: Users
2024-11-04T20:21:09.200820530+00:00  DEBUG    │  ┕━ get_user_list [ 1.25ms | 0.00% / 60.46% ]
2024-11-04T20:21:09.200837718+00:00  DEBUG    │     ┝━ 🐛 [debug]:  | filters: UserId("bob")
2024-11-04T20:21:09.200852598+00:00  DEBUG    │     ┕━ list_users [ 1.25ms | 60.46% ] filters: Some(UserId("bob")) | _get_groups: false
2024-11-04T20:21:09.202595053+00:00  DEBUG    │        ┕━ 🐛 [debug]:  | return: []
2024-11-04T20:21:09.202671956+00:00  DEBUG    ┕━ 🐛 [debug]:  | response: SearchResultDone(LdapResult { code: Success, matcheddn: "", message: "", referral: [] })
2024-11-04T20:21:09.202961623+00:00  INFO     LDAP request [ 27.6µs | 100.00% ] session_id: ec554aee-9f47-471e-822c-0509fcbdc276
2024-11-04T20:21:09.202974240+00:00  DEBUG    ┝━ 🐛 [debug]:  | msg: LdapMsg { msgid: 3, op: UnbindRequest, ctrl: [] }
2024-11-04T20:21:09.202985717+00:00  DEBUG    ┕━ 🐛 [debug]: Unbind request for admin
2024-11-04T20:21:09.203058096+00:00  INFO     ｉ [info]: LDAP session end: ec554aee-9f47-471e-822c-0509fcbdc276

@codecov
Copy link

codecov bot commented Nov 4, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 85.80%. Comparing base (143eb70) to head (f5fbb8b).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
server/src/infra/ldap_handler.rs 75.00% 4 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1025      +/-   ##
==========================================
- Coverage   85.81%   85.80%   -0.01%     
==========================================
  Files          50       50              
  Lines       11145    11109      -36     
==========================================
- Hits         9564     9532      -32     
+ Misses       1581     1577       -4
Files with missing lines Coverage Δ
server/src/infra/ldap_server.rs 48.14% <100.00%> (+13.77%) ⬆️
server/src/infra/ldap_handler.rs 95.22% <75.00%> (+0.02%) ⬆️

@nitnelave nitnelave merged commit 95337e2 into main Nov 4, 2024
16 of 17 checks passed
@nitnelave nitnelave deleted the logging branch November 4, 2024 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nitnelave