---
search:
exclude: true
---
# GroupBy
| Field | Type | Description |
|---|---|---|
| values | repeated [bitdrift.public.unary.workflows.v1.GroupBy.Value](#bitdrift.public.unary.workflows.v1.GroupBy.Value){ title="bitdrift.public.unary.workflows.v1.GroupBy.Value"} | Values to group by. This generates additional dimensions for the generated insights and allows for more granular filtering in dashboards. For example, if you have a metric of error count with a group by value of error type, the collected metrics will include an error type dimension. |
#### Example
```json
{
"values": [
{
"log_body": false
}
]
}
```
# GroupBy.StateValue
| Field | Type | Description |
|---|---|---|
| scope | [bitdrift.public.unary.workflows.v1.StateScope](bitdrift_public_unary_workflows_v1_StateScope.md#bitdrift.public.unary.workflows.v1.StateScope){ title="bitdrift.public.unary.workflows.v1.StateScope"} | The scope of the state value. See `StateScope` for more details about what the different scopes are available. |
| key | string | The key of the state value. This is used to look up the value in the state map based on the provided scope. |
#### Example
```json
{
"key": "example-key",
"scope": "GLOBAL_STATE"
}
```
# GroupBy.Value
A Value to group by. This specifies what additional dimension is included based on extracting additional state from the log that triggers the rule. Each possible values indicates the source the the data used for the dimension. See individual fields for more details.
| Field | Type | Description |
|---|---|---|
| field_key | string | Setting this instructs the engine to look up the value of the field by the given name in the log that triggered the rule and use that as a dimension for the generated metric. The field key becomes the resulting metric dimension name.
(Only one of field_key, or log_body, state_value can be set) |
| log_body | bool | Setting this instructs the engine to use the log body as a dimension for the generated metric.
(Only one of log_body, or field_key, state_value can be set) |
| state_value | [bitdrift.public.unary.workflows.v1.GroupBy.StateValue](#bitdrift.public.unary.workflows.v1.GroupBy.StateValue){ title="bitdrift.public.unary.workflows.v1.GroupBy.StateValue"} | Setting this instructs the engine to read a value out of the state map based on the provided scope and key and use that as a dimension for the generated metric. The key becomes the resulting metric dimension name.
(Only one of state_value, or field_key, log_body can be set) |
#### Example
```json
{
"log_body": false
}
```