maxmustermann/minio
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

feat: Add RX/TX to audit logging (#13382)

Browse source 
add additional values for audit logging
This commit is contained in:
Harshavardhana 2021-10-07 19:03:46 -07:00 committed by GitHub
parent 3837d2b94b
commit d57b57bddc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 43 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
cmd/http-tracer.go
View file

@ -20,7 +20,6 @@ package cmd
import ( import (
"bytes" "bytes"
"io" "io"
"io/ioutil"
"net" "net"
"net/http" "net/http"
"reflect" "reflect"
@ -50,6 +49,11 @@ type recordRequest struct {
bytesRead int bytesRead int
} }
func (r *recordRequest) Close() error {
// no-op
return nil
}
func (r *recordRequest) Read(p []byte) (n int, err error) { func (r *recordRequest) Read(p []byte) (n int, err error) {
n, err = r.Reader.Read(p) n, err = r.Reader.Read(p)
r.bytesRead += n r.bytesRead += n
@ -62,6 +66,7 @@ func (r *recordRequest) Read(p []byte) (n int, err error) {
} }
return n, err return n, err
} }
func (r *recordRequest) Size() int { func (r *recordRequest) Size() int {
sz := r.bytesRead sz := r.bytesRead
for k, v := range r.headers { for k, v := range r.headers {
@ -122,7 +127,7 @@ func Trace(f http.HandlerFunc, logBody bool, w http.ResponseWriter, r *http.Requ
} }
reqBodyRecorder := &recordRequest{Reader: r.Body, logBody: logBody, headers: reqHeaders} reqBodyRecorder := &recordRequest{Reader: r.Body, logBody: logBody, headers: reqHeaders}
r.Body = ioutil.NopCloser(reqBodyRecorder) r.Body = reqBodyRecorder
now := time.Now().UTC() now := time.Now().UTC()
t := madmin.TraceInfo{TraceType: madmin.TraceHTTP, FuncName: name, Time: now} t := madmin.TraceInfo{TraceType: madmin.TraceHTTP, FuncName: name, Time: now}

55
docs/logging/README.md
View file

@ -72,51 +72,60 @@ NOTE:
```json ```json
{ {
"version": "1", "version": "1",
"deploymentid": "bc0e4d1e-bacc-42eb-91ad-2d7f3eacfa8d", "deploymentid": "51bcc7b9-a447-4251-a940-d9d0aab9af69",
"time": "2019-08-12T21:34:37.187817748Z", "time": "2021-10-08T00:46:36.801714978Z",
"trigger": "incoming",
"api": { "api": {
"name": "PutObject", "name": "PutObject",
"bucket": "testbucket", "bucket": "testbucket",
"object": "hosts", "object": "hosts",
"status": "OK", "status": "OK",
"statusCode": 200, "statusCode": 200,
"timeToFirstByte": "366333ns", "rx": 380,
"timeToResponse": "16438202ns" "tx": 476,
"timeToResponse": "257694819ns"
}, },
"remotehost": "127.0.0.1", "remotehost": "127.0.0.1",
"requestID": "15BA4A72C0C70AFC", "requestID": "16ABE7A785E7AC2C",
"userAgent": "MinIO (linux; amd64) minio-go/v6.0.32 mc/2019-08-12T18:27:13Z", "userAgent": "MinIO (linux; amd64) minio-go/v7.0.15 mc/DEVELOPMENT.2021-10-06T23-39-34Z",
"requestHeader": { "requestHeader": {
"Authorization": "AWS4-HMAC-SHA256 Credential=minio/20190812/us-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-decoded-content-length,Signature=d3f02a6aeddeb29b06e1773b6a8422112890981269f2463a26f307b60423177c", "Authorization": "AWS4-HMAC-SHA256 Credential=minio/20211008/us-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-decoded-content-length,Signature=4c60a59e5eb3b0a68693c7fee9dbb5a8a509e0717668669194d37bf182fde031",
"Content-Length": "686", "Content-Length": "380",
"Content-Type": "application/octet-stream", "Content-Type": "application/octet-stream",
"User-Agent": "MinIO (linux; amd64) minio-go/v6.0.32 mc/2019-08-12T18:27:13Z", "User-Agent": "MinIO (linux; amd64) minio-go/v7.0.15 mc/DEVELOPMENT.2021-10-06T23-39-34Z",
"X-Amz-Content-Sha256": "STREAMING-AWS4-HMAC-SHA256-PAYLOAD", "X-Amz-Content-Sha256": "STREAMING-AWS4-HMAC-SHA256-PAYLOAD",
"X-Amz-Date": "20190812T213437Z", "X-Amz-Date": "20211008T004636Z",
"X-Amz-Decoded-Content-Length": "512" "X-Amz-Decoded-Content-Length": "207",
"X-Amz-Server-Side-Encryption": "aws:kms"
}, },
"responseHeader": { "responseHeader": {
"Accept-Ranges": "bytes", "Accept-Ranges": "bytes",
"Content-Length": "0", "Content-Length": "0",
"Content-Security-Policy": "block-all-mixed-content", "Content-Security-Policy": "block-all-mixed-content",
"ETag": "a414c889dc276457bd7175f974332cb0-1", "ETag": "4939450d1beec11e10a91ee7700bb593",
"Server": "MinIO/DEVELOPMENT.2019-08-12T21-28-07Z", "Server": "MinIO",
"Vary": "Origin", "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
"X-Amz-Request-Id": "15BA4A72C0C70AFC", "Vary": "Origin,Accept-Encoding",
"X-Xss-Protection": "1; mode=block" "X-Amz-Request-Id": "16ABE7A785E7AC2C",
"X-Amz-Server-Side-Encryption": "aws:kms",
"X-Amz-Server-Side-Encryption-Aws-Kms-Key-Id": "my-minio-key",
"X-Content-Type-Options": "nosniff",
"X-Xss-Protection": "1; mode=block",
"x-amz-version-id": "ac4639f6-c544-4f3f-af1e-b4c0736f67f9"
}, },
"tags": { "tags": {
"objectErasureMap": { "objectErasureMap": {
"object": { "hosts": {
"poolId": 1, "poolId": 1,
"setId": 10, "setId": 1,
"disks": [ "disks": [
"http://server01/mnt/pool1/disk01", "/mnt/data1",
"http://server02/mnt/pool1/disk02", "/mnt/data2",
"http://server03/mnt/pool1/disk03", "/mnt/data3",
"http://server04/mnt/pool1/disk04" "/mnt/data4"
] ]
} }
}
} }
} }
``` ```

2
internal/logger/audit.go
View file

@ -197,6 +197,8 @@ func AuditLog(ctx context.Context, w http.ResponseWriter, r *http.Request, reqCl
entry.API.Object = reqInfo.ObjectName entry.API.Object = reqInfo.ObjectName
entry.API.Status = http.StatusText(statusCode) entry.API.Status = http.StatusText(statusCode)
entry.API.StatusCode = statusCode entry.API.StatusCode = statusCode
entry.API.InputBytes = r.ContentLength
entry.API.OutputBytes = int64(st.Size())
entry.API.TimeToResponse = strconv.FormatInt(timeToResponse.Nanoseconds(), 10) + "ns" entry.API.TimeToResponse = strconv.FormatInt(timeToResponse.Nanoseconds(), 10) + "ns"
entry.Tags = reqInfo.GetTagsMap() entry.Tags = reqInfo.GetTagsMap()
// ttfb will be recorded only for GET requests, Ignore such cases where ttfb will be empty. // ttfb will be recorded only for GET requests, Ignore such cases where ttfb will be empty.

2
internal/logger/message/audit/entry.go
View file

@ -41,6 +41,8 @@ type Entry struct {
Object string `json:"object,omitempty"` Object string `json:"object,omitempty"`
Status string `json:"status,omitempty"` Status string `json:"status,omitempty"`
StatusCode int `json:"statusCode,omitempty"` StatusCode int `json:"statusCode,omitempty"`
InputBytes int64 `json:"rx"`
OutputBytes int64 `json:"tx"`
TimeToFirstByte string `json:"timeToFirstByte,omitempty"` TimeToFirstByte string `json:"timeToFirstByte,omitempty"`
TimeToResponse string `json:"timeToResponse,omitempty"` TimeToResponse string `json:"timeToResponse,omitempty"`
} `json:"api"` } `json:"api"`