chore | Add graphQL description to span exclusion rules APIs

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/mutation/DeleteSpanProcessingRuleResponse.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.mutation;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -12,5 +13,6 @@ public interface DeleteSpanProcessingRuleResponse {
   @GraphQLField
   @GraphQLNonNull
   @GraphQLName(DELETE_SPAN_PROCESSING_RULE_RESPONSE_SUCCESS)
+  @GraphQLDescription("Success field tells us whether the delete call was a success or not")
   boolean success();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/mutation/ExcludeSpanRuleUpdate.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.mutation;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -17,16 +18,19 @@ public interface ExcludeSpanRuleUpdate extends Identifiable {
 
   @GraphQLField
   @GraphQLName(NAME_KEY)
+  @GraphQLDescription("Update the rule name for the provided ruleId")
   @GraphQLNonNull
   String name();
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_FILTER_KEY)
+  @GraphQLDescription("Replace the existing spanFilters for the input ruleId")
   @GraphQLNonNull
   SpanProcessingRuleFilter spanFilter();
 
   @GraphQLField
   @GraphQLName(DISABLED_KEY)
+  @GraphQLDescription("Enable or disable the rule")
   @GraphQLNonNull
   boolean disabled();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/mutation/SpanProcessingMutationSchema.java

@@ -1,6 +1,7 @@
 package org.hypertrace.graphql.spanprocessing.schema.mutation;
 
 import graphql.annotations.annotationTypes.GraphQLDataFetcher;
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -16,6 +17,7 @@ public interface SpanProcessingMutationSchema {
 
   @GraphQLField
   @GraphQLName(CREATE_EXCLUDE_SPAN_RULE_MUTATION_NAME)
+  @GraphQLDescription("Creates a new ExcludeSpanRule. See ExcludeSpanRule for more information.")
   @GraphQLNonNull
   @GraphQLDataFetcher(ExcludeSpanCreateRuleMutator.class)
   ExcludeSpanRule createExcludeSpanRule(
@@ -24,6 +26,8 @@ ExcludeSpanRule createExcludeSpanRule(
 
   @GraphQLField
   @GraphQLName(UPDATE_EXCLUDE_SPAN_RULE_MUTATION_NAME)
+  @GraphQLDescription(
+      "Update exclude span rule name, filters and enable/disable it for the provided ruleId")
   @GraphQLNonNull
   @GraphQLDataFetcher(ExcludeSpanUpdateRuleMutator.class)
   ExcludeSpanRule updateExcludeSpanRule(
@@ -32,6 +36,7 @@ ExcludeSpanRule updateExcludeSpanRule(
 
   @GraphQLField
   @GraphQLName(DELETE_EXCLUDE_SPAN_RULE_MUTATION_NAME)
+  @GraphQLDescription("Delete exclude span rule based on ruleId")
   @GraphQLNonNull
   @GraphQLDataFetcher(ExcludeSpanDeleteRuleMutator.class)
   DeleteSpanProcessingRuleResponse deleteExcludeSpanRule(

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/query/ExcludeSpanRuleResultSet.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.query;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -15,5 +16,6 @@ public interface ExcludeSpanRuleResultSet extends ResultSet<ExcludeSpanRule> {
   @GraphQLField
   @GraphQLNonNull
   @GraphQLName(RESULT_SET_RESULTS_NAME)
+  @GraphQLDescription("Exclude span rule list in")
   List<ExcludeSpanRule> results();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/query/SpanProcessingQuerySchema.java

@@ -1,6 +1,7 @@
 package org.hypertrace.graphql.spanprocessing.schema.query;
 
 import graphql.annotations.annotationTypes.GraphQLDataFetcher;
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -12,6 +13,7 @@ public interface SpanProcessingQuerySchema {
   @GraphQLField
   @GraphQLNonNull
   @GraphQLName(EXCLUDE_SPAN_RULES_QUERY_NAME)
+  @GraphQLDescription("Get all exclude span rules")
   @GraphQLDataFetcher(ExcludeSpanRulesFetcher.class)
   ExcludeSpanRuleResultSet excludeSpanRules();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/rule/ExcludeSpanRule.java

@@ -1,12 +1,15 @@
 package org.hypertrace.graphql.spanprocessing.schema.rule;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
 import java.time.Instant;
 import org.hypertrace.core.graphql.common.schema.id.Identifiable;
 
 @GraphQLName(ExcludeSpanRule.TYPE_NAME)
+@GraphQLDescription(
+    "An ExcludeSpanRule describes a set of conditions based on span attributes. When matched, a span is discarded and not eligible for further processing.")
 public interface ExcludeSpanRule extends Identifiable, ExcludeSpanRuleInfo {
   String TYPE_NAME = "ExcludeSpanRule";
 
@@ -15,11 +18,13 @@ public interface ExcludeSpanRule extends Identifiable, ExcludeSpanRuleInfo {
 
   @GraphQLField
   @GraphQLName(CREATION_TIME_KEY)
+  @GraphQLDescription("Exclude span rule creation time")
   @GraphQLNonNull
   Instant creationTime();
 
   @GraphQLField
   @GraphQLName(LAST_UPDATED_TIME_KEY)
+  @GraphQLDescription("Exclude span rule last update time")
   @GraphQLNonNull
   Instant lastUpdatedTime();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/rule/ExcludeSpanRuleInfo.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.rule;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -16,21 +17,27 @@ public interface ExcludeSpanRuleInfo {
 
   @GraphQLField
   @GraphQLName(NAME_KEY)
+  @GraphQLDescription("Exclude span rule name")
   @GraphQLNonNull
   String name();
 
   @GraphQLField
   @GraphQLName(SPAN_FILTER_KEY)
+  @GraphQLDescription("Span processing rule filter contains filters based on span attributes")
   @GraphQLNonNull
   SpanProcessingRuleFilter spanFilter();
 
   @GraphQLField
   @GraphQLName(DISABLED_KEY)
+  @GraphQLDescription(
+      "Disabled field denotes whether the rule is disabled or not. By default it is enabled on write")
   @GraphQLNonNull
   boolean disabled();
 
   @GraphQLField
   @GraphQLName(RULE_TYPE_KEY)
+  @GraphQLDescription(
+      "Exclude span rule type tells us whether it is user configured rule or system rule")
   // TODO: make this field non-nullable
   ExcludeSpanRuleRuleType ruleType();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/rule/filter/SpanProcessingLogicalFilter.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.rule.filter;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -15,11 +16,15 @@ public interface SpanProcessingLogicalFilter {
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_LOGICAL_OPERATOR_KEY)
+  @GraphQLDescription(
+      "The logical operator is used to combine the list of filters provided in the spanFilters field")
   @GraphQLNonNull
   LogicalOperator logicalOperator();
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_FILTERS_KEY)
+  @GraphQLDescription(
+      "List of span filters to be evaluated combining together with the logical operator provided")
   @GraphQLNonNull
   List<SpanProcessingRuleFilter> spanFilters();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/rule/filter/SpanProcessingRelationalFilter.java

@@ -2,6 +2,7 @@
 
 import static org.hypertrace.core.graphql.common.schema.results.arguments.filter.FilterArgument.FILTER_ARGUMENT_VALUE;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.annotationTypes.GraphQLNonNull;
@@ -16,19 +17,27 @@ public interface SpanProcessingRelationalFilter {
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_FILTER_KEY_KEY)
+  @GraphQLDescription(
+      "Span processing filter key is the span attribute provided as string like http.request.header.authorization")
   String key();
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_FILTER_FIELD_KEY)
+  @GraphQLDescription(
+      "Span processing filter field supports a list of pre-defined fields like environment name, service name, url and url path (url without query params)")
   SpanProcessingFilterField field();
 
   @GraphQLField
   @GraphQLName(RELATION_OPERATOR_KEY)
+  @GraphQLDescription(
+      "Span processing relational operator which combines the lhs (key or field) and rhs (value)")
   @GraphQLNonNull
   SpanProcessingRelationalOperator relationalOperator();
 
   @GraphQLField
   @GraphQLName(FILTER_ARGUMENT_VALUE)
+  @GraphQLDescription(
+      "Span processing filter value to be evaluated using the relational operator for the provided lhs (key or field)")
   @GraphQLNonNull
   Object value();
 }

hypertrace-graphql-span-processing-schema/src/main/java/org/hypertrace/graphql/spanprocessing/schema/rule/filter/SpanProcessingRuleFilter.java

@@ -1,5 +1,6 @@
 package org.hypertrace.graphql.spanprocessing.schema.rule.filter;
 
+import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 
@@ -12,9 +13,13 @@ public interface SpanProcessingRuleFilter {
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_LOGICAL_FILTER_KEY)
+  @GraphQLDescription(
+      "Span processing logical filter containing list of spanFilters and the logical operator")
   SpanProcessingLogicalFilter logicalSpanFilter();
 
   @GraphQLField
   @GraphQLName(SPAN_PROCESSING_RELATIONAL_FILTER_KEY)
+  @GraphQLDescription(
+      "Span processing relational filter which takes in lhs and lhs, combining them with relational operator")
   SpanProcessingRelationalFilter relationalSpanFilter();
 }