Create a Monitor for a Project

Path Parameters

organization_id_or_slug (string)

REQUIRED

The ID or slug of the organization the resource belongs to.

project_id_or_slug (string)

REQUIRED

The ID or slug of the project the resource belongs to. Project slugs are unique within each organization.

Body Parameters

name (string)

REQUIRED

Name of the monitor.

type (string)

REQUIRED

The type of monitor - metric_issue.

workflow_ids (array(integer))

The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs.

data_sources (array(undefined))

The data sources for the metric monitor to use based on what you want to measure.

timeWindow is measured in seconds. Cron Monitors use schedules instead of this field. Legacy metric alert rules expressed this value in minutes, so multiply a legacy value by 60 when migrating it to a monitor. For example, a legacy 5-minute window becomes "timeWindow": 300.

Number of Errors Metric Monitor

• eventTypes: Any of error or default.

JSON

Copied

    [
        {
            "aggregate": "count()",
            "dataset" : "events",
            "environment": "prod",
            "eventTypes": ["default", "error"],
            "query": "is:unresolved",
            "queryType": 0,
            "timeWindow": 3600
        }
    ]

Users Experiencing Errors Metric Monitor

• eventTypes: Any of error or default.

JSON

Copied

    [
        {
            "aggregate": "count_unique(tags[sentry:user])",
            "dataset" : "events",
            "environment": "prod",
            "eventTypes": ["default", "error"],
            "query": "is:unresolved",
            "queryType": 0,
            "timeWindow": 3600
        }
    ]

Throughput Metric Monitor

JSON

Copied

    [
        {
            "aggregate":"count(span.duration)",
            "dataset":"events_analytics_platform",
            "environment":"prod",
            "eventTypes":["trace_item_span"],
            "query":"",
            "queryType":1,
            "timeWindow":3600,
            "extrapolationMode":"unknown"
        }
    ]

Duration Metric Monitor

JSON

Copied

    [
        {
            "aggregate":"p95(span.duration)",
            "dataset":"events_analytics_platform",
            "environment":"prod",
            "eventTypes":["trace_item_span"],
            "query":"",
            "queryType":1,
            "timeWindow":3600,
            "extrapolationMode":"unknown"
        }
    ]

Failure Rate Metric Monitor

JSON

Copied

    [
        {
            "aggregate":"failure_rate()",
            "dataset":"events_analytics_platform",
            "environment":"prod",
            "eventTypes":["trace_item_span"],
            "query":"",
            "queryType":1,
            "timeWindow":3600,
            "extrapolationMode":"unknown"
        }
    ]

Largest Contentful Paint Metric Monitor

• dataset: Use events_analytics_platform. To query transaction spans, add is_transaction:true to query.
• aggregate: Valid values are avg(measurements.lcp), p50(measurements.lcp), p75(measurements.lcp), p95(measurements.lcp), p99(measurements.lcp), p100(measurements.lcp), and percentile(measurements.lcp,x), where x is your custom percentile.

JSON

Copied

    [
        {
            "aggregate":"p95(measurements.lcp)",
            "dataset":"events_analytics_platform",
            "environment":"prod",
            "eventTypes":["trace_item_span"],
            "query":"is_transaction:true",
            "queryType":1,
            "timeWindow":3600,
            "extrapolationMode":"unknown"
        }
    ]

Custom Metric Monitor

• dataset: Use events_analytics_platform. To query transaction spans, add is_transaction:true to query.
• aggregate: Valid values are: avg(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. p50(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. p75(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. p95(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. p99(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. p100(x), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime. percentile(x,y), where x is transaction.duration, measurements.cls, measurements.fcp, measurements.fid, measurements.fp, measurements.lcp, measurements.ttfb, or measurements.ttfb.requesttime, and y is the custom percentile. failure_rate() apdex(x), where x is the value of the Apdex score. count()

JSON

Copied

[
    {
        "aggregate": "p75(measurements.ttfb)",
        "dataset": "events_analytics_platform",
        "environment": "prod",
        "queryType": 1,
        "eventTypes": ["trace_item_span"],
        "query": "is_transaction:true",
        "timeWindow": 3600,
        "extrapolationMode": "unknown"
    }
]

config (object)

The issue detection type configuration.

• detectionType
  • static: Threshold based monitor
  • percent: Change based monitor
  • dynamic: Dynamic monitor
• comparisonDelta: If selecting a change detection type, the comparison delta is the time period, in seconds, at which to compare against historical data. For example, a value of 3600 compares the metric tracked against data 1 hour ago.
  • 300: 5 minutes
  • 900: 15 minutes
  • 3600: 1 hour
  • 86400: 1 day
  • 604800: 1 week
  • 2592000: 1 month

Threshold

JSON

Copied

{
    "detectionType": "static"
}

Change

JSON

Copied

{
    "detectionType": "percent",
    "comparisonDelta": 3600
}

Dynamic

JSON

Copied

{
    "detectionType": "dynamic"
}

condition_group

Issue detection configuration for when to create an issue and at what priority level.

• logicType: any

• type: Any of gt (greater than), lte (less than or equal), or anomaly_detection (dynamic)

• comparison: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. "Create a metric issue when there are more than 5 unresolved error events".

  • If creating a dynamic monitor, see the options below.
    • seasonality: auto
    • sensitivity: Level of responsiveness. Options are one of low, medium, or high
    • thresholdType: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold.
      • 0: Above
      • 1: Below
      • 2: Above and below

• conditionResult: The issue state change when the threshold is crossed.

  • 75: High priority
  • 50: Low priority
  • 0: Resolved

Threshold and Change Monitor

JSON

Copied

    "logicType": "any",
    "conditions": [
        {
            "type": "gt",
            "comparison": 10,
            "conditionResult": 75
        },
        {
            "type": "lte",
            "comparison": 10,
            "conditionResult": 0
        }
    ],
    "actions": []

Threshold Monitor with Medium Priority

JSON

Copied

    "logicType": "any",
    "conditions": [
        {
            type: "gt",
            comparison: 5,
            conditionResult: 75
        },
        {
            type: "gt",
            comparison: 2,
            conditionResult: 50
        },
        {
            type: "lte",
            comparison: 2,
            conditionResult: 0
        }
    ],
    "actions": []

Dynamic Monitor

JSON

Copied

    "logicType": "any",
    "conditions": [
        {
            "type": "anomaly_detection",
            "comparison": {
                "seasonality": "auto",
                "sensitivity": "medium",
                "thresholdType": 2
            },
            "conditionResult": 75
        }
    ],
    "actions": []

owner (string)

The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.

User

JSON

Copied

    "user:123456"

Team

JSON

Copied

    "team:456789"

description (string)

A description of the monitor. Will be used in the resulting issue.

enabled (boolean)

Set to False if you want to disable the monitor.

Scopes

• alerts:write
• project:admin
• project:write