Skip to content

misc: add clientIP in audit log #6908

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

Merged
prakash100198 merged 3 commits into from
Jan 7, 2026
+21 −12
Merged

misc: add clientIP in audit log #6908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87ba4c2
Replace `Update` with `Save` in `userAudit` handling to avoid upsert …
prakash100198 Jan 7, 2026
ea97e8a
Use `Update` instead of `Save` for `userAudit` and log `ClientIP` in …
prakash100198 Jan 7, 2026
674c535
Refactor `userAudit` handling: replace `saveUserAudit` with `updateUs…
prakash100198 Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions api/util/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

"github.com/devtron-labs/devtron/internal/middleware"
"github.com/devtron-labs/devtron/pkg/auth/user"
"github.com/devtron-labs/devtron/util"
)

type AuditLoggerDTO struct {
Expand All @@ -36,6 +37,7 @@
RequestPayload []byte `json:"requestPayload"`
RequestMethod string `json:"requestMethod"`
ResponseTime time.Duration `json:"responseTime"`
ClientIp string `json:"clientIp"`
}

type LoggingMiddlewareImpl struct {
Expand All @@ -56,13 +58,12 @@
func (impl LoggingMiddlewareImpl) LoggingMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
d := middleware.NewDelegator(w, nil)

token := r.Header.Get("token")
userEmail, err := impl.userService.GetEmailFromToken(token)
if err != nil {
log.Printf("AUDIT_LOG: user does not exists")
}

clientIp := util.GetClientIP(r)
// Read the request body into a buffer
var bodyBuffer bytes.Buffer
_, err = io.Copy(&bodyBuffer, r.Body)
Expand All @@ -83,6 +84,7 @@
QueryParams: r.URL.Query().Encode(),
RequestPayload: bodyBuffer.Bytes(),
RequestMethod: r.Method,
ClientIp: clientIp,
}
// Call the next handler in the chain.
next.ServeHTTP(d, r)
Expand All @@ -95,5 +97,5 @@
}

func LogRequest(auditLogDto *AuditLoggerDTO) {
log.Printf("AUDIT_LOG: requestMethod: %s, urlPath: %s, queryParams: %s, updatedBy: %s, updatedOn: %s, apiResponseCode: %d, responseTime: %s, requestPayload: %s", auditLogDto.RequestMethod, auditLogDto.UrlPath, auditLogDto.QueryParams, auditLogDto.UserEmail, auditLogDto.UpdatedOn, auditLogDto.ApiResponseCode, auditLogDto.ResponseTime, auditLogDto.RequestPayload)
log.Printf("AUDIT_LOG: clientIp: %s, requestMethod: %s, urlPath: %s, queryParams: %s, updatedBy: %s, updatedOn: %s, apiResponseCode: %d, responseTime: %s, requestPayload: %s", auditLogDto.ClientIp, auditLogDto.RequestMethod, auditLogDto.UrlPath, auditLogDto.QueryParams, auditLogDto.UserEmail, auditLogDto.UpdatedOn, auditLogDto.ApiResponseCode, auditLogDto.ResponseTime, auditLogDto.RequestPayload)

Check notice

Code scanning / SonarCloud

Logging should not be vulnerable to injection attacks Low

Change this code to not log user-controlled data. See more on SonarQube Cloud
}
25 changes: 16 additions & 9 deletions pkg/auth/user/UserService.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,18 @@ package user
import (
"context"
"fmt"
"net/http"
"strconv"
"strings"
"sync"
"time"

bean4 "github.com/devtron-labs/devtron/pkg/auth/authorisation/casbin/bean"
"github.com/devtron-labs/devtron/pkg/auth/user/adapter"
userHelper "github.com/devtron-labs/devtron/pkg/auth/user/helper"
adapter2 "github.com/devtron-labs/devtron/pkg/auth/user/repository/adapter"
"github.com/devtron-labs/devtron/pkg/auth/user/repository/helper"
util3 "github.com/devtron-labs/devtron/pkg/auth/user/util"
"net/http"
"strconv"
"strings"
"sync"
"time"

"github.com/devtron-labs/authenticator/jwt"
"github.com/devtron-labs/authenticator/middleware"
Expand Down Expand Up @@ -1237,7 +1238,7 @@ func (impl *UserServiceImpl) GetLoggedInUser(r *http.Request) (int32, error) {
userId, userType, err := impl.GetUserByToken(r.Context(), token)
// if user is of api-token type, then update lastUsedBy and lastUsedAt
if err == nil && userType == userBean.USER_TYPE_API_TOKEN {
go impl.saveUserAudit(r, userId)
go impl.updateUserAudit(r, userId)
}
return userId, err
}
Expand Down Expand Up @@ -1664,9 +1665,15 @@ func (impl *UserServiceImpl) saveUserAudit(r *http.Request, userId int32) {
CreatedOn: time.Now(),
UpdatedOn: time.Now(),
}
// Using Update instead of Save to upsert (update if exists, insert if not)
// This prevents the user_audit table from filling up with duplicate entries
// for API token users
impl.userAuditService.Save(userAudit)
}

func (impl *UserServiceImpl) updateUserAudit(r *http.Request, userId int32) {
clientIp := util2.GetClientIP(r)
userAudit := &UserAudit{
UserId: userId,
ClientIp: clientIp,
}
impl.userAuditService.Update(userAudit)
}

Expand Down