CloudQuery PagerDuty Source Plugin Configuration Reference

Example #

kind: source
spec:
  # Source spec section
  name: "pagerduty"
  path: "cloudquery/pagerduty"
  registry: "cloudquery"
  version: "v6.0.4"
  tables: ["*"]
  destinations: ["postgresql"]
  backend_options:
    table_name: "cq_state_pagerduty"
    connection: "@@plugins.postgresql.connection"
  # Learn more about the configuration options at https://cql.ink/pagerduty_source
  spec:
    # optional
    auth_token: "<auth_token>"
    # optional
    team_ids: ["<team_id>"]

PagerDuty Spec #

• auth_token (string) (optional)

  An authentication token for the PagerDuty API. You can omit this field if you use one of the other authentication methods available in this plugin.
• auth_method (string) (optional, default: api_token)

  This plugin supports different authentication methods when communicating with the PagerDuty API. Supported values are api_token and oauth_token.
• team_ids ([]string) (default: empty. will sync data from all available teams)

  If specified, limits the sync to only resources related to the specified teams.
• max_requests_per_second (integer) (default: 10) PagerDuty API is heavily rate-limited (900 requests/min = 15 requests/sec, across the entire organization). This option allows you to control the rate at which the plugin will make requests to the API. You can reduce this parameter in case you are still seeing rate limit errors (status code 429), or increase it if your PagerDuty API quota is higher. See https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTUz-rate-limiting#what-are-our-limits for more info. Set to a negative number (e.g. -1) to disable rate limiting, but be aware that this may cause rate limit errors.
• retry_max (integer) (optional) (default: 10) Maximum number of retries to make for each request when a transient error occurs (e.g. rate limit error). Set to a value equal to or less than 0 to disable retries.
• retry_wait_min_seconds (integer) (optional) (default: 1) Minimum number of seconds to wait before retrying a request when a transient error occurs (e.g. rate limit error).
• retry_wait_max_seconds (integer) (optional) (default: 30) Maximum number of seconds to wait before retrying a request when a transient error occurs (e.g. rate limit error).
• concurrency (integer) (optional) (default: 1000) A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string) (optional) (default: dfs) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.
• table_options (Table Options spec) (optional)

  Options to apply to specific tables. See table options for more information.

PagerDuty Table Options Spec #

• pagerduty_incidents

  since and until defaults to empty strings, which results in syncing all incidents by default.

  • since (string in RFC3339 format) (optional) Example: 2024-01-01T12:00:00+00:00. Defaults to an empty string which is interpreted as beginning of time.
  • until (string in RFC3339 format) (optional) Example: 2024-02-01T12:00:00+00:00. Defaults to an empty string which is interpreted as current time.
• pagerduty_schedules

  To retrieve final_schedule or override_subschedule schedule data either since or until must be provided.

  Specifying since or until will incur an addition API call to get each schedule is required. This can slow down the sync process.

  • since (string in RFC3339 format) (optional) Example: 2024-01-01T12:00:00+00:00. Defaults to 2 weeks before until if an until is given.
  • until (string in RFC3339 format) (optional) Example: 2024-02-01T12:00:00+00:00. Defaults to 2 weeks after since if a since is given.
• pagerduty_oncalls

  since and until defaults to empty strings, which are interpreted as current time by the PagerDuty API. As a result this table syncs ongoing on-calls by default. Use since and until to expand the range of on-calls to sync.

  • since (string in RFC3339 format) (optional) Example: 2024-01-01T12:00:00+00:00. Defaults to an empty string which is interpreted as current time.
  • until (string in RFC3339 format) (optional) Example: 2024-02-01T12:00:00+00:00. Defaults to an empty string which is interpreted as current time.