-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Shane Schisler
committed
Nov 19, 2024
1 parent
8c2457f
commit 4e76a28
Showing
7 changed files
with
896 additions
and
20 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| package after_resolution | ||
|
|
||
| import rego.v1 | ||
|
|
||
| # Data structures to make checking things faster. | ||
| attribute_names := { obj | | ||
| group := input.groups[_]; | ||
| attr := group.attributes[_]; | ||
| obj := { "name": attr.name, "const_name": to_const_name(attr.name), "namespace_prefix": to_namespace_prefix(attr.name) } | ||
| } | ||
|
|
||
| # check that attribute constant names do not collide | ||
| deny contains attr_registry_collision(description, name) if { | ||
| some i | ||
| name := attribute_names[i].name | ||
| const_name := attribute_names[i].const_name | ||
| not excluded_const_collisions[name] | ||
| collisions := [other.name | | ||
| other := attribute_names[_] | ||
| other.name != name | ||
| other.const_name == const_name | ||
| not excluded_const_collisions[other.name] | ||
| ] | ||
| count(collisions) > 0 | ||
| # TODO (https://github.com/open-telemetry/weaver/issues/279): provide other violation properties once weaver supports it. | ||
| description := sprintf("Attribute '%s' has the same constant name '%s' as '%s'.", [name, const_name, collisions]) | ||
| } | ||
|
|
||
| # check that attribute names do not collide with namespaces | ||
| deny contains attr_registry_collision(description, name) if { | ||
| some i | ||
| name := attribute_names[i].name | ||
| prefix := attribute_names[i].namespace_prefix | ||
| not excluded_namespace_collisions[name] | ||
| collisions := [other.name | | ||
| other := attribute_names[_] | ||
| other.name != name | ||
| startswith(other.name, prefix) | ||
| ] | ||
| count(collisions) > 0 | ||
| # TODO (https://github.com/open-telemetry/weaver/issues/279): provide other violation properties once weaver supports it. | ||
| description := sprintf("Attribute '%s' name is used as a namespace in the following attributes '%s'.", [name, collisions]) | ||
| } | ||
|
|
||
| # check that attribute is not defined or referenced more than once within the same group | ||
| deny contains attr_registry_collision(description, name) if { | ||
| group := input.groups[_] | ||
| attr := group.attributes[_] | ||
| name := attr.name | ||
|
|
||
| collisions := [n | n := group.attributes[_].name; n == name ] | ||
| count(collisions) > 1 | ||
|
|
||
| description := sprintf("Attribute '%s' is already defined in the group '%s'. Attributes must be unique.", [name, group.id]) | ||
| } | ||
|
|
||
| attr_registry_collision(description, attr_name) = violation if { | ||
| violation := { | ||
| "id": description, | ||
| "type": "semconv_attribute", | ||
| "category": "naming_collision", | ||
| "attr": attr_name, | ||
| "group": "", | ||
| } | ||
| } | ||
|
|
||
| to_namespace_prefix(name) = namespace if { | ||
| namespace := concat("", [name, "."]) | ||
| } | ||
|
|
||
| to_const_name(name) = const_name if { | ||
| const_name := replace(name, ".", "_") | ||
| } | ||
|
|
||
| # These lists contain exceptions for existing collisions that were introduced unintentionally. | ||
| # We'll have a way to specify how collision resolution happens in the schema - | ||
| # see phase 2 in https://github.com/open-telemetry/semantic-conventions/issues/1118#issuecomment-2173803006 | ||
| # For now we'll exclude existing collisions from the checks. | ||
| # ADDING NEW EXCEPTIONS IS NOT ALLOWED. | ||
|
|
||
| # DO NOT ADD ATTRIBUTES TO THIS LIST | ||
| excluded_const_collisions := {"messaging.client_id"} | ||
| # DO NOT ADD ATTRIBUTES TO THIS LIST | ||
| excluded_namespace_collisions := {"messaging.operation", "db.operation", "deployment.environment"} |
Oops, something went wrong.