Allow to disable synthesis rules & filter relationships by entitlement (#2122)

* Allow the disabled:true configuration
* Allow ntilements
* Add the provided entitlement descriptions by Pradeep Sundaram

Author: naxhh

README.md

@@ -44,13 +44,13 @@ Whenever there's a contribution via pull request, some validations are automatic
 You can execute the validations locally using our dockerized validator:
 
 ```
-docker-compose run validate-definitions
+docker compose run validate-definitions
 ```
 
 Remember that you may need to rebuild the images to pick up validation changes if you have run this in the past.
 
 ```
-docker-compose build validate-definitions
+docker compose build validate-definitions
 ```
 
 Read more about the [current validations](/validator/README.md).

docs/entities/synthesis.md

@@ -16,6 +16,13 @@ synthesis:
     name: hostname
 ```
 
+It can also be explicitly defined that synthesis is not allowed for a specific type.
+
+```yaml
+synthesis:
+  disabled: true
+```
+
 | **Name** | **Type** | **Required** | **Description**  |
 | -------- | -------- | ------------ | ---------------- |
 | name    | String | Yes | The attribute to use for the entity name. |
@@ -25,6 +32,7 @@ synthesis:
 | conditions | List | No | The list of conditions to apply in the data point to match the rule. Defaults to an empty list. |
 | tags     | List   | No | The list of attributes to copy as entity tags if the rule matches. Defaults to an empty list. |
 
+
 ### Identifier
 
 As previously mentioned the identifier should be a unique value for that entityType in a specific user account.

docs/relationships/relationship_synthesis.md

@@ -81,6 +81,10 @@ relationships:
     version: "1"
     origins:
       - OpenTelemetry
+    entitlements:
+      matching: anyOf
+      values:
+        - advanced_ccu
     conditions:
       - attribute: entity.type
         anyOf: [ "PIXIE_DNS" ]
@@ -173,6 +177,45 @@ One rule can be applied to multiple sources, as shown in the example. These orig
 to filter which rules to evaluate and which ones to ignore. 
 The mapping of origins to sources allows for performance improvements when evaluating rules via the matching system.
 
+### Entitlements
+
+Optionally, you can create a rule that will only match if the account of the telemetry has the required entitlements.
+
+
+```yaml
+entitlements:
+  matching: anyOf
+  values:
+    - advanced_ccu
+```
+
+#### Matching
+
+Defines how the entitlements will be matched.
+Only `anyOf` is allowed.
+
+#### Values
+
+Defines the names of the entitlements to match.
+The account producing the telemetry must contain the entitlements in order for the rule to match.
+
+
+The entitlements to use is a closed list defined below:
+
+| **Entitlement** | **Description** |
+|-----------------|-----------------|
+| advanced_ccu    | Controls whether certain advanced capabilities are accessible in the product |
+| catalog_ccu     | Controls whether customers can use Catalogs in the product |
+| catalogs_discount_usage | Trial version of the above |
+| auto_discovery_entities_ccu | Controls whether customers can enable and use Auto Discovery |
+| auto_discovery_entities_ccu_discount_usage | Trial version of the previous one |
+| advanced_maps_ccu | Controls whether customers can use advanced maps (infrastructure maps and Dynamic Flow Maps) |
+| advanced_maps_discount_usage | Trial version of the previous one |
+| ngep_nrql_access_layer_ccu | No definition provided |
+
+If you need an entitlement not in the list reach us.
+
+
 ### Conditions
 
 `Conditions` are used to determine if a rule should be applied to a given data point. 

entity-types/uninstrumented-awsappsyncapi/definition.yml

@@ -4,3 +4,7 @@ type: AWSAPPSYNCAPI
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awsautoscalinggroup/definition.stg.yml

@@ -4,3 +4,7 @@ type: AWSAUTOSCALINGGROUP
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awsdynamodbtable/definition.yml

@@ -3,4 +3,8 @@ type: AWSDYNAMODBTABLE
 
 configuration:
   entityExpirationTime: DAILY
-  alertable: false
+  alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awsec2/definition.yml

@@ -4,3 +4,7 @@ type: AWSEC2
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awselasticsearchcluster/definition.yml

@@ -4,3 +4,7 @@ type: AWSELASTICSEARCHCLUSTER
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awskinesisdeliverystream/definition.yml

@@ -4,3 +4,7 @@ type: AWSKINESISDELIVERYSTREAM
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true

entity-types/uninstrumented-awskinesisstream/definition.yml

@@ -4,3 +4,7 @@ type: AWSKINESISSTREAM
 configuration:
   entityExpirationTime: DAILY
   alertable: false
+
+synthesis:
+  # Uninstrumented can't use synthesis
+  disabled: true