TT-9873 Fix prometheus tracking path #716
Merged
Conversation
This file contains 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
sredxny
requested changes
Aug 22, 2023
pumps/prometheus.go
Outdated
| @@ -42,6 +42,9 @@ type PrometheusConf struct { | |||
| AggregateObservations bool `json:"aggregate_observations" mapstructure:"aggregate_observations"` | |||
| // Metrics to exclude from exposition. Currently, excludes only the base metrics. | |||
| DisabledMetrics []string `json:"disabled_metrics" mapstructure:"disabled_metrics"` | |||
| // Specifies if it should expose aggregated metrics for all the endpoints. By default, `false` | |||
| // which means that all APIs endpoints will be counted as 'uknown' unless the API use track endpoint plugin. | |||
mativm02
reviewed
Aug 23, 2023
pumps/prometheus.go
Outdated
| @@ -245,6 +248,11 @@ func (p *PrometheusPump) WriteData(ctx context.Context, data []interface{}) erro | |||
| default: | |||
| } | |||
| record := item.(analytics.AnalyticsRecord) | |||
|
|
|||
| if !(p.conf.TrackAllPaths || record.TrackPath) { | |||
| record.Path = "unknown" | |||
There was a problem hiding this comment.
Just a small comment: Setting a const here will make it easier to read and avoid typos if we need to work on this again in the future. I'd set a UnknowPath const and use it here and in the unit test, wdyt?
mativm02
approved these changes
Aug 23, 2023
sredxny
approved these changes
Aug 23, 2023
|
/release to release-1.8 |
|
Working on it! Note that it can take a few minutes. |
tykbot bot
pushed a commit
that referenced
this pull request
Aug 23, 2023
* Fix prometheus tracking path * suggested fixes (cherry picked from commit 69f5f4a)
|
@tbuchaillot Succesfully merged PR |
buger
added a commit
that referenced
this pull request
Aug 23, 2023
TT-9873 Fix prometheus tracking path (#716) * Fix prometheus tracking path * suggested fixes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR change fixes the tracking path behavior of Prometheus pump. It was tracking all the paths by default, ignoring if the API/analytic record has TrackPath enabled.
Now, when you don't have TrackPath enabled ( aka you are using Track Endpoint plugin), it will log the path as
unknown.This also adds a new configuration for prometheus pump
track_all_paths- that enables the path tracking for ALL the APIs (similar to Mongo/SQL aggregate pumps) - but this can cause Tyk Pump malfunctioning and OOM.Related Issue
https://tyktech.atlassian.net/browse/TT-9873
Motivation and Context
https://tyktech.atlassian.net/browse/TT-9873
How This Has Been Tested
Added tests
Screenshots (if appropriate)
Types of changes
Checklist
fork, don't request your
master!masterbranch (left side). Also, you should startyour branch off our latest
master.go mod tidy && go mod vendorgo fmt -sgo vet