-
Notifications
You must be signed in to change notification settings - Fork 855
Querier active api tracker #7216
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
c399131
Add active api tracker
eeldaly 0bd714e
Update changelog
eeldaly 3b566eb
Made request tracker more generic; added query apis to tracker
eeldaly 83e2259
add prometheus copyright header for copied part
eeldaly d06e5eb
Merge branch 'master' into master
friedrichg 575b518
Add request id if not in context
eeldaly 2b585b7
fix test assert expected msg
eeldaly 5da5eeb
Add more logging fields
eeldaly 814d788
Rename log entry keys, remove request id generation
eeldaly eeeaf01
Wrap request id wrapper before oomkill logger
eeldaly 72a8720
Add test for query truncation. Fix edge case with query truncating es…
eeldaly bfbfe8d
lint
eeldaly f910102
remove debug line
eeldaly 4b9776e
Add extractor tests
eeldaly 8c32cbd
Removed default extractor
eeldaly a5cde19
rewrote trim function
eeldaly fe62fb3
go mod tidy/vendor
eeldaly 6e26b00
Merge branch 'master' into master
eeldaly dcea029
go modernize
eeldaly File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| package api_tracker | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "log/slog" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/edsrzf/mmap-go" | ||
| ) | ||
|
|
||
| type APITracker struct { | ||
|
yeya24 marked this conversation as resolved.
Outdated
|
||
| mmappedFile []byte | ||
| getNextIndex chan int | ||
| logger *slog.Logger | ||
| closer io.Closer | ||
| maxConcurrent int | ||
| } | ||
|
|
||
| var _ io.Closer = &APITracker{} | ||
|
|
||
| const ( | ||
| apiEntrySize int = 1000 | ||
| ) | ||
|
|
||
| func parseAPIBrokenJSON(brokenJSON []byte) (string, bool) { | ||
| apis := strings.ReplaceAll(string(brokenJSON), "\x00", "") | ||
| if len(apis) > 0 { | ||
| apis = apis[:len(apis)-1] + "]" | ||
| } | ||
|
|
||
| if len(apis) <= 1 { | ||
| return "[]", false | ||
| } | ||
|
|
||
| return apis, true | ||
| } | ||
|
|
||
| func logUnfinishedAPIs(filename string, filesize int, logger *slog.Logger) { | ||
| if _, err := os.Stat(filename); err == nil { | ||
| fd, err := os.Open(filename) | ||
| if err != nil { | ||
| logger.Error("Failed to open API log file", "err", err) | ||
| return | ||
| } | ||
| defer fd.Close() | ||
|
|
||
| brokenJSON := make([]byte, filesize) | ||
| _, err = fd.Read(brokenJSON) | ||
| if err != nil { | ||
| logger.Error("Failed to read API log file", "err", err) | ||
| return | ||
| } | ||
|
|
||
| apis, apisExist := parseAPIBrokenJSON(brokenJSON) | ||
| if !apisExist { | ||
| return | ||
| } | ||
| logger.Info("These API calls didn't finish in prometheus' last run:", "apis", apis) | ||
| } | ||
| } | ||
|
|
||
| type mmappedAPIFile struct { | ||
| f io.Closer | ||
| m mmap.MMap | ||
| } | ||
|
|
||
| func (f *mmappedAPIFile) Close() error { | ||
| err := f.m.Unmap() | ||
| if err != nil { | ||
| err = fmt.Errorf("mmappedAPIFile: unmapping: %w", err) | ||
| } | ||
| if fErr := f.f.Close(); fErr != nil { | ||
| return errors.Join(fmt.Errorf("close mmappedAPIFile.f: %w", fErr), err) | ||
| } | ||
|
|
||
| return err | ||
| } | ||
|
|
||
| func getAPIMMappedFile(filename string, filesize int, logger *slog.Logger) ([]byte, io.Closer, error) { | ||
| file, err := os.OpenFile(filename, os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0o666) | ||
| if err != nil { | ||
| absPath, pathErr := filepath.Abs(filename) | ||
| if pathErr != nil { | ||
| absPath = filename | ||
| } | ||
| logger.Error("Error opening API log file", "file", absPath, "err", err) | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| err = file.Truncate(int64(filesize)) | ||
| if err != nil { | ||
| file.Close() | ||
| logger.Error("Error setting filesize.", "filesize", filesize, "err", err) | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| fileAsBytes, err := mmap.Map(file, mmap.RDWR, 0) | ||
| if err != nil { | ||
| file.Close() | ||
| logger.Error("Failed to mmap", "file", filename, "Attempted size", filesize, "err", err) | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| return fileAsBytes, &mmappedAPIFile{f: file, m: fileAsBytes}, err | ||
| } | ||
|
|
||
| func NewAPITracker(localStoragePath string, maxConcurrent int, logger *slog.Logger) *APITracker { | ||
| if localStoragePath == "" { | ||
| return nil | ||
| } | ||
|
|
||
| err := os.MkdirAll(localStoragePath, 0o777) | ||
| if err != nil { | ||
| logger.Error("Failed to create directory for logging active APIs") | ||
| return nil | ||
| } | ||
|
|
||
| filename, filesize := filepath.Join(localStoragePath, "apis.active"), 1+maxConcurrent*apiEntrySize | ||
| logUnfinishedAPIs(filename, filesize, logger) | ||
|
|
||
| fileAsBytes, closer, err := getAPIMMappedFile(filename, filesize, logger) | ||
| if err != nil { | ||
| logger.Error("Unable to create mmap-ed active API log", "err", err) | ||
| return nil | ||
| } | ||
|
|
||
| copy(fileAsBytes, "[") | ||
| apiTracker := &APITracker{ | ||
| mmappedFile: fileAsBytes, | ||
| closer: closer, | ||
| getNextIndex: make(chan int, maxConcurrent), | ||
| logger: logger, | ||
| maxConcurrent: maxConcurrent, | ||
| } | ||
|
|
||
| apiTracker.generateIndices(maxConcurrent) | ||
|
|
||
| return apiTracker | ||
| } | ||
|
|
||
| func newAPIJSONEntry(entryMap map[string]interface{}, logger *slog.Logger) []byte { | ||
| jsonEntry, err := json.Marshal(entryMap) | ||
| if err != nil { | ||
| logger.Error("Cannot create json of API entry", "entry", entryMap) | ||
| return []byte{} | ||
| } | ||
|
|
||
| if len(jsonEntry) > apiEntrySize { | ||
| newEntryMap := make(map[string]interface{}) | ||
| newEntryMap["timestamp_sec"] = time.Now().Unix() | ||
| jsonEntry, err = json.Marshal(newEntryMap) | ||
| if err != nil { | ||
| logger.Error("Cannot create json of API entry", "entry", newEntryMap) | ||
| return []byte{} | ||
| } | ||
| } | ||
|
|
||
| return jsonEntry | ||
| } | ||
|
|
||
| func (tracker *APITracker) generateIndices(maxConcurrent int) { | ||
| for i := 0; i < maxConcurrent; i++ { | ||
| tracker.getNextIndex <- 1 + (i * apiEntrySize) | ||
| } | ||
| } | ||
|
|
||
| func (tracker *APITracker) Delete(insertIndex int) { | ||
| copy(tracker.mmappedFile[insertIndex:], strings.Repeat("\x00", apiEntrySize)) | ||
| tracker.getNextIndex <- insertIndex | ||
| } | ||
|
|
||
| func (tracker *APITracker) Insert(ctx context.Context, entryMap map[string]interface{}) (int, error) { | ||
| select { | ||
| case i := <-tracker.getNextIndex: | ||
| fileBytes := tracker.mmappedFile | ||
| entry := newAPIJSONEntry(entryMap, tracker.logger) | ||
| start, end := i, i+apiEntrySize | ||
|
|
||
| copy(fileBytes[start:], entry) | ||
| copy(fileBytes[end-1:], ",") | ||
| return i, nil | ||
| case <-ctx.Done(): | ||
| return 0, ctx.Err() | ||
| } | ||
| } | ||
|
|
||
| func (tracker *APITracker) Close() error { | ||
| if tracker == nil || tracker.closer == nil { | ||
| return nil | ||
| } | ||
| if err := tracker.closer.Close(); err != nil { | ||
| return fmt.Errorf("close APITracker.closer: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| package api_tracker | ||
|
|
||
| import ( | ||
| "context" | ||
| "log/slog" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestAPITracker(t *testing.T) { | ||
| tmpDir, err := os.MkdirTemp("", "api-tracker-test") | ||
| require.NoError(t, err) | ||
| defer os.RemoveAll(tmpDir) | ||
|
|
||
| logger := slog.New(slog.NewTextHandler(os.Stdout, nil)) | ||
| tracker := NewAPITracker(tmpDir, 10, logger) | ||
| require.NotNil(t, tracker) | ||
| defer tracker.Close() | ||
|
|
||
| ctx := context.Background() | ||
| insertIndex, err := tracker.Insert(ctx, make(map[string]interface{})) | ||
| require.NoError(t, err) | ||
| assert.Greater(t, insertIndex, 0) | ||
|
|
||
| tracker.Delete(insertIndex) | ||
| } | ||
|
|
||
| func TestAPITrackerLogUnfinished(t *testing.T) { | ||
| tmpDir, err := os.MkdirTemp("", "api-tracker-test") | ||
| require.NoError(t, err) | ||
| defer os.RemoveAll(tmpDir) | ||
|
|
||
| filename := filepath.Join(tmpDir, "apis.active") | ||
| content := `[{"path":"/api/v1/series","method":"GET","timestamp_sec":1234567890},` | ||
| err = os.WriteFile(filename, []byte(content), 0644) | ||
| require.NoError(t, err) | ||
|
|
||
| var logOutput strings.Builder | ||
| logger := slog.New(slog.NewTextHandler(&logOutput, nil)) | ||
|
|
||
| tracker := NewAPITracker(tmpDir, 10, logger) | ||
| require.NotNil(t, tracker) | ||
| defer tracker.Close() | ||
| output := logOutput.String() | ||
| assert.Contains(t, output, "These API calls didn't finish in prometheus' last run") | ||
| assert.Contains(t, output, "/api/v1/series") | ||
| } | ||
|
|
||
| func TestAPITrackerNilDirectory(t *testing.T) { | ||
| logger := slog.New(slog.NewTextHandler(os.Stdout, nil)) | ||
| tracker := NewAPITracker("", 10, logger) | ||
| assert.Nil(t, tracker) | ||
| } | ||
|
|
||
| func TestAPIWrapper(t *testing.T) { | ||
| tmpDir, err := os.MkdirTemp("", "api-wrapper-test") | ||
| require.NoError(t, err) | ||
| defer os.RemoveAll(tmpDir) | ||
|
|
||
| logger := slog.New(slog.NewTextHandler(os.Stdout, nil)) | ||
| tracker := NewAPITracker(tmpDir, 10, logger) | ||
| require.NotNil(t, tracker) | ||
| defer tracker.Close() | ||
|
|
||
| handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
|
|
||
| wrapper := NewAPIWrapper(handler, tracker) | ||
|
|
||
| req := httptest.NewRequest("GET", "/api/v1/series?match[]=up", nil) | ||
| rr := httptest.NewRecorder() | ||
| wrapper.ServeHTTP(rr, req) | ||
| assert.Equal(t, http.StatusOK, rr.Code) | ||
| } | ||
|
|
||
| func TestAPIWrapperNilTracker(t *testing.T) { | ||
| handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
|
|
||
| wrapper := NewAPIWrapper(handler, nil) | ||
|
|
||
| req := httptest.NewRequest("GET", "/api/v1/series?match[]=up", nil) | ||
| rr := httptest.NewRecorder() | ||
| wrapper.ServeHTTP(rr, req) | ||
| assert.Equal(t, http.StatusOK, rr.Code) | ||
| } | ||
|
|
||
| func TestAPITrackerAboveMaxConcurrency(t *testing.T) { | ||
| tmpDir, err := os.MkdirTemp("", "api-tracker-test") | ||
| require.NoError(t, err) | ||
| defer os.RemoveAll(tmpDir) | ||
|
|
||
| logger := slog.New(slog.NewTextHandler(os.Stdout, nil)) | ||
|
|
||
| tracker := NewAPITracker(tmpDir, 2, logger) | ||
| require.NotNil(t, tracker) | ||
| defer tracker.Close() | ||
| ctx := context.Background() | ||
|
|
||
| index1, err := tracker.Insert(ctx, make(map[string]interface{})) | ||
| require.NoError(t, err) | ||
|
|
||
| index2, err := tracker.Insert(ctx, make(map[string]interface{})) | ||
| require.NoError(t, err) | ||
|
|
||
| ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond) | ||
| defer cancel() | ||
|
|
||
| _, err = tracker.Insert(ctx, make(map[string]interface{})) | ||
| assert.Error(t, err) // Should timeout | ||
|
|
||
| tracker.Delete(index1) | ||
| ctx = context.Background() | ||
| index3, err := tracker.Insert(ctx, make(map[string]interface{})) | ||
| require.NoError(t, err) | ||
|
|
||
| tracker.Delete(index2) | ||
| tracker.Delete(index3) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.