PluginsNotificationsTasksSentrySentryExecution

SentryExecution

yaml

type: "io.kestra.plugin.notifications.sentry.SentryExecution"

Send a Sentry alert with the execution information

The alert message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration and the final status of the execution, and (if failed) the task that led to a failure.

Use this notification task only in a flow that has a Flow trigger. Don't use this notification task in errors tasks. Instead, for errors tasks, use the SentryAlert task.

The only required input is a DSN string value, which you can find when you go to your Sentry project settings and go to the section Client Keys (DSN). For more detailed description of how to find your DSN, visit the following Sentry documentation.

You can customize the alert payload, which is a JSON object. For more information about the payload, check the Sentry Event Payloads documentation.

The level parameter is the severity of the issue. The task documentation lists all available options including DEBUG, INFO, WARNING, ERROR, FATAL. The default value is ERROR.

Examples

This monitoring flow is triggered anytime a flow fails in the prod namespace. It then sends a Sentry alert with the execution information. You can fully customize the trigger conditions.

yaml

id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.sentry.SentryExecution
    transaction: "/execution/id/{{ trigger.executionId }}"
    dsn: "{{ secret('SENTRY_DSN') }}"
    level: ERROR
    executionId: "{{ trigger.executionId }}"

triggers:
  - id: failed_prod_workflows
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

`dsn`

Type: string
Dynamic: ✔️
Required: ✔️
Min length: 1

Sentry DSN

`eventId`

Type: string
Dynamic: ✔️
Required: ✔️
Default: a generated unique identifier
Validation regExp: [0-9a-f]{8}[0-9a-f]{4}[0-9a-f]{4}[0-9a-f]{4}[0-9a-f]{12}

Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. It has to be lowercase.

`platform`

Type: string
Dynamic: ✔️
Required: ✔️
Default: JAVA
Possible Values:
- AS3
- C
- CFML
- COCOA
- CSHARP
- ELIXIR
- HASKELL
- GO
- GROOVY
- JAVA
- JAVASCRIPT
- NATIVE
- NODE
- OBJC
- OTHER
- PERL
- PHP
- PYTHON
- RUBY