fix: Fixing Analyzer Rules and Updating Values #2738
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
xoscar
commented
Jun 15, 2023
| @@ -13,7 +13,8 @@ type ensuresDnsUsage struct { | |||
| } | |||
|
|
|||
| var ( | |||
| dnsFields = []string{"net.peer.name", "http.url", "db.connection_string", "net.sock.peer.addr", "net.host.name"} | |||
| clientDnsFields = []string{"net.peer.name"} | |||
| dnsFields = []string{"http.url", "db.connection_string"} | |||
There was a problem hiding this comment.
net.peer.name is only required for client spans
xoscar
commented
Jun 15, 2023
| @@ -22,7 +22,7 @@ func NewEnforceHttpsProtocolRule() model.Rule { | |||
| Name: "Enforce HTTPS Protocol", | |||
| Description: "Ensure all request use https", | |||
| Tips: []string{}, | |||
| Weight: 40, | |||
| Weight: 20, | |||
There was a problem hiding this comment.
Updating the weight
xoscar
commented
Jun 15, 2023
| for _, span := range trace.Flat { | ||
| results = append(results, r.validateSpanName(ctx, span)) | ||
| result := r.validateSpanName(ctx, span) |
There was a problem hiding this comment.
We had an issue here that we never reported 100% pass for this rule
xoscar
commented
Jun 15, 2023
| } else { | ||
| expectedName = fmt.Sprintf("%s %s", dbOperation, dbName) | ||
| // TODO: fix this by adding proper validation for all other db systems | ||
| dbSystem := span.Attributes.Get("db.system") |
There was a problem hiding this comment.
For Redis, we have to match the prefix of the statement to validate the name. This should be improved in the future to run checks by db system
xoscar
commented
Jun 15, 2023
| @@ -12,7 +12,7 @@ var ( | |||
| httpAttrServer = []string{"http.target", "http.scheme", "net.host.name"} | |||
|
|
|||
| databaseAttr = []string{"db.system"} | |||
| rpcAttr = []string{"rpc.system", "neet.peer.name"} | |||
xoscar
commented
Jun 15, 2023
| @@ -1,3 +1,3 @@ | |||
| { | |||
| "proto": "syntax = \"proto3\";\n\noption java_multiple_files = true;\noption java_outer_classname = \"PokeshopProto\";\noption objc_class_prefix = \"PKS\";\n\npackage pokeshop;\n\nservice Pokeshop {\n rpc getPokemonList (GetPokemonRequest) returns (GetPokemonListResponse) {}\n rpc createPokemon (Pokemon) returns (Pokemon) {}\n rpc importPokemon (ImportPokemonRequest) returns (ImportPokemonRequest) {}\n}\n\nmessage ImportPokemonRequest {\n int32 id = 1;\n}\n\nmessage GetPokemonRequest {\n optional int32 skip = 1;\n optional int32 take = 2;\n}\n\nmessage GetPokemonListResponse {\n repeated Pokemon items = 1;\n int32 totalCount = 2;\n}\n\nmessage Pokemon {\n optional int32 id = 1;\n string name = 2;\n string type = 3;\n bool isFeatured = 4;\n optional string imageUrl = 5;\n}\n" | |||
| "proto": "syntax = \"proto3\";\n\noption java_multiple_files = true;\noption java_outer_classname = \"PokeshopProto\";\noption objc_class_prefix = \"PKS\";\n\npackage pokeshop;\n\nservice Pokeshop {\n rpc getPokemonList (GetPokemonRequest) returns (GetPokemonListResponse) {}\n rpc createPokemon (Pokemon) returns (Pokemon) {}\n rpc importPokemon (ImportPokemonRequest) returns (ImportPokemonRequest) {}\n}\n\nmessage ImportPokemonRequest {\n int32 id = 1;\n optional bool isFixed = 2;\n}\n\nmessage GetPokemonRequest {\n optional int32 skip = 1;\n optional int32 take = 2;\n optional bool isFixed = 3;\n}\n\nmessage GetPokemonListResponse {\n repeated Pokemon items = 1;\n int32 totalCount = 2;\n}\n\nmessage Pokemon {\n optional int32 id = 1;\n string name = 2;\n string type = 3;\n bool isFeatured = 4;\n optional string imageUrl = 5;\n}" | |||
There was a problem hiding this comment.
Adding support for the isFixed flag
There was a problem hiding this comment.
In the near future, we should change this to read it directly from the repo to have to do this copy paste
jorgeepc
approved these changes
Jun 15, 2023
xoscar
deleted the
2714-analyzer-results-fix-pokeshop-api-to-yield-successful-scores
branch
mathnogueira
pushed a commit
that referenced
this pull request
Jun 19, 2023
mathnogueira
pushed a commit
that referenced
this pull request
Jun 19, 2023
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.
This PR updates the analyzer rules to better match the semantic conventions.
Changes
isFixedflagFixes
Checklist