Skip to content

Commit bc02208

Browse files
committed
chore: add provider and workflow_category metrics tags to datadog and new relic
1 parent 684e72e commit bc02208

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

content/integrations/extensions/datadog.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,19 @@ This integration will send a stream of metrics as they happen from your Knock ac
3030

3131
- Environment
3232
- Workflow key
33+
- Workflow category
3334
- Workflow exec mode
3435
- Channel or workflow step type
36+
- Channel provider
3537
- Integration source type
3638
- Error reason
3739

3840
Please refer to your Datadog pricing agreement for information on how custom metrics sent to Datadog are priced for your account.
3941

4042
At this time there is no way to selectively enable specific metrics, however metrics will only be emitted to Datadog for features that you are actively using in Knock.
4143

44+
A workflow can have one or more [categories](/concepts/workflows#workflow-categories). For applicable metrics, each category will have a unique tag on the emitted metrics; a workflow with categories `transcational` and `updates` will have the tags `workflow_category:transcational` and `workflow_category:updates`.
45+
4246
## Installing the integration
4347

4448
1. Visit the **Extensions** page under the **Integrations** section of your Knock dashboard account settings
@@ -78,32 +82,32 @@ Get started with our Datadog dashboard starter kit to start monitoring Knock met
7882
<Attribute
7983
name="knock.message_delivered.total"
8084
type="count"
81-
description="How many messages have been delivered, segmented by `channel` and `workflow` key."
85+
description="How many messages have been delivered, segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
8286
/>
8387
<Attribute
8488
name="knock.message_delivered_retryable_error.total"
8589
type="count"
86-
description="How many deliveries ended in a retryable failure, segmented by `channel` and `workflow` key."
90+
description="How many deliveries ended in a retryable failure, segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
8791
/>
8892
<Attribute
8993
name="knock.message_delivered_error.total"
9094
type="count"
91-
description="How many deliveries ended in failure (not retryable), segmented by `channel` and `workflow` key."
95+
description="How many deliveries ended in failure (not retryable), segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
9296
/>
9397
<Attribute
9498
name="knock.message_bounced_error.total"
9599
type="count"
96-
description="How many deliveries ended in non-retryable errors from downstream providers, segmented by `channel` and `workflow` key."
100+
description="How many deliveries ended in non-retryable errors from downstream providers, segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
97101
/>
98102
<Attribute
99103
name="knock.workflow_recipient_run.total"
100104
type="count"
101-
description="How many workflow recipient runs have been started, segmented by `workflow` key and `exec_mode`."
105+
description="How many workflow recipient runs have been started, segmented by `workflow` key, `exec_mode`, and `workflow_category`."
102106
/>
103107
<Attribute
104108
name="knock.workflow_recipient_run_error.total"
105109
type="count"
106-
description="How many errors were experienced during a workflow recipient run, segmented by `workflow` key, `exec_mode`, `step_type`, and the error `reason`. A workflow recipient run can report more than one error."
110+
description="How many errors were experienced during a workflow recipient run, segmented by `workflow` key, `exec_mode`, `step_type`, `workflow_category`, and the error `reason`. A workflow recipient run can report more than one error."
107111
/>
108112
<Attribute
109113
name="knock.integration_event_received.total"

content/integrations/extensions/new-relic.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,19 @@ This integration will stream metrics from your Knock account to your New Relic a
3030

3131
- Environment
3232
- Workflow key
33+
- Workflow category
3334
- Workflow exec mode
3435
- Channel or workflow step type
36+
- Channel provider
3537
- Integration source type
3638
- Error reason
3739

3840
Please refer to your New Relic pricing agreement for information on how custom metrics sent to New Relic are priced for your account.
3941

4042
At this time there is no way to selectively enable specific metrics, but metrics will only be emitted to New Relic for features that you are actively using in Knock.
4143

44+
A workflow can have one or more [categories](/concepts/workflows#workflow-categories). For applicable metrics, each category will have a unique tag on the emitted metrics; a workflow with categories `transcational` and `updates` will have the tags `workflow_category:transcational` and `workflow_category:updates`.
45+
4246
## Installing the integration
4347

4448
1. Visit the **Extensions** page under the **Integrations** section of your Knock dashboard account settings
@@ -84,27 +88,27 @@ Get started with our New Relic dashboard starter kit to start monitoring Knock m
8488
<Attribute
8589
name="knock.message_delivered.total"
8690
type="count"
87-
description="How many messages have been delivered, segmented by `channel` and `workflow` key."
91+
description="How many messages have been delivered, segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
8892
/>
8993
<Attribute
9094
name="knock.message_delivered_retryable_error.total"
9195
type="count"
92-
description="How many deliveries ended in a retryable failure, segmented by `channel` and `workflow` key."
96+
description="How many deliveries ended in a retryable failure, segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
9397
/>
9498
<Attribute
9599
name="knock.message_delivered_error.total"
96100
type="count"
97-
description="How many deliveries ended in failure (not retryable), segmented by `channel` and `workflow` key."
101+
description="How many deliveries ended in failure (not retryable), segmented by `channel`, `provider`, `workflow` key, and `workflow_category`."
98102
/>
99103
<Attribute
100104
name="knock.workflow_recipient_run.total"
101105
type="count"
102-
description="How many workflow recipient runs have been started, segmented by `workflow` key and `exec_mode`."
106+
description="How many workflow recipient runs have been started, segmented by `workflow` key, `exec_mode`, and `workflow_category`."
103107
/>
104108
<Attribute
105109
name="knock.workflow_recipient_run_error.total"
106110
type="count"
107-
description="How many errors were experienced during a workflow recipient run, segmented by `workflow` key, `exec_mode`, `step_type`, and the error `reason`. A workflow recipient run can report more than one error."
111+
description="How many errors were experienced during a workflow recipient run, segmented by `workflow` key, `exec_mode`, `step_type`, `workflow_category`, and the error `reason`. A workflow recipient run can report more than one error."
108112
/>
109113
<Attribute
110114
name="knock.integration_event_received.total"

0 commit comments

Comments
 (0)