Skip to content
View as Markdown

ActionRule

Source definition: src/bitdrift/public/unary/workflows/v1/workflow.proto#L426-L455

An action rule.

Field Type Description
rule_id string
between 1 and 100 chars
ID of this action rule. Must be unique within the workflow. This may be referenced by other APIs and will be documented as such. In special cases it may also be referenced by other actions. For example, a chart and flush action can refer to the rule_id of a measure time action.
metric_chart_rule bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration(Only one of metric_chart_rule, or flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) A metric chart action.
flush_rule bitdrift.public.unary.workflows.v1.Rule.RuleFlushConfiguration(Only one of flush_rule, or metric_chart_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) A flush action.
funnel_rule bitdrift.public.unary.workflows.v1.Rule.RuleFunnelConfiguration(Only one of funnel_rule, or metric_chart_rule, flush_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) A funnel action.
sankey_diagram_rule bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration(Only one of sankey_diagram_rule, or metric_chart_rule, flush_rule, funnel_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) A sankey diagram action.
measure_time_rule bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime(Only one of measure_time_rule, or metric_chart_rule, flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, start_tracing_rule can be set) A measure time action.
start_tracing_rule bitdrift.public.unary.workflows.v1.RuleStartTracing(Only one of start_tracing_rule, or metric_chart_rule, flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule can be set) If specified the current session will begin trace sampling.

Example

JSON
{
  "metric_chart_rule": {
    "time_series": [
      {
        "aggregated_id": "count/fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
        "rate": {
          "denominator": {
            "match_id": "_i1yUnHjKfmWpCaD5Tazo",
            "name": "field_name"
          },
          "denominator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
          "group_by": {
            "values": [
              {
                "log_body": false
              }
            ]
          },
          "numerator": {
            "match_id": "_i1yUnHjKfmWpCaD5Tazo",
            "name": "field_name"
          },
          "numerator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc"
        },
        "track_unique": {
          "device_id": true
        }
      }
    ]
  },
  "rule_id": "_i1yUnHjKfmWpCaD5Tazo"
}